Skip to content

Commit

Permalink
WHIRR-86. Update quick start documentation to work with release 0.1.0.
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.apache.org/repos/asf/incubator/whirr/trunk@995872 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
tomwhite committed Sep 10, 2010
1 parent be4acc7 commit 96a86cc
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
3 changes: 3 additions & 0 deletions CHANGES.txt
Expand Up @@ -81,3 +81,6 @@ Release 0.1.0 - 2010-09-02
WHIRR-82. Integration tests should not run on "mvn install". (tomwhite)

WHIRR-84. Log4j is missing from the CLI JAR. (tomwhite)

WHIRR-86. Update quick start documentation to work with release 0.1.0.
(tomwhite)
32 changes: 23 additions & 9 deletions src/site/confluence/quick-start-guide.confluence
Expand Up @@ -12,27 +12,41 @@ h3. Install Whirr
[build|https://cwiki.apache.org/confluence/display/WHIRR/How+To+Contribute] Whirr. Call the directory
which contains the Whirr JAR files {{WHIRR\_HOME}} (you might like to define this as an environment variable).

You can test that Whirr is working by running:
You can test that Whirr is working by running
(this is for version {{0.1.0-incubating}}):

{code}
% java -jar $WHIRR_HOME/whirr-cli-0.1.0-SNAPSHOT.jar
% java -jar $WHIRR_HOME/whirr-cli-0.1.0-incubating.jar
{code}

It is handy to create an alias for whirr, and for one including cloud credentials:
It is handy to create an alias for whirr:

{code}
% alias whirr='java -jar $WHIRR_HOME/whirr-cli-0.1.0-SNAPSHOT.jar'
% alias whirr-ec2='whirr --identity=$AWS_ACCESS_KEY_ID --credential=$AWS_SECRET_ACCESS_KEY'
% alias whirr='java -jar $WHIRR_HOME/whirr-cli-0.1.0-incubating.jar'
{code}

h3. Launch a cluster

The following will launch a Hadoop cluster with a single machine for the namenode and jobtracker, and
First, create a properties file to define the cluster. The name doesn't matter,
but here we will assume it is called _hadoop.properties_ and located in your home directory.
This file defines a cluster
with a single machine for the namenode and jobtracker, and
a further machine for a datanode and tasktracker.

{code}
% whirr-ec2 launch-cluster --service-name=hadoop --cluster-name=tomhadoopcluster \
--instance-templates='1 nn+jt 1 dn+tt'
whirr.service-name=hadoop
whirr.cluster-name=myhadoopcluster
whirr.instance-templates=1 jt+nn,1 dn+tt
whirr.provider=ec2
whirr.identity=<cloud-provider-identity>
whirr.credential=<cloud-provider-credential>
whirr.private-key-file=${sys:user.home}/.ssh/id_rsa
{code}

Run the following command to launch a cluster:

{code}
% whirr launch-cluster --config hadoop.properties
{code}

Once the cluster has launched you can browse it by connecting to http://master-host:50030.
Expand All @@ -48,7 +62,7 @@ h3. Destroy a cluster
When you've finished using a cluster you can terminate the instances and clean up resources with

{code}
% whirr-ec2 destroy-cluster --service-name hadoop --cluster-name tomhadoopcluster
% whirr destroy-cluster --config hadoop.properties
{code}

h2. Whirr API
Expand Down

0 comments on commit 96a86cc

Please sign in to comment.