Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Jclouds

...

Component

...

Available

...

as

...

of

...

Camel

...

2.9

...

This

...

component

...

allows

...

interaction

...

with

...

cloud

...

provider

...

key-value

...

engines

...

(blobstores)

...

and

...

compute

...

services.

...

The

...

component

...

uses

...

jclouds

...

which

...

is

...


a

...

library

...

that

...

provides

...

abstractions

...

for

...

blobstores

...

and

...

compute

...

services.

...

ComputeService

...

simplifies

...

the

...

task

...

of

...

managing

...

machines

...

in

...

the

...

cloud.

...

For

...

example,

...

you

...

can

...

use

...

ComputeService

...

to

...

start

...

5

...

machines

...

and

...

install

...

your

...

software

...

on

...

them.

...


BlobStore

...

simplifies

...

dealing

...

with

...

key-value

...

providers

...

such

...

as

...

Amazon

...

S3.

...

For

...

example,

...

BlobStore

...

can

...

give

...

you

...

a

...

simple

...

Map

...

view

...

of

...

a

...

container.

...

The

...

camel

...

jclouds

...

component

...

allows

...

you

...

to

...

use

...

both

...

abstractions,

...

as

...

it

...

specifes

...

two

...

types

...

of

...

endpoint

...

the

...

JcloudsBlobStoreEndpoint

...

and

...

the

...

JcloudsComputeEndpoint.

...

You

...

can

...

have

...

both

...

producers

...

and

...

consumers

...

on

...

a

...

blobstore

...

endpoint

...

but

...

you

...

can

...

only

...

have

...

producers

...

on

...

compute

...

endpoints.

...

Maven

...

users

...

will

...

need

...

to

...

add

...

the

...

following

...

dependency

...

to

...

their

...

pom.xml

...

for

...

this

...

component:

Code Block
xml
xml

{code:xml}
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jclouds</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

Configuring the component

The camel jclouds component will make use of multiple jclouds blobstores and compute services as long as they are passed to the component during initialization. The component accepts a list blobstores and compute services. Here is how it can be configured.

Code Block
xml
xml
{code}

h3. Configuring the component

The camel jclouds component will make use of multiple jclouds blobstores and compute services as long as they are passed to the component during initialization. The component accepts a list blobstores and compute services. Here is how it can be configured.

{code:xml}
    <bean id="jclouds" class="org.apache.camel.component.jclouds.JcloudsComponent">
        <property name="computeServices">
            <list>
                <ref bean="computeService"/>
            </list>
        </property>
        <property name="blobStores">
            <list>
                <ref bean="blobStore"/>
            </list>
        </property>
    </bean>

    <!-- Creating a blobstore from spring / blueprint xml -->
    <bean id="blobStoreContextFactory" class="org.jclouds.blobstore.BlobStoreContextFactory"/>

    <bean id="blobStoreContext" factory-bean="blobStoreContextFactory" factory-method="createContext">
        <constructor-arg name="provider" value="PROVIDER_NAME"/>
        <constructor-arg name="identity"  value="IDENTITY"/>
        <constructor-arg name="credential" value="CREDENTIAL"/>
    </bean>

    <bean id="blobStore" factory-bean="blobStoreContext" factory-method="getBlobStore"/>

    <!-- Creating a compute service from spring / blueprint xml -->
    <bean id="computeServiceContextFactory" class="org.jclouds.compute.ComputeServiceContextFactory"/>

    <bean id="computeServiceContext" factory-bean="computeServiceContextFactory" factory-method="createContext">
        <constructor-arg name="provider" value="PROVIDER_NAME"/>
        <constructor-arg name="identity"  value="IDENTITY"/>
        <constructor-arg name="credential" value="CREDENTIAL"/>
    </bean>

    <bean id="computeService" factory-bean="computeServiceContext" factory-method="getComputeService"/>
{code}

As

...

you

...

can

...

see

...

the

...

component

...

is

...

capable

...

of

...

handling

...

multiple

...

blobstores

...

and

...

compute

...

services.

...

The

...

actual

...

implementation

...

that

...

will

...

be

...

used

