Installation Guide

Maven configuration

It is very easy to install jclouds using Apache Maven. If you're new to Maven, read Maven in 5 Minutes.

If you do not have a pom.xml file, you can copy and paste the one below. If your project already has a pom.xml file, just add the dependency section below into it.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <properties>
    <jclouds.version>2.1.1</jclouds.version>
  </properties>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1.0-SNAPSHOT</version>
  <dependencies>
    <dependency>
        <groupId>org.apache.jclouds</groupId>
        <artifactId>jclouds-all</artifactId>
        <version>${jclouds.version}</version>
      </dependency>
  </dependencies>
</project>

 Using the daily builds

These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation.

If you want to use the bleeding edge release of jclouds, you'll need to setup a maven dependency pointing to our snapshot repository. You need to update your repositories and add the following in your project's pom.xml:

<repositories>
    <repository>
        <id>jclouds-snapshots</id>
        <url>https://repository.apache.org/content/repositories/snapshots</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>org.apache.jclouds</groupId>
        <artifactId>jclouds-all</artifactId>
        <version>2.2.0-SNAPSHOT</version>
    </dependency>
</dependencies>

Download the binaries

  • Create a pom.xml file like the one in the Maven Configuration section above.
  • Execute mvn dependency:copy-dependencies.
  • You'll notice a new directory target/dependency with all the jars you need.

Configuring Lein

You can add jclouds to your project.clj like below, supporting clojure 1.2 and 1.3:

:dependencies [[org.clojure/clojure "1.3.0"]
               [org.clojure/core.incubator "0.1.0"]
               [org.clojure/tools.logging "0.2.3"]
               [org.apache.jclouds/jclouds-all "2.1.1"]]

Using the daily builds

These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation.

You can add jclouds snapshots to your project.clj like below:

  :dependencies [[org.clojure/clojure "1.3.0"]
                 [org.clojure/core.incubator "0.1.0"]
                 [org.clojure/tools.logging "0.2.3"]
                 [org.apache.jclouds/jclouds-all "2.2.0-SNAPSHOT"]]
  :repositories { "jclouds-snapshot" "https://repository.apache.org/content/repositories/snapshots"}

 Download the binaries

  • Download lein and make it executable.
  • Create a project.clj file with the below contents.
(defproject deps "1" :dependencies [[org.apache.jclouds/jclouds-all "2.1.1"] [org.apache.jclouds.driver/jclouds-sshj "2.1.1"]])
  • Execute lein pom, then mvn dependency:copy-dependencies which will fill target/dependency with all the jclouds jars.

Replace the provider and api in the above directory paths to the ones you want to use in your project.

Ant configuration

You will need to install maven ant tasks. Then, add jclouds to your build.xml as shown below:

<artifact:dependencies pathId="jclouds.classpath">
    <dependency groupId="org.apache.jclouds"artifactId="jclouds-all" version="2.1.1" />
</artifact:dependencies>

Using the daily builds

These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation.

You will need to install maven ant tasks. Then, add jclouds snapshot dependencies to your build.xml as shown below:

<artifact:remoteRepository id="jclouds.snapshot.repository"
    url="https://repository.apache.org/content/repositories/snapshots" />
    <artifact:dependencies pathId="jclouds.classpath">
        <dependency groupId="org.apache.jclouds"
            artifactId="jclouds-all"
            version="2.2.0-SNAPSHOT" />
    <remoteRepository refid="jclouds.snapshot.repository" />
</artifact:dependencies>

Download the binaries

If you want to automate fetching the jclouds binaries, you can use the following Ant script.

Install ant, copy the following into a build.xml file, tweaking things like 'provider' and 'driver' as necessary. The following example uses jclouds-all, jclouds-sshj as a driver, and includes the logback jars for a logging implementation.

When you run this script with ant, it will build a lib directory full of jars you can later copy into your own project.

<project default="sync-lib" xmlns:artifact="urn:maven-artifact-ant" >
    <target name="sync-lib" depends="initmvn">
        <delete dir="lib" />
        <mkdir dir="lib" />
        <artifact:dependencies filesetId="jclouds.fileset" versionsId="dependency.versions">
            <dependency groupId="org.apache.jclouds" artifactId="jclouds-all" version="2.1.1" />
            <dependency groupId="org.apache.jclouds.driver" artifactId="jclouds-sshj" version="2.1.1" />
            <dependency groupId="ch.qos.logback" artifactId="logback-classic" version="[1.0.9,)" />
        </artifact:dependencies>
        <copy todir="lib" verbose="true">
        <fileset refid="jclouds.fileset"/>
            <mapper type="flatten" />
        </copy>
    </target>

    <get src="http://search.maven.org/remotecontent?filepath=org/apache/maven/maven-ant-tasks/2.1.3/maven-ant-tasks-2.1.3.jar"
         dest="maven-ant-tasks.jar"/>

    <target name="initmvn">
        <path id="maven-ant-tasks.classpath" path="maven-ant-tasks.jar"/>
        <typedef resource="org/apache/maven/artifact/ant/antlib.xml"
             uri="urn:maven-artifact-ant"
             classpathref="maven-ant-tasks.classpath"/>
    </target>
</project>

To only fetch the jars for a particular provider replace

      <dependency groupId="org.apache.jclouds" artifactId="jclouds-all" version="2.1.1" />

with

      <dependency groupId="org.apache.jclouds.provider" artifactId="the-provider-id" version="2.1.1" />

Download the last version

Last version can be downloaded from one of the Apache mirrors.