You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@whirr.apache.org by to...@apache.org on 2011/08/29 23:04:59 UTC
svn commit: r1163004 [3/3] - in /whirr: branches/branch-0.6/
branches/branch-0.6/src/site/ branches/branch-0.6/src/site/xdoc/ site/
site/src/ site/src/site/ site/src/site/resources/
site/src/site/resources/css/ site/src/site/resources/images/ site/src/...
Added: whirr/site/src/site/resources/images/whirr-logo.jpg
URL: http://svn.apache.org/viewvc/whirr/site/src/site/resources/images/whirr-logo.jpg?rev=1163004&view=auto
==============================================================================
Files whirr/site/src/site/resources/images/whirr-logo.jpg (added) and whirr/site/src/site/resources/images/whirr-logo.jpg Mon Aug 29 21:04:58 2011 differ
Added: whirr/site/src/site/resources/images/whirr-logo.png
URL: http://svn.apache.org/viewvc/whirr/site/src/site/resources/images/whirr-logo.png?rev=1163004&view=auto
==============================================================================
Files whirr/site/src/site/resources/images/whirr-logo.png (added) and whirr/site/src/site/resources/images/whirr-logo.png Mon Aug 29 21:04:58 2011 differ
Added: whirr/site/src/site/site.xml
URL: http://svn.apache.org/viewvc/whirr/site/src/site/site.xml?rev=1163004&view=auto
==============================================================================
--- whirr/site/src/site/site.xml (added)
+++ whirr/site/src/site/site.xml Mon Aug 29 21:04:58 2011
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+<project name="Whirr">
+ <bannerLeft>
+ <name>Whirr</name>
+ <src>http://whirr.apache.org/images/whirr-logo.png</src>
+ <href>http://whirr.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://www.apache.org/images/asf_logo_wide.png</src>
+ <href>http://www.apache.org/</href>
+ </bannerRight>
+
+ <publishDate position="right"/>
+ <version position="none"/>
+
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-stylus-skin</artifactId>
+ <version>1.2</version>
+ </skin>
+
+ <body>
+ <links position="left">
+ <item name="Wiki" href="https://cwiki.apache.org/confluence/display/WHIRR" />
+ <item name="JIRA" href="https://issues.apache.org/jira/browse/WHIRR" />
+ <item name="SVN" href="https://svn.apache.org/repos/asf/whirr/" />
+ </links>
+
+ <breadcrumbs position="left">
+ <item name="Apache" href="http://www.apache.org/" />
+ <item name="Whirr" href="http://whirr.apache.org/"/>
+ </breadcrumbs>
+
+ <menu name="Whirr">
+ <item name="About" href="index.html"/>
+ <item name="Download" href="http://www.apache.org/dyn/closer.cgi/incubator/whirr/"/>
+ <item name="Road Map" href="https://cwiki.apache.org/confluence/display/WHIRR/RoadMap" />
+ <item name="Wiki" href="https://cwiki.apache.org/confluence/display/WHIRR" />
+ <item name="FAQ" href="faq.html"/>
+ </menu>
+
+ <menu name="Project Information">
+ <item name="Summary" href="project-info.html" />
+ <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="IRC" href="https://cwiki.apache.org/confluence/display/WHIRR/IRC+Channel" />
+ <item name="Team" href="team-list.html" />
+ <item name="Issue Tracking" href="issue-tracking.html" />
+ <item name="License" href="license.html" />
+ </menu>
+
+ <menu name="Documentation">
+ <item name="Home" href="docs/0.6.0/"/>
+ <item name="Whirr in 5 Minutes" href="docs/0.6.0/whirr-in-5-minutes.html"/>
+ <item name="Quick Start Guide" href="docs/0.6.0/quick-start-guide.html"/>
+ <item name="Configuration Guide" href="docs/0.6.0/configuration-guide.html"/>
+ <item name="API Guide" href="docs/0.6.0/api-guide.html"/>
+ <item name="Javadoc" href="docs/0.6.0/apidocs/index.html"/>
+ <item name="Release Notes" href="docs/0.6.0/release-notes.html" />
+ <item name="Known Limitations" href="docs/0.6.0/known-limitations.html" />
+ <item name="Supported Services and Clouds" href="docs/0.6.0/supported-services-and-clouds.html" />
+ </menu>
+
+ <!-- menu name="Older Documentation">
+ <item name="0.5.0" href="docs/0.5.0/index.html"/>
+ </menu-->
+
+ </body>
+</project>
Propchange: whirr/site/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: whirr/site/src/site/xdoc/faq.xml
URL: http://svn.apache.org/viewvc/whirr/site/src/site/xdoc/faq.xml?rev=1163004&view=auto
==============================================================================
--- whirr/site/src/site/xdoc/faq.xml (added)
+++ whirr/site/src/site/xdoc/faq.xml Mon Aug 29 21:04:58 2011
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties></properties>
+ <body>
+ <section name="Frequently Asked Questions"></section>
+ <p>
+ <a name="how-do-i-find-my-cloud-credentials"></a>
+ </p>
+
+ <subsection name="How do I find my cloud credentials?"></subsection>
+
+ <p>On EC2:</p>
+ <ol style="list-style-type: decimal">
+ <li>Go to
+ <a class="externalLink"
+ href="http://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key">
+ http://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key</a> </li>
+ <li>Log in, if prompted</li>
+ <li>Find your Access Key ID and Secret Access Key in the "Access Credentials" section, under
+ the "Access Keys" tab. You will have to click "Show" to see the text of your secret access
+ key.</li>
+ </ol>
+ <p>Another good resource is
+ <a class="externalLink" href="http://alestic.com/2009/11/ec2-credentials">Understanding Access
+ Credentials for AWS/EC2</a> by Eric Hammond.</p>
+
+ <subsection name="Can I specify my own private key?"></subsection>
+
+ <p>Yes, by setting
+ <tt>whirr.private-key-file</tt> (or
+ <tt>--private-key-file</tt> on the command line). You should also set
+ <tt>whirr.public-key-file</tt> (
+ <tt>--public-key-file</tt> ) at the same time.</p>
+ <p>Private keys must not have a passphrase associated with them. You can check this with:</p>
+ <source>grep ENCRYPTED ~/.ssh/id_rsa</source>
+ <p>If there is no passphrase then there will be no match.</p>
+
+ <subsection name="How do I access my cluster from a different network?"></subsection>
+
+ <p>By default, access to clusters is restricted to the single IP address of the machine
+ starting the cluster, as determined by
+ <a class="externalLink" href="http://checkip.amazonaws.com/">Amazon's check IP service</a> .
+ However, some networks report multiple origin IP addresses (e.g. they round-robin between them
+ by connection), which may cause problems if the address used for later connections is different
+ to the one reported at the time of the first connection.</p>
+ <p>A related problem is when you wish to access the cluster from a different network to the one
+ it was launched from.</p>
+ <p>In these cases you can specify the IP addresses of the machines that may connect to the
+ cluster by setting the
+ <tt>client-cidrs</tt> property to a comma-separated list of
+ <a class="externalLink" href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">
+ CIDR</a> blocks.</p>
+ <p>For example,
+ <tt>208.128.0.0/16,38.102.147.107/32</tt> would allow access from the
+ <tt>208.128.0.0</tt> class B network, and the (single) IP address 38.102.147.107.</p>
+
+ <subsection name="How can I start a cluster in a particular location?"></subsection>
+
+ <p>By default clusters are started in an arbitrary location (e.g. region or data center). You
+ can control the location by setting
+ <tt>location-id</tt> (see the
+ <a href="configuration-guide.html">configuration guide</a> for details).</p>
+ <p>For example, in EC2, setting
+ <tt>location-id</tt> to
+ <tt>us-east-1</tt> would start the cluster in the US-East region, while setting it to
+ <tt>us-east-1a</tt> (note the final
+ <tt>a</tt> ) would start the cluster in that particular availability zone (
+ <tt>us-east-1a</tt> ) in the US-East region.</p>
+
+ <subsection name="How can I use a custom image? How can I control the cloud hardware used?">
+ </subsection>
+
+ <p>The default image used is dependent on the Cloud provider, the hardware, and the service.
+ Whirr tries to find an image with Ubuntu Server and at least 1024 MB of RAM.</p>
+ <p>Use
+ <tt>image-id</tt> to specify the image used, and
+ <tt>hardware-id</tt> to specify the hardware. Both are cloud-specific.</p>
+ <p>You can specify the amount of RAM in a cloud agnostic way by setting a value for
+ <tt>hardware-min-ram</tt> .</p>
+ <p>In addition, on EC2 you need to set jclouds.ec2.ami-owners to include the AMI owner if it is
+ not Amazon, Alestic, Canonical, or RightScale.</p>
+
+ <subsection name="How do I log in to a node in the cluster?"></subsection>
+
+ <p>On EC2, if you know the node's address you can do:</p>
+ <source>ssh -i ~/.ssh/id_rsa <whirr.cluster-user>@host</source>
+ <p>This assumes that you use the default private key; if this is not the case then specify the
+ one you used at cluster launch.</p>
+ <p>
+ <tt>whirr.cluster-user</tt> defaults to the name of the local user running Whirr.</p>
+ <p>
+ <a name="how-can-i-modify-the-instance-installation-and-configuration-scripts"></a>
+ </p>
+
+ <subsection name="How can I modify the instance installation and configuration scripts?">
+ </subsection>
+
+ <p>The scripts to install and configure cloud instances are searched for on the classpath.</p>
+ <p>(Note that in versions prior to 0.4.0 scripts were downloaded from S3 by default, and could
+ be overridden by setting
+ <tt>run-url-base</tt> . This property no longer has any effect, so you should instead use the
+ approach explained below.)</p>
+ <p>If you want to change the scripts then you can place a modified copy of the scripts in a
+ <i>functions</i>directory in Whirr's installation directory. The original versions of the
+ scripts can be found in
+ <i>functions</i>directories in the source trees.</p>
+ <p>For example, to override the Hadoop scripts, do the following:</p>
+ <source>
+cd $WHIRR_HOME
+mkdir functions
+cp services/hadoop/src/main/resources/functions/* functions
+</source>
+<p>Then make your changes to the copies in
+<i>functions</i>.</p>
+<p>The first port of call for debugging the scripts that run on on a cloud instance is the
+<i>whirr.log</i>in the directory from which you launched the
+<i>whirr</i>CLI.</p>
+<p>The script output in this log file may be truncated, but you can see the complete output by
+logging into the node on which the script ran (see "How do I log in to a node in the cluster?"
+above) and looking in the
+<i>/tmp/bootstrap</i>or directories for the script itself, and the standard output and standard
+error logs.</p>
+
+<subsection name="How do I specify the service version and other service properties?">
+</subsection>
+
+<p>Some services have a property to control the version number of the software to be installed.
+This is typically achieved by setting the property
+<tt>whirr.<service-name>.tarball.url</tt> . Similarly, some services can have arbitrary
+service properties set.</p>
+<p>See the samples in the
+<i>recipes</i>directory for details for a particular service.</p>
+<p>In cases where neither of these configuration controls are supported, you may modify the
+scripts to install a particular version of the service, or to change the service properties
+from the defaults. See "How to modify the instance installation and configuration scripts"
+above for details on how to override the scripts.</p>
+
+<subsection name="How can I install custom packages?"></subsection>
+
+<p>You can install extra software by modifying the scripts that run on the cloud instances. See
+"How to modify the instance installation and configuration scripts" above.</p>
+
+<subsection name="How do I run Cloudera's Distribution for Hadoop?"></subsection>
+
+<p>You can run CDH rather than Apache Hadoop by running the Hadoop service and setting the
+<tt>whirr.hadoop.install-function</tt> and
+<tt>whirr.hadoop.configure-function</tt> properties. See the
+<i>recipes</i>directory in the distribution for samples.</p>
+<p>
+<a name="other-services"></a>
+</p>
+
+<subsection name="How do I run a Cassandra/HBase/ZooKeeper cluster?"></subsection>
+
+<p>See the
+<i>recipes</i>directory in the distribution for samples.</p>
+
+<subsection name="How do I automatically tear down a cluster after a fixed time?"></subsection>
+
+<p>It's often convenient to terminate a cluster a fixed time after launch. This is the case for
+test clusters, for example. You can achieve this by scheduling the destroy command using the
+<tt>at</tt> command from your local machine.</p>
+<p>
+<b>WARNING: The machine from which you issued the
+<tt>at</tt> command must be running (and able to contact the cloud provider) at the time it
+runs.</b>
+</p>
+<source>% echo 'bin/whirr destroy-cluster --config hadoop.properties' | at 'now + 50 min'</source>
+ <p>Note that issuing a
+ <tt>shutdown</tt> command on an instance may simply stop the instance, which is not sufficient
+ to fully terminate the instance, in which case you would continue to be charged for it. This is
+ the case for EBS boot instances, for example.</p>
+ <p>You can read more about this technique on
+ <a class="externalLink" href="http://alestic.com/2010/09/ec2-instance-termination">Eric
+ Hammond's blog</a> .</p>
+ <p>Also, Mac OS X users might find
+ <a class="externalLink"
+ href="http://superuser.com/questions/43678/mac-os-x-at-command-not-working">this thread</a> a
+ useful reference for the
+ <tt>at</tt> command.</p>
+
+ <subsection name="How do I start a machine without having a cluster role?"></subsection>
+
+ <p>Sometimes you need to provision machines in the same cluster without having a specific role.
+ For this you can use "noop" as a role name when specifying the instance templates.</p>
+ <source>
+whirr.instance-templates=3 zookeeper,1 noop
+# will start three machines with zookeeper and one machine just with the OS
+</source>
+ </body>
+</document>
Added: whirr/site/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/whirr/site/src/site/xdoc/index.xml?rev=1163004&view=auto
==============================================================================
--- whirr/site/src/site/xdoc/index.xml (added)
+++ whirr/site/src/site/xdoc/index.xml Mon Aug 29 21:04:58 2011
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties></properties>
+ <body>
+
+ <section name="Apache Whirr"></section>
+ <p>Apache Whirr is a set of libraries for running cloud services.</p>
+ <p>Whirr provides:</p>
+ <ul>
+ <li>A cloud-neutral way to run services. You don't have to worry about the idiosyncrasies of
+ each provider.</li>
+ <li>A common service API. The details of provisioning are particular to the service.</li>
+ <li>Smart defaults for services. You can get a properly configured system running quickly,
+ while still being able to override settings as needed.</li>
+ </ul>
+ <p>You can also use Whirr as a command line tool for deploying clusters.</p>
+
+ <subsection name="Download"></subsection>
+
+ <p>Download a release of Whirr from a
+ <a class="externalLink" href="http://www.apache.org/dyn/closer.cgi/incubator/whirr/">nearby
+ mirror</a>.</p>
+
+ <subsection name="Getting Started"></subsection>
+
+ <p>Start with <a href="docs/0.6.0/whirr-in-5-minutes.html">Whirr in 5 Minutes</a>
+ or the
+ <a href="docs/0.6.0/quick-start-guide.html">Quick Start Guide</a>.</p>
+ <p>There is also an
+ <a href="faq.html">FAQ</a> which covers how to achieve common tasks with Whirr, and a
+ <a href="docs/0.6.0/configuration-guide.html">configuration guide</a> for reference.</p>
+
+ <p>Find out more about Whirr at our
+ <a class="externalLink" href="https://cwiki.apache.org/confluence/display/WHIRR">wiki</a>.</p>
+
+ <subsection name="Getting Involved"></subsection>
+
+ <p>Have you got a suggestion for improving Whirr? It's easy to
+ <a class="externalLink"
+ href="https://cwiki.apache.org/confluence/display/WHIRR/How+To+Contribute">get
+ involved</a>.</p>
+
+ <subsection name="History"></subsection>
+
+ <p>The code that would become Whirr started out in 2007 as some
+ <a class="externalLink" href="https://issues.apache.org/jira/browse/HADOOP-884">bash scripts in
+ Apache Hadoop</a> for running Hadoop clusters on EC2. Later the scripts were
+ <a class="externalLink" href="https://issues.apache.org/jira/browse/WHIRR-3">ported to
+ Python</a> for extra features (such as EBS support) and a wider range of cloud providers. These
+ Python scripts are no longer supported, but can be found in the 0.5.0 release and the
+ <i>contrib-python</i> SVN branch.</p>
+ <p>In May 2010 the Apache Whirr
+ Incubator project was started to give a home to the existing work that had been done, but
+ also to create a Java version using
+ <a class="externalLink" href="http://code.google.com/p/jclouds/">jclouds</a> as the cloud
+ provisioning library. jclouds supports many providers and has a very rich API for running code
+ on instances, so it provides a very solid foundation for building Whirr on.</p>
+ <p>In August 2011 Whirr became an Apache Top-Level Project.</p>
+ </body>
+</document>
Added: whirr/site/src/site/xdoc/xdoc.xsl
URL: http://svn.apache.org/viewvc/whirr/site/src/site/xdoc/xdoc.xsl?rev=1163004&view=auto
==============================================================================
--- whirr/site/src/site/xdoc/xdoc.xsl (added)
+++ whirr/site/src/site/xdoc/xdoc.xsl Mon Aug 29 21:04:58 2011
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+ -->
+
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+ <xsl:template match="/">
+ <html xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <head>
+ <xsl:apply-templates select="/document/properties/title"/>
+ <xsl:apply-templates select="/document/meta"/>
+ <style type="text/css">
+ @import url("../style/tigris.css");
+ @import url("../style/maven.css");
+ @import url("../style/project.css");
+ </style>
+ <link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link>
+ </head>
+ <xsl:apply-templates select="/document/body"/>
+ </html>
+ </xsl:template>
+ <xsl:template match="body">
+ <body>
+ <div class="app">
+ <xsl:apply-templates/>
+ </div>
+ </body>
+ </xsl:template>
+ <xsl:template match="section">
+ <div>
+ <h3><xsl:value-of select="@name"/></h3>
+ <xsl:apply-templates/>
+ </div>
+ </xsl:template>
+ <xsl:template match="subsection">
+ <div>
+ <h4><xsl:value-of select="@name"/></h4>
+ <xsl:apply-templates/>
+ </div>
+ </xsl:template>
+ <xsl:template match="source">
+ <div id="source">
+ <pre>
+ <xsl:apply-templates/>
+ </pre>
+ </div>
+ </xsl:template>
+ <xsl:template match="node()|@*">
+ <xsl:copy>
+ <xsl:apply-templates select="@*"/>
+ <xsl:apply-templates/>
+ </xsl:copy>
+ </xsl:template>
+</xsl:stylesheet>
Modified: whirr/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/whirr/trunk/CHANGES.txt?rev=1163004&r1=1163003&r2=1163004&view=diff
==============================================================================
--- whirr/trunk/CHANGES.txt (original)
+++ whirr/trunk/CHANGES.txt Mon Aug 29 21:04:58 2011
@@ -8,6 +8,8 @@ Trunk (unreleased changes)
IMPROVEMENTS
+ WHIRR-116. Site should have docs for each released version. (tomwhite)
+
BUG FIXES
WHIRR-377. Fix broken CLI logging config. (asavu via tomwhite)
Modified: whirr/trunk/pom.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/pom.xml?rev=1163004&r1=1163003&r2=1163004&view=diff
==============================================================================
--- whirr/trunk/pom.xml (original)
+++ whirr/trunk/pom.xml Mon Aug 29 21:04:58 2011
@@ -373,191 +373,17 @@
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-pdf-plugin</artifactId>
- <version>1.1</version>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven.doxia</groupId>
- <artifactId>doxia-module-confluence</artifactId>
- <version>1.1.3</version>
- </dependency>
- </dependencies>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>2.1.1</version>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven.doxia</groupId>
- <artifactId>doxia-module-confluence</artifactId>
- <version>1.1.3</version>
- </dependency>
- </dependencies>
+ <version>3.0</version>
+ <configuration>
+ <!-- Reports are generated at the site level -->
+ <generateReports>false</generateReports>
+ </configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
- <configuration>
- <configLocation>./build-tools/src/main/resources/checkstyle.xml</configLocation>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.2</version>
- <reportSets>
- <reportSet>
- <reports>
- <report>modules</report>
- <report>project-team</report>
- <report>mailing-list</report>
- <report>issue-tracking</report>
- <report>license</report>
-<!-- for now
- <report>dependencies</report>
- <report>cim</report>
- <report>scm</report>
--->
- </reports>
- </reportSet>
- </reportSets>
- </plugin>
- </plugins>
- </reporting>
- <developers>
- <developer>
- <id>apurtell</id>
- <name>Andrew Purtell</name>
- <organization>Trend Micro</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>cutting</id>
- <organization>Cloudera</organization>
- <name>Doug Cutting</name>
- <roles>
- <role>mentor</role>
- </roles>
- </developer>
- <developer>
- <id>johan</id>
- <name>Johan Oskarsson</name>
- <organization>Twitter</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>larsgeorge</id>
- <name>Lars George</name>
- <organization>Cloudera</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>phunt</id>
- <name>Patrick Hunt</name>
- <organization>Cloudera</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>stevel</id>
- <name>Steve Loughran</name>
- <organization>HP Labs</organization>
- <roles>
- <role>mentor</role>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>tomwhite</id>
- <name>Tom White</name>
- <organization>Cloudera</organization>
- <roles>
- <role>mentor</role>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>asavu</id>
- <name>Andrei Savu</name>
- <organization>Facebook</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>adriancole</id>
- <name>Adrian Cole</name>
- <organization>Cloud Conscious</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- <developer>
- <id>tibor</id>
- <name>Tibor Kiss</name>
- <organization>Omixon</organization>
- <roles>
- <role>committer</role>
- </roles>
- </developer>
- </developers>
- <issueManagement>
- <system>JIRA</system>
- <url>http://issues.apache.org/jira/browse/WHIRR</url>
- </issueManagement>
- <mailingLists>
- <mailingList>
- <name>Users</name>
- <post>whirr-user@incubator.apache.org</post>
- <subscribe>whirr-user-subscribe@incubator.apache.org</subscribe>
- <unsubscribe>whirr-user-unsubscribe@incubator.apache.org</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/incubator-whirr-user/</archive>
-<!--
- <otherArchives>
- <otherArchive>http://whirr-user.917769.n3.nabble.com/</otherArchive>
- </otherArchives>
--->
- </mailingList>
- <mailingList>
- <name>Development</name>
- <post>whirr-dev@incubator.apache.org</post>
- <subscribe>whirr-dev-subscribe@incubator.apache.org</subscribe>
- <unsubscribe>whirr-dev-unsubscribe@incubator.apache.org</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/incubator-whirr-dev/</archive>
-<!--
- <otherArchives>
- <otherArchive>http://whirr-dev.917766.n3.nabble.com/</otherArchive>
- </otherArchives>
--->
- </mailingList>
- <mailingList>
- <name>Commits</name>
- <post>whirr-commits@incubator.apache.org</post>
- <subscribe>whirr-commits-subscribe@incubator.apache.org</subscribe>
- <unsubscribe>whirr-commits-unsubscribe@incubator.apache.org</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/incubator-whirr-commits/</archive>
- </mailingList>
- </mailingLists>
- <scm>
- <connection>scm:svn:http://svn.apache.org/repos/asf/incubator/whirr/trunk/</connection>
- <developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/whirr/trunk/</developerConnection>
- <url>http://svn.apache.org/viewvc/incubator/whirr/trunk/</url>
- </scm>
<repositories>
<repository>
<id>apache.snapshots</id>
@@ -581,7 +407,7 @@
<distributionManagement>
<site>
<id>apache.website</id>
- <url>scpexe://people.apache.org/www/incubator.apache.org/whirr</url>
+ <url>scpexe://people.apache.org/www/whirr.apache.org/docs/${project.version}</url>
</site>
</distributionManagement>
<profiles>
Modified: whirr/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/src/site/site.xml?rev=1163004&r1=1163003&r2=1163004&view=diff
==============================================================================
--- whirr/trunk/src/site/site.xml (original)
+++ whirr/trunk/src/site/site.xml Mon Aug 29 21:04:58 2011
@@ -18,12 +18,12 @@
<project name="Whirr">
<bannerLeft>
<name>Whirr</name>
- <src>http://incubator.apache.org/whirr/images/whirr-logo.png</src>
- <href>http://incubator.apache.org/whirr/</href>
+ <src>http://whirr.apache.org/images/whirr-logo.png</src>
+ <href>http://whirr.apache.org/</href>
</bannerLeft>
<bannerRight>
- <src>http://incubator.apache.org/images/apache-incubator-logo.png</src>
- <href>http://incubator.apache.org/</href>
+ <src>http://www.apache.org/images/asf_logo_wide.png</src>
+ <href>http://www.apache.org/</href>
</bannerRight>
<publishDate position="right"/>
@@ -39,39 +39,42 @@
<links position="left">
<item name="Wiki" href="https://cwiki.apache.org/confluence/display/WHIRR" />
<item name="JIRA" href="https://issues.apache.org/jira/browse/WHIRR" />
- <item name="SVN" href="https://svn.apache.org/repos/asf/incubator/whirr/" />
+ <item name="SVN" href="https://svn.apache.org/repos/asf/whirr/" />
</links>
<breadcrumbs position="left">
<item name="Apache" href="http://www.apache.org/" />
- <item name="Apache Incubator" href="http://incubator.apache.org/" />
- <item name="Whirr" href="http://incubator.apache.org/whirr/"/>
+ <item name="Whirr" href="http://whirr.apache.org/"/>
+ <item name="0.6.0" href="http://whirr.apache.org/docs/0.6.0/"/>
</breadcrumbs>
<menu name="Whirr">
- <item name="About" href="index.html"/>
+ <item name="About" href="http://whirr.apache.org/"/>
<item name="Download" href="http://www.apache.org/dyn/closer.cgi/incubator/whirr/"/>
- <item name="Release Notes" href="release-notes.html" />
<item name="Road Map" href="https://cwiki.apache.org/confluence/display/WHIRR/RoadMap" />
<item name="Wiki" href="https://cwiki.apache.org/confluence/display/WHIRR" />
- <item name="FAQ" href="faq.html"/>
+ <item name="FAQ" href="http://whirr.apache.org/faq.html"/>
</menu>
<menu name="Project Information">
- <item name="Summary" href="project-info.html" />
- <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="Summary" href="http://whirr.apache.org/project-info.html" />
+ <item name="Mailing Lists" href="http://whirr.apache.org/mail-lists.html" />
<item name="IRC" href="https://cwiki.apache.org/confluence/display/WHIRR/IRC+Channel" />
- <item name="Team" href="team-list.html" />
- <item name="Issue Tracking" href="issue-tracking.html" />
- <item name="License" href="license.html" />
+ <item name="Team" href="http://whirr.apache.org/team-list.html" />
+ <item name="Issue Tracking" href="http://whirr.apache.org/issue-tracking.html" />
+ <item name="License" href="http://whirr.apache.org/license.html" />
</menu>
<menu name="Documentation">
+ <item name="Home" href="index.html"/>
<item name="Whirr in 5 Minutes" href="whirr-in-5-minutes.html"/>
<item name="Quick Start Guide" href="quick-start-guide.html"/>
<item name="Configuration Guide" href="configuration-guide.html"/>
<item name="API Guide" href="api-guide.html"/>
<item name="Javadoc" href="apidocs/index.html"/>
+ <item name="Release Notes" href="release-notes.html" />
+ <item name="Known Limitations" href="known-limitations.html" />
+ <item name="Supported Services and Clouds" href="supported-services-and-clouds.html" />
</menu>
</body>
Modified: whirr/trunk/src/site/xdoc/api-guide.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/src/site/xdoc/api-guide.xml?rev=1163004&r1=1163003&r2=1163004&view=diff
==============================================================================
--- whirr/trunk/src/site/xdoc/api-guide.xml (original)
+++ whirr/trunk/src/site/xdoc/api-guide.xml Mon Aug 29 21:04:58 2011
@@ -31,8 +31,5 @@ xsi:schemaLocation="http://maven.apache.
<p>You can execute an example by running:
<source>$ ./bin/example [example-name]</source></p>
- <p>There's also some example code at
- <a class="externalLink" href="http://github.com/hammer/whirr-demo">
- http://github.com/hammer/whirr-demo</a>.</p>
</body>
</document>
Modified: whirr/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/src/site/xdoc/index.xml?rev=1163004&r1=1163003&r2=1163004&view=diff
==============================================================================
--- whirr/trunk/src/site/xdoc/index.xml (original)
+++ whirr/trunk/src/site/xdoc/index.xml Mon Aug 29 21:04:58 2011
@@ -20,10 +20,9 @@ xmlns:xsi="http://www.w3.org/2001/XMLSch
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties></properties>
<body>
-
- <section name="Apache Whirr"></section>
- <p>Apache Whirr is a set of libraries for running cloud services. Whirr is currently in the
- <a class="externalLink" href="http://incubator.apache.org/">Apache Incubator</a> .</p>
+
+ <section name="Apache Whirr 0.6.0"></section>
+ <p>Apache Whirr is a set of libraries for running cloud services.</p>
<p>Whirr provides:</p>
<ul>
<li>A cloud-neutral way to run services. You don't have to worry about the idiosyncrasies of
@@ -33,120 +32,15 @@ xsi:schemaLocation="http://maven.apache.
while still being able to override settings as needed.</li>
</ul>
<p>You can also use Whirr as a command line tool for deploying clusters.</p>
- <p>Find out more about Whirr at our
- <a class="externalLink" href="https://cwiki.apache.org/confluence/display/WHIRR">wiki</a> .</p>
-
+
<subsection name="Getting Started"></subsection>
- <p>You can use Whirr's CLI or APIs to
- <a href="quick-start-guide.html">get started with Whirr</a> .</p>
+ <p>Start with <a href="whirr-in-5-minutes.html">Whirr in 5 Minutes</a>
+ or the
+ <a href="quick-start-guide.html">Quick Start Guide</a>.</p>
<p>There is also an
- <a href="faq.html">FAQ</a> which covers how to achieve common tasks with Whirr, and a
+ <a href="http://whirr.apache.org/faq.html">FAQ</a> which covers how to achieve common tasks with Whirr, and a
<a href="configuration-guide.html">configuration guide</a> for reference.</p>
-
- <subsection name="Getting Involved"></subsection>
-
- <p>Have you got a suggestion for improving Whirr? It's easy to
- <a class="externalLink"
- href="https://cwiki.apache.org/confluence/display/WHIRR/How+To+Contribute">get
- involved</a> .</p>
-
- <subsection name="Which services and cloud providers are supported?"></subsection>
-
- <p>Whirr uses
- <a class="externalLink" href="http://code.google.com/p/jclouds/">jclouds</a> for provisioning,
- so in principle it should support all the cloud providers that jclouds supports. The following
- table shows the cloud provider and service combinations that have been tested.</p>
- <table align="center" border="0">
- <tr valign="top">
- <th align="center">
- <b>Cloud provider</b>
- </th>
- <th align="center">
- <b>Cassandra</b>
- </th>
- <th align="center">
- <b>Hadoop</b>
- </th>
- <th align="center">
- <b>ZooKeeper</b>
- </th>
- <th align="center">
- <b>HBase</b>
- </th>
- <th align="center">
- <b>elasticsearch</b>
- </th>
- <th align="center">
- <b>Voldemort</b>
- </th>
- <th align="center">
- <b>Hama</b>
- </th>
- </tr>
- <tr valign="top">
- <td align="center">Amazon EC2</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- </tr>
- <tr valign="top">
- <td align="center">Rackspace Cloud Servers</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- <td align="center">Yes</td>
- </tr>
- </table>
- <p>For development and local testing we are also supporting the BYON (bring your own nodes)
- jclouds provider. Check the
- <i>recipes</i> folder for a configuration sample.</p>
-
- <subsection name="What server operating systems are supported?"></subsection>
-
- <p>Each release is tested by running the integration tests on Ubuntu Server 10.04. All setup
- scripts should also work on Centos 5.x but we don't have a formal testing procedure in place
- right now.</p>
-
- <subsection name="Download"></subsection>
-
- <p>Download a release of Whirr from a
- <a class="externalLink" href="http://www.apache.org/dyn/closer.cgi/incubator/whirr/">nearby
- mirror</a> .</p>
-
- <subsection name="Known Limitations"></subsection>
-
- We are striving to make each release as good as possible but there are still a set of
- limitations that you should be aware of. The following issues are known to exist in the 0.6.0 release of Whirr.
-
- <ul>
- <li>The Hadoop namenode and the jobtracker must share the same machine. <a href="https://issues.apache.org/jira/browse/WHIRR-337">WHIRR-337</a></li>
- <li>The HBase thrift server can only run on a machine that it's also running a different HBase role like hbase-master or hbase-regionserver. <a href="https://issues.apache.org/jira/browse/WHIRR-342">WHIRR-342</a></li>
- <li>The "jclouds.aws-s3.endpoint" property is needed in order to use BlobCache with Amazon AWS in a region besides us-east-1. See <a href="https://issues.apache.org/jira/browse/WHIRR-349#comment-13084590">WHIRR-349</a> for more details</li>
- </ul>
-
- <subsection name="History"></subsection>
- <p>The code that would become Whirr started out in 2007 as some
- <a class="externalLink" href="https://issues.apache.org/jira/browse/HADOOP-884">bash scripts in
- Apache Hadoop</a> for running Hadoop clusters on EC2. Later the scripts were
- <a class="externalLink" href="https://issues.apache.org/jira/browse/WHIRR-3">ported to
- Python</a> for extra features (such as EBS support) and a wider range of cloud providers. These
- Python scripts are no longer supported, but can be found in the 0.5.0 release and the
- <i>contrib-python</i> SVN branch.</p>
- <p>In May 2010 the
- <a class="externalLink" href="http://incubator.apache.org/whirr">Apache Whirr
- Incubator</a> project was started to give a home to the existing work that had been done, but
- also to create a Java version using
- <a class="externalLink" href="http://code.google.com/p/jclouds/">jclouds</a> as the cloud
- provisioning library. jclouds supports many providers and has a very rich API for running code
- on instances, so it provides a very solid foundation for building Whirr on.</p>
</body>
</document>
Added: whirr/trunk/src/site/xdoc/known-limitations.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/src/site/xdoc/known-limitations.xml?rev=1163004&view=auto
==============================================================================
--- whirr/trunk/src/site/xdoc/known-limitations.xml (added)
+++ whirr/trunk/src/site/xdoc/known-limitations.xml Mon Aug 29 21:04:58 2011
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <body>
+ <section name="Know Limitations"></section>
+
+ <p>We are striving to make each release as good as possible but there are still a set of
+ limitations that you should be aware of. The following issues are known to exist in the 0.6.0 release of Whirr.</p>
+
+ <ul>
+ <li>The Hadoop namenode and the jobtracker must share the same machine. <a href="https://issues.apache.org/jira/browse/WHIRR-337">WHIRR-337</a></li>
+ <li>The HBase thrift server can only run on a machine that it's also running a different HBase role like hbase-master or hbase-regionserver. <a href="https://issues.apache.org/jira/browse/WHIRR-342">WHIRR-342</a></li>
+ <li>The "jclouds.aws-s3.endpoint" property is needed in order to use BlobCache with Amazon AWS in a region besides us-east-1. See <a href="https://issues.apache.org/jira/browse/WHIRR-349#comment-13084590">WHIRR-349</a> for more details</li>
+ </ul>
+
+ </body>
+</document>
Propchange: whirr/trunk/src/site/xdoc/known-limitations.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: whirr/trunk/src/site/xdoc/supported-services-and-clouds.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/src/site/xdoc/supported-services-and-clouds.xml?rev=1163004&view=auto
==============================================================================
--- whirr/trunk/src/site/xdoc/supported-services-and-clouds.xml (added)
+++ whirr/trunk/src/site/xdoc/supported-services-and-clouds.xml Mon Aug 29 21:04:58 2011
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <body>
+
+ <section name="Which Services and Cloud Providers Are Supported?"></section>
+
+ <p>Whirr uses
+ <a class="externalLink" href="http://code.google.com/p/jclouds/">jclouds</a> for provisioning,
+ so in principle it should support all the cloud providers that jclouds supports. The following
+ table shows the cloud provider and service combinations that have been tested.</p>
+ <table align="center" border="0">
+ <tr valign="top">
+ <th align="center">
+ <b>Cloud provider</b>
+ </th>
+ <th align="center">
+ <b>Cassandra</b>
+ </th>
+ <th align="center">
+ <b>Hadoop</b>
+ </th>
+ <th align="center">
+ <b>ZooKeeper</b>
+ </th>
+ <th align="center">
+ <b>HBase</b>
+ </th>
+ <th align="center">
+ <b>elasticsearch</b>
+ </th>
+ <th align="center">
+ <b>Voldemort</b>
+ </th>
+ <th align="center">
+ <b>Hama</b>
+ </th>
+ </tr>
+ <tr valign="top">
+ <td align="center">Amazon EC2</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ </tr>
+ <tr valign="top">
+ <td align="center">Rackspace Cloud Servers</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ <td align="center">Yes</td>
+ </tr>
+ </table>
+ <p>For development and local testing we are also supporting the BYON (bring your own nodes)
+ jclouds provider. Check the
+ <i>recipes</i> folder for a configuration sample.</p>
+
+ <subsection name="What server operating systems are supported?"></subsection>
+
+ <p>Each release is tested by running the integration tests on Ubuntu Server 10.04. All setup
+ scripts should also work on Centos 5.x but we don't have a formal testing procedure in place
+ right now.</p>
+ </body>
+</document>
Propchange: whirr/trunk/src/site/xdoc/supported-services-and-clouds.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: whirr/trunk/src/site/xdoc/whirr-in-5-minutes.xml
URL: http://svn.apache.org/viewvc/whirr/trunk/src/site/xdoc/whirr-in-5-minutes.xml?rev=1163004&r1=1163003&r2=1163004&view=diff
==============================================================================
--- whirr/trunk/src/site/xdoc/whirr-in-5-minutes.xml (original)
+++ whirr/trunk/src/site/xdoc/whirr-in-5-minutes.xml Mon Aug 29 21:04:58 2011
@@ -24,7 +24,7 @@ xsi:schemaLocation="http://maven.apache.
<p>The following commands install Whirr and start a 3 node ZooKeeper cluster on Amazon EC2 in 5
minutes or less. You need to have Java 6 and an SSH client already installed. Help on finding
your AWS credentials can be found in the
- <a href="faq.html#how-do-i-find-my-cloud-credentials">FAQ</a>.</p>
+ <a href="http://whirr.apache.org/faq.html#how-do-i-find-my-cloud-credentials">FAQ</a>.</p>
<source>
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...