...

by

...

each

...

endpoint

...

is

...

specified

...

by

...

passing

...

the

...

provider

...

inside

...

the

...

URI.

URI format

Code Block





h3. URI format

{code}
jclouds:blobstore:[provider id][?options]
jclouds:compute:[provider id][?options]
{code}

The *provider id* is the name of the cloud provider that provides the target service (_

The provider id is the name of the cloud provider that provides the target service (e.g.

...

aws-s3

...

or

...

aws_ec2

...

).

...

You

...

can

...

append

...

query

...

options

...

to

...

the

...

URI

...

in

...

the

...

following

...

format,

...

?option=value&option=value&...

Blobstore URI Options

Div
classconfluenceTableSmall

Name

Default Value

Description

operation

PUT

Producer Only. Specifies the type of operation that will be performed to the blobstore. Allowed values are PUT, GET.

container

null

The name of the blob container.

blobName

null

The name of the blob.

You can have as many of these options as you like.

Code Block
}}

h3. Blobstore URI Options

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{operation}} | PUT | *Producer Only*. Specifies the type of operation that will be performed to the blobstore. Allowed values are PUT, GET. |
| {{container}} | null | The name of the blob container. |
| {{blobName}} | null | The name of the blob. |
{div}

You can have as many of these options as you like.
{code}
jclouds:blobstore:aws-s3?operation=CamelJcloudsGet&container=mycontainer&blobName=someblob
{code}

For

...

producer

...

endpoint

...

you

...

can

...

override

...

all

...

of

...

the

...

above

...

URI

...

options

...

by

...

passing

...

the

...

appropriate

...

headers

...

to

...

the

...

message.

...

Message

...

Headers

...

for

...

blobstore

{:
Div
classconfluenceTableSmall

Header

Description

CamelJcloudsOperation

The operation to be performed on the blob. The valid options are

  • PUT
  • GET

CamelJcloudsContainer

The name of the blob container.

CamelJcloudsBlobName

The name of the blob.

Blobstore Usage Samples

Example 1: Putting to the blob

This example will show you how you can store any message inside a blob using the jclouds component.

Code Block
=confluenceTableSmall}
|| Header || Description ||
| {{CamelJcloudsOperation}} | The operation to be performed on the blob. The valid options are
- PUT
- GET |
| {{CamelJcloudsContainer}} | The name of the blob container. |
| {{CamelJcloudsBlobName}} | The name of the blob. |
{div}

h3. Blobstore Usage Samples

h4. Example 1: Putting to the blob

This example will show you how you can store any message inside a blob using the jclouds component.
{code}
from("direct:start")
    .to("jclouds:blobstore:aws-s3" +
        "?operation=PUT" +
        "&container=mycontainer" +
        "&blobName=myblob");
{code}

In

...

the

...

above

...

example

...

you

...

can

...

override

...

any

...

of

...

the

...

URI

...

parameters

...

with

...

headers

...

on

...

the

...

message.

...


Here

...

is

...

how

...

the

...

above

...

example

...

would

...

look

...

like

...

using

...

xml

...

to

...

define

...

our

...

route.

Code Block
xml
xml


{code:xml}
<route>
    <from uri="direct:start"/>
    <to uri="jclouds:blobstore:aws-s3?operation=PUT&container=mycontainer&blobName=myblob"/>
</route>
{code}

h4. Example 

Example 2:

...

Getting/Reading

...

from

...

a

...

blob

...

This

...

example

...

will

...

show

...

you

...

how

...

you

...

can

...

read

...

the

...

contnet

...

of

...

a

...

blob

...

using

...

the

...

jclouds

...

component.

{
Code Block
}
from("direct:start")
    .to("jclouds:blobstore:aws-s3" +
        "?operation=GET" +
        "&container=mycontainer" +
        "&blobName=myblob");
{code}

In

...

the

...

above

...

example

...

you

...

can

...

override

...

any

...

of

...

the

...

URI

...

parameters

...

with

...

headers

...

on

...

the

...

message.

...


Here

...

is

...

how

...

the

...

above

...

example

...

would

...

look

...

like

