You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2014/07/25 18:45:39 UTC
[2/8] git commit: Remove whirr docs
Remove whirr docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/b5ea764d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/b5ea764d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/b5ea764d
Branch: refs/heads/master
Commit: b5ea764d22f3faa5602a2c6e38711a255b7972c6
Parents: e5e0fd8
Author: Aled Sage <al...@gmail.com>
Authored: Mon Jul 21 17:47:31 2014 +0100
Committer: Aled Sage <al...@gmail.com>
Committed: Tue Jul 22 12:37:04 2014 +0100
----------------------------------------------------------------------
docs/dev/build/developers-catalog.xml | 3 -
docs/start/download.md | 2 +-
docs/start/index.include.md | 2 +-
docs/use/examples/whirrhadoop.md | 9 --
docs/use/examples/whirrhadoop/index.md | 7 --
.../examples/whirrhadoop/whirrhadoop-w750.png | Bin 144108 -> 0 bytes
.../examples/whirrhadoop/whirrhadoop.include.md | 124 -------------------
docs/use/examples/whirrhadoop/whirrhadoop.png | Bin 133771 -> 0 bytes
docs/use/guide/entities/index.md | 2 +-
9 files changed, 3 insertions(+), 146 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/dev/build/developers-catalog.xml
----------------------------------------------------------------------
diff --git a/docs/dev/build/developers-catalog.xml b/docs/dev/build/developers-catalog.xml
index 01993c3..03ea03c 100644
--- a/docs/dev/build/developers-catalog.xml
+++ b/docs/dev/build/developers-catalog.xml
@@ -91,14 +91,11 @@
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-simple-web-cluster/0.7.0-SNAPSHOT/brooklyn-example-simple-web-cluster-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-global-web-fabric/0.7.0-SNAPSHOT/brooklyn-example-global-web-fabric-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-global-web-fabric/0.7.0-SNAPSHOT/brooklyn-example-global-web-fabric-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
- <entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-hello-world-hadoop-webapp/0.7.0-SNAPSHOT/brooklyn-example-hello-world-hadoop-webapp-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-portable-cloudfoundry/0.7.0-SNAPSHOT/brooklyn-example-portable-cloudfoundry-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-simple-web-cluster/0.7.0-SNAPSHOT/brooklyn-example-simple-web-cluster-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
- <entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-hadoop-and-whirr/0.7.0-SNAPSHOT/brooklyn-example-hadoop-and-whirr-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.7.0-SNAPSHOT/brooklyn-example-hello-world-sql-webapp-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-simple-messaging-pubsub/0.7.0-SNAPSHOT/brooklyn-example-simple-messaging-pubsub-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-examples-parent/0.7.0-SNAPSHOT/brooklyn-examples-parent-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
- <entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-hello-world-hadoop-jar/0.7.0-SNAPSHOT/brooklyn-example-hello-world-hadoop-jar-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-hello-world-webapp/0.7.0-SNAPSHOT/brooklyn-example-hello-world-webapp-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-example-simple-nosql-cluster/0.7.0-SNAPSHOT/brooklyn-example-simple-nosql-cluster-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
<entry>file://~/.m2/repository/io/brooklyn/example/brooklyn-examples-webapps-parent/0.7.0-SNAPSHOT/brooklyn-examples-webapps-parent-0.7.0-SNAPSHOT.jar</entry> <!-- BROOKLYN_VERSION -->
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/start/download.md
----------------------------------------------------------------------
diff --git a/docs/start/download.md b/docs/start/download.md
index 9056e68..23c740c 100644
--- a/docs/start/download.md
+++ b/docs/start/download.md
@@ -132,7 +132,7 @@ If you use Maven, you can add Brooklyn with the following in your pom:
</dependencies>
{% endhighlight %}
-`brooklyn-all` (used above) brings in all dependencies, including jclouds and Apache Whirr.
+`brooklyn-all` (used above) brings in all dependencies, including jclouds.
If you prefer a smaller repo you might want just ``brooklyn-core``, ``brooklyn-policies``,
and some of ``brooklyn-software-webapp``, ``brooklyn-software-database``, ``brooklyn-software-messaging``, or others
(browse the full list [here]({{ this_anything_url_search }})).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/start/index.include.md
----------------------------------------------------------------------
diff --git a/docs/start/index.include.md b/docs/start/index.include.md
index d0dad1e..1406337 100644
--- a/docs/start/index.include.md
+++ b/docs/start/index.include.md
@@ -7,7 +7,7 @@ giving single-click deploy and adding the concepts of
manageable clusters and fabrics:
* many common software entities available out-of-the-box
-* integrates with [Apache Whirr](http://whirr.apache.org) -- and thereby Chef and Puppet --
+* integrates with [Apache Whirr](http://whirr.apache.org)
to deploy well-known services such as Hadoop and elasticsearch
(or use POBS, plain-old-bash-scripts)
* use PaaS's such as OpenShift, alongside self-built clusters, for maximum flexibility
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/use/examples/whirrhadoop.md
----------------------------------------------------------------------
diff --git a/docs/use/examples/whirrhadoop.md b/docs/use/examples/whirrhadoop.md
deleted file mode 100644
index d7d610f..0000000
--- a/docs/use/examples/whirrhadoop.md
+++ /dev/null
@@ -1,9 +0,0 @@
----
-layout: page
-title: Whirr Hadoop Cluster
-toc: /toc.json
----
-
-<!-- file kept to preserve old links; remove when link not used -->
-
-{% readj whirrhadoop/whirrhadoop.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/use/examples/whirrhadoop/index.md
----------------------------------------------------------------------
diff --git a/docs/use/examples/whirrhadoop/index.md b/docs/use/examples/whirrhadoop/index.md
deleted file mode 100644
index 644acd3..0000000
--- a/docs/use/examples/whirrhadoop/index.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: page
-title: Whirr Hadoop Cluster
-toc: /toc.json
----
-
-{% readj whirrhadoop.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/use/examples/whirrhadoop/whirrhadoop-w750.png
----------------------------------------------------------------------
diff --git a/docs/use/examples/whirrhadoop/whirrhadoop-w750.png b/docs/use/examples/whirrhadoop/whirrhadoop-w750.png
deleted file mode 100644
index 6c35d3e..0000000
Binary files a/docs/use/examples/whirrhadoop/whirrhadoop-w750.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/use/examples/whirrhadoop/whirrhadoop.include.md
----------------------------------------------------------------------
diff --git a/docs/use/examples/whirrhadoop/whirrhadoop.include.md b/docs/use/examples/whirrhadoop/whirrhadoop.include.md
deleted file mode 100644
index fa54bfb..0000000
--- a/docs/use/examples/whirrhadoop/whirrhadoop.include.md
+++ /dev/null
@@ -1,124 +0,0 @@
-{% readj ../before-begin.include.md %}
-
-Now, go to this particular example's directory:
-
-{% highlight bash %}
-% cd hadoop-and-whirr
-{% endhighlight %}
-
-The CLI needs to know where to find your compiled examples. You can set this up by exporting
-the ``BROOKLYN_CLASSPATH`` environment variable in the following way:
-
-{% highlight bash %}
-% export BROOKLYN_CLASSPATH=$(pwd)/target/classes
-{% endhighlight %}
-
-The project ``hadoop-and-whirr`` includes deployment descriptors
-showing how to provision Whirr-based clusters from Brooklyn,
-including setting up a Hadoop recipe.
-
-## Background
-
-[Apache Whirr](http://whirr.apache.org) is an open-source project providing
-a set of libraries for launching cloud services in an easy, repeatable, and reliable way.
-
-Brooklyn can use Whirr to launch a wide variety of services
-and integrate them as part of bespoke applications.
-
-
-## Whirr Hadoop
-
-The class ``WhirrHadoopExample`` shows how a Hadoop cluster can be started
-with an arbitrary size, using the ``WhirrHadoopCluster`` entity.
-
-{% highlight java %}
-public class WhirrHadoopExample extends AbstractApplication {
- @Override
- public void init() {
- WhirrCluster cluster = addChild(EntitySpec.create(WhirrHadoopCluster.class)
- .configure("size", 2)
- .configure("memory", 2048));
- }
-}
-{% endhighlight %}
-
-You can run this by running:
-
-{% highlight bash %}
-% ${BROOKLYN_HOME}/bin/brooklyn launch --app brooklyn.extras.whirr.WhirrHadoopExample --stopOnKeyPress --location aws-ec2:eu-west-1
-{% endhighlight %}
-
-This targets ``aws-ec2:eu-west-1`` (using jclouds),
-so you will need to set your AWS credentials as described [here]({{site.url}}/use/guide/management/index.html#startup-config).
-
-[](whirrhadoop.png)
-
-Once it is running, navigate to the Brooklyn web console to see the ``NAME_NODE_URL`` sensor.
-(And note that using [``attributeWhenReady``]({{ site.url }}/use/guide/defining-applications/advanced-concepts.html#dependent),
-you can easily configure a larger application to use its own dedicated Hadoop cluster.)
-
-
-<a name="custom-whirr-recipe"></a>
-## Custom Whirr Recipe
-
-The class ``WhirrExample`` shows how an arbitrary [Whirr](http://whirr.apache.org) recipe
-can be run from within Brooklyn:
-
-{% highlight java %}
-public class WhirrExample extends AbstractApplication {
- public static final String RECIPE =
- "whirr.cluster-name=brooklyn-whirr"+"\n"+
- "whirr.hardware-min-ram=1024"+"\n"+
- "whirr.instance-templates=1 noop, 1 elasticsearch"+"\n";
-
- @Override
- public void init() {
- WhirrCluster cluster = addChild(EntitySpec.create(WhirrCluster.class)
- .configure("recipe", RECIPE));
- }
-}
-{% endhighlight %}
-
-As this example uses elasticsearch, the elasticsearch jar will need to be added to the classpath. If you are using elasticsearch in your own project, you will also need to add it as a dependency in your pom.xml. For an example see the brooklyn-examples/hadoop-and-whirr/pom.xml
-
-{% highlight bash %}
-% export BROOKLYN_CLASSPATH=~/.m2/repository/org/apache/whirr/whirr-elasticsearch/0.8.1/whirr-elasticsearch-0.8.1.jar:$BROOKLYN_CLASSPATH
-{% endhighlight %}
-
-This can be launched by running:
-
-{% highlight bash %}
-% ${BROOKLYN_HOME}/bin/brooklyn launch --app brooklyn.extras.whirr.WhirrExample --stopOnKeyPress --location aws-ec2:eu-west-1
-{% endhighlight %}
-
-In the provided example this will deploy to AWS.
-
-If you would like to deploy to localhost, you can do this by running the same command and replacing ``aws-ec2:eu-west-1`` with ``localhost``. However, please note that currently there are some limitations when deploying to localhost:
-
-* You can not deploy more than one server (noop doesn't count in the above case).
-* This has only been tested on Ubuntu 10.04 and might cause problems on other operating systems.
-* Your user will need to be configured for [passwordless ssh and passwordless sudo](http://docs.outerthought.org/lilyenterprise-docs-trunk/539-lily/541-lily.html) on localhost.
-
-
-Feel free to experiment with the instance template parameter,
-trying out other recipes from Whirr.
-
-With this mechanism, you can roll out Whirr-supported systems,
-ranging from Cassandra to Voldemort, including integrating
-Chef and Puppet scripts you may wish to use.
-The Whirr state is loaded into Brooklyn, as well as saved to disk in the usual Whirr way.
-This means it is available for programmatic extensions (as is used for Hadoop),
-including defining sensors and effectors and applying policy:
-stop is available, with [resize](https://issues.apache.org/jira/browse/WHIRR-214) expected soon
-(making it easy -- or at least much easier -- to write custom **elasticity policies**).
-
-
-## Integrating with Other Entities
-
-The real interest of Brooklyn working with Whirr, of course, is to combine systems such as Hadoop
-with your custom applications which use these systems.
-One example, combining the [Global Web Fabric example]({{ site.url }}/use/examples/global-web-fabric)
-with the Whirr Hadoop entity, is included in this example project.
-A Hadoop-based chatroom web app, performing map-reduce (and a few necessary contortions to work with private subnets)
-is in ``WebFabricWithHadoopExample``.
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/use/examples/whirrhadoop/whirrhadoop.png
----------------------------------------------------------------------
diff --git a/docs/use/examples/whirrhadoop/whirrhadoop.png b/docs/use/examples/whirrhadoop/whirrhadoop.png
deleted file mode 100644
index 9d6cd5e..0000000
Binary files a/docs/use/examples/whirrhadoop/whirrhadoop.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5ea764d/docs/use/guide/entities/index.md
----------------------------------------------------------------------
diff --git a/docs/use/guide/entities/index.md b/docs/use/guide/entities/index.md
index 40339bc..54ea317 100644
--- a/docs/use/guide/entities/index.md
+++ b/docs/use/guide/entities/index.md
@@ -123,7 +123,7 @@ In the implementations of ``JavaWebApp`` entities, the behaviour which the entit
Routines which are convenient for specific drivers can then be inherited in the driver class hierarchy. For example, when passing JMX environment variables to Java over SSH, ``JavaSoftwareProcessSshDriver`` extends ``AbstractSoftwareProcessSshDriver`` and parents ``JBoss7SshDriver``.
<!---
-TODO more drivers such as whirr, jmx, etc are planned
+TODO more drivers such as jmx, etc are planned
-->
<a name="testing"></a>