Merge upstream readme

README.txt

@@ -1,22 +1,3 @@
-====
-
-    Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com>
-
-    ====================================================================
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
-    ====================================================================
-====
-
 Overview:
  
 jclouds is an open source library that helps you get started in the cloud
@@ -26,24 +7,14 @@ two abstractions at the moment: compute and blobstore.  compute helps you
 bootstrap machines in the cloud.  blobstore helps you manage key-value
 data.
  
-<<<<<<< HEAD
-our current version is 1.1.0
-our dev version is 1.2.0-SNAPSHOT
-=======
 our current version is 1.2.1
 our next maintenance version is 1.2.2-SNAPSHOT
 our dev version is 1.3.0-SNAPSHOT
->>>>>>> 1e1d9ef0eb56054e6769335ea46572eb709cb1f0
  
+check out our examples site! https://github.com/jclouds/jclouds-examples
+
 our compute api supports: aws-ec2, gogrid, cloudservers-us, stub (in-memory), deltacloud,
                           cloudservers-uk, vcloud (generic), ec2 (generic), byon, nova,
-<<<<<<< HEAD
-                          trmk-ecloud, trmk-vcloudexpress, eucalyptus (generic),
-                          cloudsigma-zrh, elasticstack(generic), bluelock-vclouddirector,
-                          slicehost, eucalyptus-partnercloud-ec2, elastichosts-lon-p (Peer 1), 
-                          elastichosts-sat-p (Peer 1), elastichosts-lon-b (BlueSquare),
-                          openhosting-east1, serverlove-z1-man, skalicloud-sdg-my
-=======
                           trmk-ecloud, trmk-vcloudexpress, eucalyptus (generic)
                           cloudsigma-zrh, elasticstack(generic), go2cloud-jhb1, cloudsigma-lvs,
                           bluelock-vcloud-zone01, stratogen-vcloud-mycloud, rimuhosting,
@@ -51,23 +22,18 @@ our compute api supports: aws-ec2, gogrid, cloudservers-us, stub (in-memory), de
                           elastichosts-sat-p (Peer 1), elastichosts-lon-b (BlueSquare),
                           openhosting-east1, serverlove-z1-man, skalicloud-sdg-my,
                           greenhousedata-element-vcloud, softlayer, cloudsigma (generic)
->>>>>>> 1e1d9ef0eb56054e6769335ea46572eb709cb1f0
 
   * note * the pom dependency org.jclouds/jclouds-allcompute gives you access to
            to all of these providers
 
 our blobstore api supports: aws-s3, cloudfiles-us, cloudfiles-uk, filesystem,
-                            azureblob, atmos (generic), synaptic-storage, scaleup-storage,
+                            azureblob, atmos (generic), synaptic-storage, 
-                            cloudonestorage, walrus(generic), googlestorage, ninefold-storage,
+                            cloudonestorage, walrus(generic), ninefold-storage,
-                            scality-rs2 (generic), hosteurope-storage, tiscali-storage,
                             eucalyptus-partnercloud-s3, swift (generic), transient (in-mem)
  
   * note * the pom dependency org.jclouds/jclouds-allblobstore gives you access to
            to all of these providers
 
-<<<<<<< HEAD
-we also have support for: ibmdev, mezeo, nirvanix, boxdotnet, rimuhosting, openstack nova,
-=======
 our loadbalancer api supports: cloudloadbalancers-us
  
   * note * the pom dependency org.jclouds/jclouds-allloadbalancer gives you access to
@@ -77,7 +43,6 @@ we also have aws-cloudwatch support.
 
 we also have support for: ibmdev, mezeo, nirvanix, boxdotnet, openstack nova, scality ring,
                           hosteurope-storage, tiscali-storage, scaleup-storage, googlestorage,
->>>>>>> 1e1d9ef0eb56054e6769335ea46572eb709cb1f0
                           azurequeue, simpledb, cloudstack as well as a async-http-client
                           driver in the sandbox
 
@@ -97,16 +62,15 @@ BlobStore Example (Java):
   blobStore.createContainerInLocation(null, "mycontainer");
   
   // add blob
-  blob = blobStore.newBlob("test");
+  blob = blobStore.blobBuilder("test").payload("testdata").build();
-  blob.setPayload("testdata");
   blobStore.putBlob("mycontainer", blob);
 
 BlobStore Example (Clojure):
-  (use 'org.jclouds.blobstore)
+  (use 'org.jclouds.blobstore2)
 
-  (with-blobstore ["azureblob" account encodedkey]
+  (def *blobstore* (blobstore "azureblob" account encodedkey))
-    (create-container "mycontainer")
+  (create-container *blobstore* "mycontainer")
-    (upload-blob "mycontainer" "test" "testdata"))
+  (put-blob *blobstore* "mycontainer" (blob "test" :payload "testdata"))
 
 Compute Example (Java):
   // init
@@ -115,29 +79,40 @@ Compute Example (Java):
                   accesskeyid,
                   secretaccesskey,
                   ImmutableSet.of(new Log4JLoggingModule(),
-                                  new JschSshClientModule()));
+                                  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.compute)
+  (use 'org.jclouds.compute2)
 
-  ; create a compute service using ssh and log4j extensions
+  ; create a compute service using sshj and log4j extensions
   (def compute 
-    (compute-service "trmk`-ecloud" "user" "password" :ssh :log4j))
+    (*compute* "trmk`-ecloud" "user" "password" :sshj :log4j))
 
-  ; use the default node template and launch a couple nodes
+  ; launch a couple nodes with the default operating system, installing your user.
-  ; these will have your ~/.ssh/id_rsa.pub authorized when complete
+  (create-nodes *compute* "mycluster" 2
-  (with-compute-service [compute]
+    (TemplateOptions$Builder/runScript (AdminAccess/standard)))
-    (create-nodes "mycluster" 2))
  
+  ; run a command on that group
+  (run-script-on-nodes-matching *compute* (in-group? "mycluster") "uptime" 
+    (RunScriptOptions$Builder/wrapInInitScript false))
+
 Downloads:
-  * distribution zip: http://jclouds.googlecode.com/files/jclouds-1.0-beta-9c.zip
+  * release notes: http://code.google.com/p/jclouds/wiki/ReleaseNotes111
+  * installation guide: http://code.google.com/p/jclouds/wiki/Installation
   * maven repo: http://repo2.maven.org/maven2 (maven central - the default repository)
   * snapshot repo: https://oss.sonatype.org/content/repositories/snapshots
  
@@ -153,7 +128,6 @@ Links:
 
 ## License
 
-Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com>
+Copyright (C) 2009-2011 jclouds, Inc.
 
 Licensed under the Apache License, Version 2.0
-