...

using

...

xml

...

to

...

define

...

our

...

route.

Code Block
xml
xml


{code:xml}
<route>
    <from uri="direct:start"/>
    <to uri="jclouds:blobstore:aws-s3?operation=PUT&container=mycontainer&blobName=myblob"/>
</route>
{code}


h4. Example 

Example 3:

...

Consuming

...

a

...

blob

...

This

...

example

...

will

...

consume

...

all

...

blob

...

that

...

are

...

under

...

the

...

specified

...

container.

...

The

...

generated

...

exchange

...

will

...

contain

...

the

...

payload

...

of

...

the

...

blob

...

as

...

body.

{
Code Block
}
    from("jclouds:blobstore:aws-s3" +
        "?container=mycontainer")
        .to("direct:next");
{code}

You

...

can

...

achieve

...

the

...

same

...

goal

...

by

...

using

...

xml,

...

as

...

you

...

can

...

see

...

below.

Code Block
xml
xml


{code:xml}
<route>
    <from uri="jclouds:blobstore:aws-s3?operation=GET&container=mycontainer&blobName=myblob"/>
    <to uri="direct:next"/>
</route>
{code}

h3. Compute Service URI Options

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{operation}} | PUT | Specifies the type of operation that will be performed to the compute service. Allowed values are CREATE_NODE, RUNS_CRIPT, DESTROY_NODE, LIST_NODES, LIST_IMAGES, LIST_HARDWARE. |
| {{imageId}} | null | *CREATE_NODE operation only* The imageId that will be used for creating a node. Values depend on the actual cloud provider. |
| {{locationId}} | null | *CREATE_NODE operation only* The location that will be used for creating a node. Values depend on the actual cloud provider. |
| {{hardwareId}} | null | *CREATE_NODE operation only* The hardware that will be used for creating a node. Values depend on the actual cloud provider. |
| {{group}} | null | *CREATE_NODE operation only* The group that will be assigned to the newly created node. Values depend on the actual cloud provider. |
| {{nodeId}} | null | *RUN_SCRIPT & DESTROY_NODE operation only* The id of the node that will run the script or destroyed. |
| {{user}} | null | *RUN_SCRIPT operation only* The user on the target node that will run the script. |
{div}


The combination of parameters for use with the compute service depend on the operation.
{code}

Compute Service URI Options

Div
classconfluenceTableSmall

Name

Default Value

Description

operation

CamelJcloudsPut

Specifies the type of operation that will be performed to the compute service. Allowed values are CamelJcloudsCreateNode,
CamelJcloudsRunScript, CamelJcloudsDestroyNode, CamelJCloudsDestroyNode, CamelJCloudsListNodes, CamelJCloudsListImages, CamelJCloudsListHardware.

imageId

null

CamelJcloudsCreateNode operation only The imageId that will be used for creating a node. Values depend on the actual cloud provider.

locationId

null

CamelJcloudsCreateNode operation only The location that will be used for creating a node. Values depend on the actual cloud provider.

hardwareId

null

CamelJcloudsCreateNode operation only The hardware that will be used for creating a node. Values depend on the actual cloud provider.

group

null

CamelJcloudsCreateNode operation only The group that will be assigned to the newly created node. Values depend on the actual cloud provider.

nodeId

null

CamelJcloudsRunScript & CamelJcloudsDestroyNode operation only The id of the node that will run the script or destroyed.

user

null

CamelJcloudsRunScript operation only The user on the target node that will run the script.

The combination of parameters for use with the compute service depend on the operation.

Code Block
jclouds:compute:aws-ec2?operation=CREATE_NODE&CamelJcloudsCreateNode&imageId=AMI_XXXXX&locationId=eu-west-1&group=mygroup

Compute Usage Samples

Below are some examples that demonstrate the use of jclouds compute producer in java dsl and spring/blueprint xml.

Example 1: Listing the available images.

Code Block
{code}

h3. Compute Usage Samples

Below are some examples that demonstrate the use of jclouds compute producer in java dsl and spring/blueprint xml.

