install a default.catalog.bom, and update docs and tweak poms to exclude license since these are config files the user is meant to edit; remove the old catalog.xml, including mentions in the docs
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/5bd3de66 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/5bd3de66 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/5bd3de66 Branch: refs/heads/0.7.0-incubating Commit: 5bd3de6614f5445e2c730857da55e6fc1b23cc36 Parents: a898760 Author: Alex Heneveld <[email protected]> Authored: Wed May 6 15:00:39 2015 +0100 Committer: Alex Heneveld <[email protected]> Committed: Fri May 8 18:22:23 2015 +0100 ---------------------------------------------------------------------- docs/guide/ops/catalog/index.md | 15 +++++++++++++++ docs/guide/ops/install-on-server.md | 23 ++++++++--------------- docs/guide/start/blueprints.md | 13 +++++-------- docs/guide/start/catalog.xml | 22 ---------------------- 4 files changed, 28 insertions(+), 45 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5bd3de66/docs/guide/ops/catalog/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/catalog/index.md b/docs/guide/ops/catalog/index.md index dcedcd8..7cb0e84 100644 --- a/docs/guide/ops/catalog/index.md +++ b/docs/guide/ops/catalog/index.md @@ -8,6 +8,8 @@ children: - { section: Adding to the Catalog, title: Adding and Deleting } - { section: Templates and the Add-Application Wizard, title: Templates } - { section: Versioning } +- { section: CLI Options } + --- Brooklyn provides a **catalog**, which is a persisted collection of versioned blueprints and other resources. @@ -289,6 +291,19 @@ When referencing a blueprint, if a version number is not specified the latest non-snapshot version will be loaded when an entity is instantiated. +### CLI Options + +The `brooklyn` CLI includes several commands for working with the catalog. + +* `--catalogAdd <file.bom>` will add the catalog items in the `bom` file +* `--catalogReset` will reset the catalog to the initial state + (based on `brooklyn/default.catalog.bom` on the classpath, by default in a dist in the `conf/` directory) +* `--catalogInitial <file.bom>` will set the catalog items to use on first run, + on a catalog reset, or if persistence is off + +If [persistence](../persistence/) is enabled, catalog additions will remain between runs. +For more information on these commands, run `brooklyn help launch`. + <!-- TODO: make test cases from the code snippets here, and when building the docs assert that they match test cases http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5bd3de66/docs/guide/ops/install-on-server.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/install-on-server.md b/docs/guide/ops/install-on-server.md index d4711db..6c3455f 100644 --- a/docs/guide/ops/install-on-server.md +++ b/docs/guide/ops/install-on-server.md @@ -11,7 +11,7 @@ Here we present two *alternatives* to install Brooklyn: - [Manual installation](#manual) -## <a id="script"></a> Running the installation script +## <a id="script"></a> Running the Installation Script There is a simple bash script available to help with the installation process. @@ -32,16 +32,16 @@ $ ./brooklyn-install.sh -s -r <your-server-ip> {% endhighlight %} -## <a id="manual"></a> Manual installation +## <a id="manual"></a> Manual Installation 1. [Set up the prerequisites](#prerequisites) 1. [Download Brooklyn](#download) 1. [Configuring brooklyn.properties](#configuring-properties) -1. [Configuring catalog.xml](#configuring-catalog) +1. [Configuring default.catalog.bom](#configuring-catalog) 1. [Test the installation](#confirm) -### <a id="prerequisites"></a>Set up the prerequisites +### <a id="prerequisites"></a>Set up the Prerequisites Before installing Apache Brooklyn, it is recommented to configure the host as follows. @@ -105,21 +105,14 @@ $ chmod 600 ~/.brooklyn/brooklyn.properties You may need to edit `~/.brooklyn/brooklyn.properties` to ensure that brooklyn can access cloud locations for application deployment. -### <a id="configuring-catalog"></a>Configuring catalog.xml +### <a id="configuring-catalog"></a>Configuring the Catalog By default Brooklyn loads the catalog of available application components and services from -`~/.brooklyn/catalog.xml`. - -{% highlight bash %} -$ wget -O ~/.brooklyn/catalog.xml {{site.url_root}}{{site.path.website}}/quickstart/catalog.xml -{% endhighlight %} - -The `catalog.xml` is the application blueprint catalog. The above example file contains some blueprints which will be automatically downloaded from the web if you run them. - -You may need to edit `~/.brooklyn/catalog.xml` to update links to any resources for download. +`default.catalog.bom` on the classpath. The initial catalog is in `conf/brooklyn/` in the dist. +If you have a preferred catalog, simply replace that file. -### <a id="confirm"></a>Confirm installation +### <a id="confirm"></a>Confirm Installation We can do a quick test drive by launching Brooklyn: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5bd3de66/docs/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/blueprints.md b/docs/guide/start/blueprints.md index 9986178..5966b77 100644 --- a/docs/guide/start/blueprints.md +++ b/docs/guide/start/blueprints.md @@ -45,17 +45,14 @@ application. Your application will be shown as "Starting" on the web console's f Instead of pasting the YAML blueprint each time, this blueprint can be [added to the catalog](../ops/catalog/). -Or, even easier, you can download a sample [catalog.xml](catalog.xml). -Install this to your `~/.brooklyn/` folder and relaunch Brooklyn -(navigating to the "Help" tab in order to shutdown Brooklyn *and* the application you launched in the previous step). - -Now when the web console is re-opened, the catalog contains our blueprints. -Select the "Demo Web Cluster with DB" and click "Next". +With this YAML blueprint added, including the location, the Add Application dialog will offer +the "Demo Web Cluster with DB" as a template. [](images/add-application-catalog-web-cluster-with-db-large.png) -Select the location to use, give your application a name, and then click "Finish". - +<!-- TODO: more detail for adding to catalog? but wait for persistence to be the default, + rather than extensively document default.catalog.bom. + also need to include instructions on stopping (currently in help, including stopping apps) --> ## Next http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5bd3de66/docs/guide/start/catalog.xml ---------------------------------------------------------------------- diff --git a/docs/guide/start/catalog.xml b/docs/guide/start/catalog.xml deleted file mode 100644 index 6cff554..0000000 --- a/docs/guide/start/catalog.xml +++ /dev/null @@ -1,22 +0,0 @@ -<catalog> - <name>Brooklyn Demos</name> - - - <template type="brooklyn.demo.WebClusterDatabaseExample" name="Demo Web Cluster with DB"> - <description>Deploys a demonstration web application to a managed JBoss cluster with elasticity, persisting to a MySQL</description> - <iconUrl>http://downloads.cloudsoftcorp.com/brooklyn/catalog/logos/JBoss_by_Red_Hat.png</iconUrl> - </template> - - <template type="brooklyn.demo.GlobalWebFabricExample" name="Demo GeoDNS Web Fabric DB"> - <description>Deploys a demonstration web application to JBoss clusters around the world</description> - <iconUrl>http://downloads.cloudsoftcorp.com/brooklyn/catalog/logos/JBoss_by_Red_Hat.png</iconUrl> - </template> - - <classpath> - <entry>https://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=io.brooklyn.example&a=brooklyn-example-simple-web-cluster&v=0.7.0-SNAPSHOT&e=jar</entry> <!-- BROOKLYN_VERSION --> - <entry>https://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=io.brooklyn.example&a=brooklyn-example-global-web-fabric&v=0.7.0-SNAPSHOT&e=jar</entry> <!-- BROOKLYN_VERSION --> - </classpath> - - -</catalog> -
