Chapter 251. OpenStack Cinder Component
Available as of Camel version 2.19
The openstack-cinder component allows messages to be sent to an OpenStack block storage services.
251.1. Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-openstack</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version} must be replaced by the actual version of Camel.
251.2. URI Format
openstack-cinder://hosturl[?options]
You can append query options to the URI in the following format ?options=value&option2=value&…
251.3. URI Options
The OpenStack Cinder component has no options.
The OpenStack Cinder endpoint is configured using URI syntax:
openstack-cinder:host
with the following path and query parameters:
251.3.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| host | Required OpenStack host url | String |
251.3.2. Query Parameters (9 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| apiVersion (producer) | OpenStack API version | V3 | String |
| config (producer) | OpenStack configuration | Config | |
| domain (producer) | Authentication domain | default | String |
| operation (producer) | The operation to do | String | |
| password (producer) | Required OpenStack password | String | |
| project (producer) | Required The project ID | String | |
| subsystem (producer) | Required OpenStack Cinder subsystem | String | |
| username (producer) | Required OpenStack username | String | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
251.4. Spring Boot Auto-Configuration
The component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.openstack-cinder.enabled | Enable openstack-cinder component | true | Boolean |
| camel.component.openstack-cinder.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
251.5. Usage
You can use following settings for each subsystem:
251.6. volumes
251.6.1. Operations you can perform with the Volume producer
| Operation | Description |
|---|---|
|
| Create new volume. |
|
| Get the volume. |
|
| Get all volumes. |
|
| Get volume types. |
|
| Update the volume. |
|
| Delete the volume. |
251.6.2. Message headers evaluated by the Volume producer
| Header | Type | Description |
|---|---|---|
|
|
| The operation to perform. |
|
|
| ID of the volume. |
|
|
| The volume name. |
|
|
| Volume description. |
|
|
| Size of volume. |
|
|
| Volume type. |
|
|
| ID of image. |
|
|
| ID of snapshot. |
|
|
| Is bootable. |
If you need more precise volume settings you can create new object of the type org.openstack4j.model.storage.block.Volume and send in the message body.
251.7. snapshots
251.7.1. Operations you can perform with the Snapshot producer
| Operation | Description |
|---|---|
|
| Create new snapshot. |
|
| Get the snapshot. |
|
| Get all snapshots. |
|
| Get update the snapshot. |
|
| Delete the snapshot. |
251.7.2. Message headers evaluated by the Snapshot producer
| Header | Type | Description |
|---|---|---|
|
|
| The operation to perform. |
|
|
| ID of the server. |
|
|
| The server name. |
|
|
| The snapshot description. |
|
|
| The Volume ID. |
|
|
| Force. |
If you need more precise server settings you can create new object of the type org.openstack4j.model.storage.block.VolumeSnapshot and send in the message body.
251.8. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
- openstack Component
