OpenStack Nova

Since Camel 2.19

Only producer is supported

The Openstack Nova component allows messages to be sent to an OpenStack compute services.

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.

URI Format

openstack-nova://hosturl[?options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The OpenStack Nova component supports 2 options, which are listed below.

Name Description Default Type

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

Endpoint Options

The OpenStack Nova endpoint is configured using URI syntax:

openstack-nova:host

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

host (producer)

Required OpenStack host url.

String

Query Parameters (9 parameters)

Name Description Default Type

apiVersion (producer)

OpenStack API version.

Enum values:

  • V2

  • V3

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 Nova subsystem.

Enum values:

  • flavors

  • servers

  • keypairs

String

username (producer)

Required OpenStack username.

String

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

Message Headers

The OpenStack Nova component supports 14 message header(s), which is/are listed below:

Name Description Default Type

FlavorId (flavor server)

Constant: FLAVOR_ID

ID of the flavor.

String

RAM (flavor)

Constant: RAM

Size of RAM.

Integer

VCPU (flavor)

Constant: VCPU

The number of flavor VCPU.

Integer

disk (flavor)

Constant: DISK

Size of disk.

Integer

swap (flavor)

Constant: SWAP

Size of swap.

Integer

rxtxFactor (flavor)

Constant: RXTXFACTOR

Rxtx Factor.

Integer

AdminPassword (server)

Constant: ADMIN_PASSWORD

Admin password of the new server.

String

ImageId (server)

Constant: IMAGE_ID

The Image ID.

String

KeypairName (server)

Constant: KEYPAIR_NAME

The Keypair name.

String

NetworkId (server)

Constant: NETWORK

The list of networks (by id).

List

action (server)

Constant: ACTION

An action to perform.

Enum values:

  • PAUSE

  • UNPAUSE

  • STOP

  • START

  • LOCK

  • UNLOCK

  • SUSPEND

  • RESUME

  • RESCUE

  • UNRESCUE

  • SHELVE

  • SHELVE_OFFLOAD

  • UNSHELVE

  • FORCEDELETE

Action

operation (producer)

Constant: OPERATION

The operation to perform.

String

ID (producer)

Constant: ID

The ID.

String

name (producer)

Constant: NAME

The name.

String

Usage

You can use following settings for each subsystem:

flavors

Operations you can perform with the Flavor producer

Operation Description

create

Create new flavor.

get

Get the flavor.

getAll

Get all flavors.

delete

Delete the flavor.

If you need more precise flavor settings you can create new object of the type org.openstack4j.model.compute.Flavor and send in the message body.

servers

Operations you can perform with the Server producer

Operation Description

create

Create new server.

createSnapshot

Create snapshot of the server.

get

Get the server.

getAll

Get all servers.

delete

Delete the server.

action

Perform an action on the server.

If you need more precise server settings you can create new object of the type org.openstack4j.model.compute.ServerCreate and send in the message body.

keypairs

Operations you can perform with the Keypair producer

Operation Description

create

Create new keypair.

get

Get the keypair.

getAll

Get all keypairs.

delete

Delete the keypair.