h4. Example 1: Listing the available images.
{code}
    from("jclouds:compute:aws-ec2" +
        "&operation=LIST_IMAGESCamelJCloudsListImages")
        .to("direct:next");
{code}

This will create a message that will contain the list of images inside its body. You can also do the same using xml.

{code:xml}

This will create a message that will contain the list of images inside its body. You can also do the same using xml.

Code Block
xml
xml
<route>
    <from uri="jclouds:compute:aws-ec2?operation=LIST_IMAGESCamelJCloudsListImages"/>
    <to uri="direct:next"/>
</route>
{code}

h4. Example 

Example 2:

...

Create

...

a

...

new

...

node.

{
Code Block
}
    from("direct:start").
    to("jclouds:compute:aws-ec2" +
        "?operation=CREATE_NODECamelJcloudsCreateNode" +
        "&imageId=AMI_XXXXX" +
        "&locationId=XXXXX" +
        "&group=myGroup");
{code}

This

...

will

...

create

...

a

...

new

...

node

...

on

...

the

...

cloud

...

provider.

...

The

...

out

...

message

...

in

...

this

...

case

...

will

...

be

...

a

...

set

...

of

...

metadata

...

that

...

contains

...

information

...

about

...

the

...

newly

...

created

...

node

...

(e.g.

...

the

...

ip,

...

hostname

...

etc).

...

Here

...

is

...

the

...

same

...

using

...

spring

...

xml.

{
Code Block
xml
xml
:xml}
<route>
    <from uri="direct:start"/>
    <to uri="jclouds:compute:aws-ec2?operation=CREATE_NODECamelJcloudsCreateNode&imageId=AMI_XXXXX&locationId=XXXXX&group=myGroup"/>
</route>
{code}

h4. Example 

Example 3:

...

Run

...

a

...

shell

...

script

...

on

...

running

...

node.

{
Code Block
}
    from("direct:start").
    to("jclouds:compute:aws-ec2" +
        "?operation=RUN_SCRIPTCamelJcloudsRunScript" +
        "?nodeId=10" +
        "&user=ubuntu");
{code}

The

...

sample

...

above

...

will

...

retrieve

...

the

...

body

...

of

...

the

...

in

...

message,

...

which

...

is

...

expected

...

to

...

contain

...

the

...

shell

...

script

...

to

...

be

...

executed.

...

Once

...

the

...

script

...

is

...

retrieved,

...

it

...

will

...

be

...

sent

...

to

...

the

...

node

...

for

...

execution

...

under

...

the

...

specified

...

user

...

(

...

in

...

order

...

case

...

ubuntu

...

).

...

The

...

target

...

node

...

is

...

specified

...

using

...

its

...

nodeId.

...

The

...

nodeId

...

can

...

be

...

retrieved

...

either

...

upon

...

the

...

creation

...

of

...

the

...

node,

...

it

...

will

...

be

...

part

...

of

...

the

...

resulting

...

metadata

...

or

...

by

...

a

...

executing

...

a

...

LIST_NODES

...

operation.

...

Note

...

This

...

will

...

require

...

that

...

the

...

compute

...

service

...

that

...

will

...

be

...

passed

...

to

...

the

...

component,

...

to

...

be

...

initialized

...

with

...

the

...

appropriate

...

jclouds

...

ssh

...

capable

...

module

...

(

...

e.g.

...

jsch

...

or

...

sshj

...

).

...

Here

...

is

...

the

...

same

...

using

...

spring

...

xml.

Code Block
xml
xml


{code:xml}
<route>
    <from uri="direct:start"/>
    <to uri="jclouds:compute:aws-ec2?operation=RUN_SCRIPTCamelJcloudsListNodes&?nodeId=10&user=ubuntu"/>
</route>
{code}

h4. See also

If you want to find out more about jclouds here is list of interesting resources
[Jclouds Blobstore wiki|http://code.google.com/p/jclouds/wiki/BlobStore]
[Jclouds Compute wiki|http://code.google.com/p/jclouds/wiki/ComputeGuide]

See also

If you want to find out more about jclouds here is list of interesting resources
Jclouds Blobstore wiki
Jclouds Compute wiki