Installing jclouds on Apache KarafKaraf,OSGi

Instructions on how to install Jclouds on Apache Karaf and run the examples.

Introduction

Apache Karaf is an OSGi runtime which runs on top of most OSGi containers like Apache Felix and Eclipse Equinox. JClouds provide easy integration with Apache Karaf by leveraging the Karaf "Feature" concept.

This section will describe how to install JClouds on Karaf and run some examples that demonstrate the power of JClouds in a dynamic environment such as Karaf.

JClouds provides the following Karaf "features"

jclouds-aws-ec2
jclouds-googlestorage
jclouds-gogrid
jclouds-eucalyptus-s3
jclouds-eucalyptus-ec2
jclouds-azureblob
jclouds-cloudfiles-uk
jclouds-cloudfiles-us
jclouds-cloudloadbalancers-us
jclouds-cloudonestorage
jclouds-cloudserver-uk
jclouds-cloudserver-us
jclouds-cloudsigma-zrh
jclouds-elastichosts-lon-b
jclouds-elastichosts-lon-p
jclouds-elastichosts-sat-p
jclouds-hosteurope-storage
jclouds-ninefold-storage
jclouds-openhosting-east1
jclouds-savvis-symphonyvpdc
jclouds-scaleup-storage
jclouds-serverlove-z1-man
jclouds-skalicloud-sdg-my
jclouds-slicehost
jclouds-synaptic-storage
jclouds-tiscali-storage
jclouds-trmk-ecloud
jclouds-trmk-vcloudexpress

Installation

Get jclouds-karaf from https://github.com/jclouds/jclouds-karaf.

As of jclouds 1.0.0 release jcoulds-karaf feature is available on central maven repository, so you can skip this step of getting the source and building it and go directly to the install of JClouds feature.

git clone git://github.com/jclouds/jclouds-karaf.git
cd jclouds-karaf
mvn clean install

Start Karaf and install the JClouds feature!

features:addurl mvn:org.jclouds.karaf/feature/1.0/xml/features
features:install jclouds

Now the core of JClouds is installed. You can select which additional JClouds features you wish and install them using the shell:

features:list | grep jclouds

Example

For installing the module for aws-s3:

features:install jclouds-aws-s3

= Running the examples = There is an example available which demonstrates how you can use JClouds inside Karaf. The examples leverages the Karaf Shell and the configuration admin, in order to provide 2 shell commands that read and write data to a blobstore. The blobstore provider and the access information are configurable via the OSGi configuration admin and can change dynamically.

The first step is to get and build the example:

git clone https://iocanel@github.com/jclouds/jclouds-examples.git
cd jcoulds-examples/blobstore-karaf-shell
mvn clean install

Then from Karaf shell you can install the example:

osgi:install -s mvn:org.jclouds.examples/blobstore-karaf-shell/1.0-SNAPSHOT

The command above installs in Karaf two new commands:

jclouds:blobstore-write
jclouds:blobstore-read

In order to use those commands, you first need to configure the provider. The configuration is done using the org.jclouds.blobstore PID. You can create the configuration either from inside the shell or by dropping a file named org.jclouds.blobstore.cfg under karaf's etc folder. Let's see how it can be done using the Karaf shell:

config:edit org.jclouds.blobstore
config:propset provider aws-s3
config:propset accessKeyId XXXXXX 
config:propset secretKey XXXXXX 
config:update

Now you are ready to use the commands

jclouds:blobstore-write mybucket myblob JCloudsRocks
jclouds:blobstore-write mybucket myblob

At any point in time, you can edit the configuration, either using the shell or by editing the configuration file. The commands will pick up the changes immediately. This way you can even switch providers.

You can also watch the demo video.