The Java Multi-Cloud Toolkit
Go to file
Adrian Cole 900f26d700 Merge pull request #1505 from jclouds/closeable-api-1.6.x
Closeable api 1.6.x
2013-04-08 19:53:24 -07:00
all [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
allblobstore [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
allcompute [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
allloadbalancer [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
apis issue #1501: add Closeable annotation to all top-level apis 2013-04-08 18:06:33 -07:00
archetypes [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
assemblies [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
blobstore Merge pull request #1491 from maginatics/remove-input-suppliers-of-input-stream-1.6.x 2013-04-04 16:20:34 -07:00
common issue #1501: add Closeable annotation to all top-level apis 2013-04-08 18:06:33 -07:00
compute [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
core added temporary workaround for AutoCloseable which will be deleted in jclouds 1.7 2013-04-08 18:06:33 -07:00
demos undid Serializable and added checkstyle InterfaceIsType:allowMarkerInterfaces=false 2012-11-18 09:23:44 -08:00
drivers [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
loadbalancer [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
project [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
providers [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
resources [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
sandbox-apis Use Map.entrySet where possible 2013-01-21 23:59:42 -08:00
sandbox-drivers/asynchttpclient Use Map.entrySet where possible 2013-01-21 23:59:42 -08:00
sandbox-providers dependent changes on tests and internal classes 2013-01-08 00:32:45 -08:00
scriptbuilder Enforce the use of builders in Ruby and Chef statements 2013-04-05 08:43:02 +02:00
skeletons [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07:00
.gitignore added support for vbox 4.2.6; 2012-12-31 01:33:43 +01:00
.mailmap Update .mailmap 2013-03-22 11:43:40 -07:00
README.md Use Java and Clojure syntax highlighting in the readme file. 2012-12-09 22:04:23 +03:00
pom.xml [maven-release-plugin] prepare for next development iteration 2013-04-03 18:25:58 -07: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