The Java Multi-Cloud Toolkit
Go to file
Adrian Cole df258a49d4 Merge pull request #1518 from jclouds/async-nits
Async nits from issue #1511
2013-04-10 08:24:17 -07:00
all bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
allblobstore bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
allcompute bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
allloadbalancer bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
apis naming convention and warning feedback from issue #1511 2013-04-10 08:13:13 -07:00
archetypes bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
assemblies bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
blobstore Deprecated remaining code related to RestContext, RestApiMetadata, and RestClientModule for ApiContext, HttpApiMetadata, HttpApiModule 2013-04-09 22:07:43 -07:00
common naming convention and warning feedback from issue #1511 2013-04-10 08:13:13 -07:00
compute Deprecated remaining code related to RestContext, RestApiMetadata, and RestClientModule for ApiContext, HttpApiMetadata, HttpApiModule 2013-04-09 22:07:43 -07:00
core renamed ignored exception to ignored 2013-04-10 08:15:57 -07:00
demos bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
drivers bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
loadbalancer bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
project Merge pull request #1404 from jclouds/update-issue-link 2013-03-09 18:19:35 -08:00
providers naming convention and warning feedback from issue #1511 2013-04-10 08:13:13 -07:00
resources bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
sandbox-apis bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
sandbox-drivers/asynchttpclient bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
sandbox-providers bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00
scriptbuilder Enforce the use of builders in Ruby and Chef statements 2013-04-03 10:27:46 +02:00
skeletons Adding listNodesByIds across the board. 2013-04-08 17:21:01 -07:00
.gitignore added support for vbox 4.2.6; 2012-12-31 01:33:43 +01:00
.mailmap Update .mailmap 2013-03-28 19:12:28 -07:00
README.md Use Java and Clojure syntax highlighting in the readme file. 2012-12-09 22:04:23 +03:00
pom.xml bump master to 1.7.0-SNAPSHOT 2013-03-08 23:02:40 -08:00

README.md

jclouds

jclouds allows provisioning and control of cloud resources, including blobstore and compute, from Java and Clojure. Our API gives allows developers to use both portable abstractions and cloud-specific features. We test support of dozens of cloud providers and cloud software stacks, including Amazon, Azure, GoGrid, Ninefold, OpenStack, and vCloud. jclouds is licensed under the Apache License, Version 2.0

Features

Even if you don't need the portable apis we provide, or could roll it your own, programming against cloud environments can be challenging. We focus on the following areas so that you can focus on using the cloud, rather than troubleshooting it!

  • SIMPLE INTERFACE Instead of creating new object types, we reuse concepts like maps so that the programming model is familiar. In this way, you can get started without dealing with REST-like apis or WS.

  • RUNTIME PORTABILITY We have drivers that allow you to operate in restricted environments like Google App Engine. We have very few required dependencies, so we are unlikely to clash with your app.

  • DEAL WITH WEB COMPLEXITY Network based computing introduces issues such as transient failures and redirects. We handle this for you.

  • UNIT TESTABILITY Writing tests for cloud endpoints is difficult. We provide you with Stub connections that simulate a cloud without creating network connections. In this way, you can write your unit tests without mocking complexity or the brittleness of remote connections.

  • PERFORMANCE Writing tests for cloud endpoints is difficult. We provide you with Stub connections that simulate a cloud without creating network connections. In this way, you can write your unit tests without mocking complexity or the brittleness of remote connections.

  • LOCATION All of our abstractions are location-aware. For example, you can get ISO-3166 codes to tell which country or province a cloud runs in.

  • QUALITY We test every provider with live scenarios before each release. If it doesn't pass, the provider goes into the sandbox.

BlobStore

Simplifies dealing with key-value providers such as Amazon S3. For example, BlobStore can give you a simple Map view of a container.

BlobStore Example (Java):

// init
context = new BlobStoreContextFactory().createContext(
"aws-s3",
accesskeyid,
secretaccesskey);
blobStore = context.getBlobStore();

// create container
blobStore.createContainerInLocation(null, "mycontainer");

// add blob
blob = blobStore.blobBuilder("test").payload("testdata").build();
blobStore.putBlob("mycontainer", blob);

BlobStore Example (Clojure):

(use 'org.jclouds.blobstore2)
(def *blobstore* (blobstore "azureblob" account encodedkey))
(create-container *blobstore* "mycontainer")
(put-blob *blobstore* "mycontainer" (blob "test" :payload "testdata"))

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.

Compute Example (Java):

// init
context = new ComputeServiceContextFactory().createContext(
"aws-ec2",
accesskeyid,
secretaccesskey,
ImmutableSet.of(new Log4JLoggingModule(), new SshjSshClientModule()));

client = context.getComputeService();

// define the requirements of your node
template = client.templateBuilder().osFamily(UBUNTU).smallest().build();

// setup a boot user which is the same as your login
template.getOptions().runScript(AdminAccess.standard());

// these nodes will be accessible via ssh when the call returns
nodes = client.createNodesInGroup("mycluster", 2, template);

// you can now run ad-hoc commands on the nodes based on predicates
responses = client.runScriptOnNodesMatching(inGroup("mycluster"), "uptime", wrapInInitScript(false));

Compute Example (Clojure):

(use 'org.jclouds.compute2)

; create a compute service using sshj and log4j extensions
(def compute (*compute* "trmk`-ecloud" "user" "password" :sshj :log4j))

; launch a couple nodes with the default operating system, installing your user.
(create-nodes *compute* "mycluster" 2
(TemplateOptions$Builder/runScript (AdminAccess/standard)))

; run a command on that group 
(run-script-on-nodes-matching *compute* (in-group? "mycluster") "uptime" 
(RunScriptOptions$Builder/wrapInInitScript false))

Check out https://github.com/jclouds/jclouds-examples for more examples!

Downloads

Resources

License

Copyright (C) 2009-2012 jclouds, Inc.

Licensed under the Apache License, Version 2.0