http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/18c248c5/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/guide/start/blueprints.md b/guide/start/blueprints.md index 959b5be..8da9fc5 100644 --- a/guide/start/blueprints.md +++ b/guide/start/blueprints.md @@ -3,7 +3,7 @@ title: Deploying Blueprints layout: website-normal --- -Blueprints are descriptors or patterns which describe how Apache Brooklyn should deploy applications. Blueprints are written in [YAML](https://en.wikipedia.org/wiki/YAML){:target="_blank"} and many of the entities available are defined in the __[Brooklyn Catalog]({{ site.path.website }}/learnmore/catalog/)__. +Blueprints are descriptors or patterns which describe how Apache Brooklyn should deploy applications. Blueprints are written in [YAML](https://en.wikipedia.org/wiki/YAML){:target="_blank"} and many of the entities available are defined in the __[Brooklyn Catalog]({{ book.path.website }}/learnmore/catalog/)__. ## Launching from a Blueprint @@ -12,13 +12,13 @@ We'll start by deploying an application with a simple YAML blueprint containing Copy the blueprint below into a text file, "myapp.yaml", in your workspace (Note, to copy the file you can hover your mouse over the right side of the text box below to get a Javascript "copy" button). -{% highlight yaml %} +```yaml name: Tomcat services: - type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer name: tomcatServer location: <your-location-definition-goes-here> -{% endhighlight %} +``` ## Locations @@ -42,13 +42,13 @@ The Vagrant configuration described in [Running Apache Brooklyn](./running.html) These can be launched by entering the following command into the terminal in the vagrant configuration directory. -{% highlight bash %} +```bash $ vagrant up byon1 byon2 byon3 byon4 -{% endhighlight %} +``` The location in "myapp.yaml" can now be replaced with the following YAML to launch using these vagrant servers. -{% highlight yaml %} +```yaml location: byon: user: vagrant @@ -58,30 +58,30 @@ location: - 10.10.10.102 - 10.10.10.103 - 10.10.10.104 -{% endhighlight %} +``` </div> <div id="impl-2" class="tab-pane fade"> -Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/){:target="_blank"} to support a range of cloud locations. More information on the range of providers and configurations is available [here]({{ site.path.guide }}/locations/#clouds){:target="_blank"}. +Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/){:target="_blank"} to support a range of cloud locations. More information on the range of providers and configurations is available [here]({{ book.path.guide }}/locations/#clouds){:target="_blank"}. As an example, here is a configuration for [Amazon Web Services (AWS)](http://www.aws.amazon.com){:target="_blank"}. Swap the identity and credential with your AWS account details, then replace the location in your "myapp.yaml" with this. -{% highlight yaml %} +```yaml location: jclouds:aws-ec2: identity: ABCDEFGHIJKLMNOPQRST credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l -{% endhighlight %} +``` </div> <div id="impl-3" class="tab-pane fade"> -The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here]({{ site.path.guide }}/locations/#byon){:target="_blank"}. +The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here]({{ book.path.guide }}/locations/#byon){:target="_blank"}. Replace the hosts, user and password in the example below with your own server details, then replace the location in your "myapp.yaml" with this. -{% highlight yaml %} +```yaml location: byon: user: myuser @@ -91,30 +91,30 @@ location: hosts: - 192.168.0.18 - 192.168.0.19 -{% endhighlight %} +``` </div> </div> --- -**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see __[Locations]({{ site.path.guide }}/locations)__ in the Operations section of the User Guide. +**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see __[Locations]({{ book.path.guide }}/locations)__ in the Operations section of the User Guide. ## Deploying the Application First, log in to brooklyn with the command line interface (CLI) tool by typing: -{% highlight bash %} +```bash $ br login http://localhost:8081/ -{% endhighlight %} +``` -To secure the Apache Brooklyn instance, you can add a username and password to Brooklyn's properties file, as described in the User Guide [here]({{ site.path.guide }}/ops/configuration/brooklyn_cfg.html){:target="_blank"}. +To secure the Apache Brooklyn instance, you can add a username and password to Brooklyn's properties file, as described in the User Guide [here]({{ book.path.guide }}/ops/configuration/brooklyn_cfg.html){:target="_blank"}. If this is configured, the login command will require an additional parameter for the userid and will then prompt for a password. Now you can create the application with the command below: -{% highlight bash %} +```bash $ br deploy myapp.yaml -{% endhighlight %} +``` <pre> Id: hTPAF19s Name: Tomcat
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/18c248c5/guide/start/concept-quickstart.md ---------------------------------------------------------------------- diff --git a/guide/start/concept-quickstart.md b/guide/start/concept-quickstart.md index 3f04557..2938e3c 100644 --- a/guide/start/concept-quickstart.md +++ b/guide/start/concept-quickstart.md @@ -4,7 +4,7 @@ layout: website-normal menu_parent: index.md --- -The following section provides a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For further discussion of these concepts see [The Theory Behind Brooklyn]({{site.path.website}}/learnmore/theory.html), and the detailed descriptions in [Brooklyn Concepts]({{site.path.guide}}/concepts/). +The following section provides a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For further discussion of these concepts see [The Theory Behind Brooklyn]({{book.path.website}}/learnmore/theory.html), and the detailed descriptions in [Brooklyn Concepts]({{book.path.guide}}/concepts/). ***Deployment and Management*** Brooklyn is built for agile deployment of applications across cloud and other targets, and real-time autonomic management. "Autonomic computing" is the concept of components looking after themselves where possible (self-healing, self-optimizing, etc). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/18c248c5/guide/start/index.md ---------------------------------------------------------------------- diff --git a/guide/start/index.md b/guide/start/index.md index aa14f22..9da9d83 100644 --- a/guide/start/index.md +++ b/guide/start/index.md @@ -10,6 +10,6 @@ children: - concept-quickstart.md --- -{% include list-children.html %} + http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/18c248c5/guide/start/managing.md ---------------------------------------------------------------------- diff --git a/guide/start/managing.md b/guide/start/managing.md index c1f432e..623997b 100644 --- a/guide/start/managing.md +++ b/guide/start/managing.md @@ -19,9 +19,9 @@ the beginning. Next we will outline how to *manage* the application that has bee ## Applications Having created the application, we can find a summary of all deployed applications using: -{% highlight bash %} +```bash $ br application -{% endhighlight %} +``` <pre> Id Name Status Location @@ -29,15 +29,15 @@ $ br application </pre> ```application``` can be shortened to the alias ```app```, for example: -{% highlight bash %} +```bash $ br app -{% endhighlight %} +``` <pre> Id Name Status Location hTPAF19s Tomcat RUNNING ajVVAhER </pre> -A full list of abbreviations such as this can be found in the [CLI reference guide]({{ site.path.guide }}/ops/cli/cli-ref-guide.html#abbreviations){:target="_blank"}. +A full list of abbreviations such as this can be found in the [CLI reference guide]({{ book.path.guide }}/ops/cli/cli-ref-guide.html#abbreviations){:target="_blank"}. In the above example the Id `hTPAF19s` and the Name `Tomcat` are shown. You can use either of these handles to monitor and control the application. The Id shown for your application will be different to this but the name should be the same, note that if you are running multiple applications the Name may not be unique. @@ -55,9 +55,9 @@ In the above example the Id `hTPAF19s` and the Name `Tomcat` are shown. You can <p> Using the name `Tomcat` we can get the application details: </p> -{% highlight bash %} +```bash $ br application Tomcat -{% endhighlight %} +``` <pre> Id: hTPAF19s Name: Tomcat @@ -84,9 +84,9 @@ $ br application Tomcat <p> We can explore the management hierarchy of all applications, which will show us the entities they are composed of. </p> -{% highlight bash %} +```bash $ br tree -{% endhighlight %} +``` <pre> |- Tomcat +- org.apache.brooklyn.entity.stock.BasicApplication @@ -107,9 +107,9 @@ $ br tree <p> You can view the blueprint for the application again: </p> -{% highlight bash %} +```bash $ br application Tomcat spec -{% endhighlight %} +``` <pre> "name: Tomcat\nlocation:\n mylocation\nservices:\n- serviceType: brooklyn.entity.webapp.tomcat.TomcatServer\n" </pre> </div> @@ -126,9 +126,9 @@ $ br application Tomcat spec <p> You can view the configuration of the application: </p> -{% highlight bash %} +```bash $ br application Tomcat config -{% endhighlight %} +``` <pre> Key Value camp.template.id l67i25CM @@ -141,13 +141,13 @@ brooklyn.wrapper_app true ## Entities -An *Entity* is Apache Brooklyn's representation of a software package or service which it can control or interact with. All of the entities Apache Brooklyn can use are listed in the __[Brooklyn Catalog]({{ site.path.website }}/learnmore/catalog/)__. +An *Entity* is Apache Brooklyn's representation of a software package or service which it can control or interact with. All of the entities Apache Brooklyn can use are listed in the __[Brooklyn Catalog]({{ book.path.website }}/learnmore/catalog/)__. To list the entities of the application you can use the `entity` or `ent` command: -{% highlight bash %} +```bash $ br application Tomcat entity -{% endhighlight %} +``` <pre> Id Name Type Wx7r1C4e tomcatServer org.apache.brooklyn.entity.webapp.tomcat.TomcatServer @@ -157,9 +157,9 @@ This shows one entity is available: `tomcatServer`. Note that this is the name w You can get summary information for this entity by providing its name (or ID). -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer -{% endhighlight %} +``` <pre> Id: Wx7r1C4e Name: tomcatServer @@ -171,9 +171,9 @@ CatalogItemId: null Also you can see the configuration of this entity with the ```config``` command. -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer config -{% endhighlight %} +``` <pre> Key Value jmx.agent.mode JMXMP_AND_RMI @@ -190,9 +190,9 @@ install.unique_label TomcatServer_7.0.65 You can view the sensors available on the application using: -{% highlight bash %} +```bash $ br application Tomcat sensor -{% endhighlight %} +``` <pre> Name Description Value service.isUp Whether the service is active and availability (confirmed and monitored) true @@ -204,9 +204,9 @@ service.state.expected Last controlled change to service state, indicating w To explore sensors on a specific entity use the `sensor` command with an entity specified: -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer sensor -{% endhighlight %} +``` <pre> Name Description Value download.addon.urls URL patterns for downloading named add-ons (will substitute things like ${version} automatically) @@ -223,9 +223,9 @@ host.subnet.hostname Host name as known internally in the subnet where it is run To display the value of a selected sensor, give the command the sensor name as an argument -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer sensor webapp.url -{% endhighlight %} +``` <pre> "http://10.10.10.101:8080/"; </pre> @@ -235,9 +235,9 @@ $ br application Tomcat entity tomcatServer sensor webapp.url Effectors are a means by which you can manipulate the entities in an application. You can list the available effectors for your application using: -{% highlight bash %} +```bash $ br application Tomcat effector -{% endhighlight %} +``` <pre> Name Description Parameters restart Restart the process/service represented by an entity @@ -250,9 +250,9 @@ Note that the three "lifecycle" related effectors, ```start```, ```stop```, and You can list the effectors for a specific entity using the command: -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer effector -{% endhighlight %} +``` <pre> Name Description Parameters deploy Deploys the given artifact, from a source URL, to a given deployment filename/context url,targetName @@ -265,9 +265,9 @@ undeploy Undeploys the given context/artifact To view the details for a specific effector, append it's name to the command: -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer effector deploy -{% endhighlight %} +``` <pre> Name Description Parameters deploy Deploys the given artifact, from a source URL, to a given deployment filename/context url,targetName @@ -280,11 +280,11 @@ These parameters can be supplied using ```--param parm=value``` or just ```-P pa The commands below deploy the Apache Tomcat [hello world example](http://tomcat.apache.org/tomcat-6.0-doc/appdev/index.html){:target="_blank"} to our Tomcat Server. In these commands, a variable is created for the root URL using the appropriate sensor and the index page html is displayed. -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer effector deploy invoke -P url=https://tomcat.apache.org/tomcat-6.0-doc/appdev/sample/sample.war -P targetName=sample $ webapp=$(br application Tomcat entity tomcatServer sensor webapp.url | tr -d '"') $ curl $webapp/sample/ -{% endhighlight %} +``` <html> <head> <title>Sample "Hello, World" Application</title> @@ -299,9 +299,9 @@ $ curl $webapp/sample/ To view a list of all activities associated with an entity enter: -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer activity -{% endhighlight %} +``` <pre> Id Task Submitted Status Streams LtD5P1cb start Thu Dec 17 15:04:43 GMT 2015 Completed @@ -314,9 +314,9 @@ jwwcJWmF start (processes) Thu Dec 17 15:04:43 GMT 20 To view the details of an individual activity, add its ID to the command. In our case this is `jwwcJWmF` -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer activity jwwcJWmF -{% endhighlight %} +``` <pre> Id: jwwcJWmF DisplayName: start (processes) @@ -353,9 +353,9 @@ If an activity has associated input and output streams, these may be viewed by p using the commands, "env", "stdin", "stdout", and "stderr". For example, for the "initializing on-box base dir" activity from the result of the earlier example, </p> -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer act KLTxDkoa stdout -{% endhighlight %} +``` <pre> BASE_DIR_RESULT:/home/vagrant/brooklyn-managed-processes:BASE_DIR_RESULT </pre> @@ -374,18 +374,18 @@ BASE_DIR_RESULT:/home/vagrant/brooklyn-managed-processes:BASE_DIR_RESULT <p> To monitor progress on an application as it deploys, for example, one could use a shell loop: </p> -{% highlight bash %} +```bash $ while br application Tomcat entity tomcatServer activity | grep 'In progress' ; do sleep 1; echo ; date; done -{% endhighlight %} +``` <p> This loop will exit when the application has deployed successfully or has failed. If it fails then the 'stderr' command may provide information about what happened in any activities that have associated streams: </p> -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer act KLTxDkoa stderr -{% endhighlight %} +``` </div> </div> @@ -402,9 +402,9 @@ $ br application Tomcat entity tomcatServer act KLTxDkoa stderr <p> If an activity has failed, the "DetailedStatus" value will help us diagnose what went wrong by showing information about the failure. </p> -{% highlight bash %} +```bash $ br application evHUlq0n entity tomcatServer activity lZZ9x662 -{% endhighlight %} +``` <pre> Id: lZZ9x662 DisplayName: post-start @@ -438,9 +438,9 @@ java.lang.IllegalStateException: Software process entity TomcatServerImpl{id=qZe Adding the "--children" or "-c" parameter will show the activity's child activities, to allow the hierarchical structure of the activities to be investigated: </p> -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer activity -c jwwcJWmF -{% endhighlight %} +``` <pre> Id Task Submitted Status UpYRc3fw copy-pre-install-resources Thu Dec 17 15:04:43 GMT 2015 Completed @@ -481,9 +481,9 @@ as follows (values in brackets are aliases for the scope): Selects an activity of an entity e.g. ```br a myapp e myserver act iHG7sq1``` For example -{% highlight bash %} +```bash $ br application Tomcat entity tomcatServer config -{% endhighlight %} +``` runs the ```config``` command with application scope of ```Tomcat``` and entity scope of ```tomcatServer```. {:/comment} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/18c248c5/guide/start/policies.md ---------------------------------------------------------------------- diff --git a/guide/start/policies.md b/guide/start/policies.md index f26b4e5..3b27198 100644 --- a/guide/start/policies.md +++ b/guide/start/policies.md @@ -17,7 +17,7 @@ You will need four machines for this example: one for the load-balancer (nginx), Tomcat cluster (but you can reduce this by changing the `maxPoolSize` below). <div class="usermanual-pdf-include started-pdf-include" style="display: none;"> -{% highlight yaml %} +```yaml name: Tomcat Cluster location: @@ -77,7 +77,7 @@ services: brooklyn.config: loadbalancer.serverpool: $brooklyn:entity("cluster") nginx.sticky: false -{% endhighlight %} +``` </div> <!-- WARNING: if modifying either mycluster.yaml or the yaml below, be sure to keep them both in-sync --> @@ -253,10 +253,6 @@ services: <script language="JavaScript" type="application/javascript"> -{% comment %} -See blueprint-tour.md for where this CSS/javascript was copied from. -{% endcomment %} - if (window.$ != null) { $(function() { maxCodeWidth = Math.max.apply(Math, $(".annotated_blueprint div.block > div:last-child").map(function(){ return this.scrollWidth; }).get()); @@ -275,7 +271,7 @@ if (window.$ != null) { }); } </script> - +``` ## The Tomcat Cluster @@ -288,9 +284,9 @@ in the cluster. In our example, each is a Tomcat server with a WAR deployed at t Deploy the app: -{% highlight bash %} +```bash br deploy mycluster.yaml -{% endhighlight %} +``` <pre> Id: nGY58ZZN @@ -300,9 +296,9 @@ br deploy mycluster.yaml And wait for the app to be running, viewing its state with: -{% highlight bash %} +```bash br application -{% endhighlight %} +``` <pre> Id Name Status Location @@ -313,9 +309,9 @@ You can view the list of entities within the cluster with the command below (whi application named "Tomcat Cluster", then into its child entity named "Cluster", and then lists its entities): -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity -{% endhighlight %} +``` <pre> Id Name Type @@ -353,19 +349,19 @@ service entity is marked as failed and no futher restarts are attempted. Try killing the Tomcat process for one of the members in the cluster. The command below will kill Tomcat on the vagrant VMs named "byon1" to "byon4": -{% highlight bash %} +```bash for i in byon{1..4}; do vagrant ssh ${i} --command 'ps aux | grep -i tomcat | grep -v grep | awk '\''{print $2}'\'' | xargs kill -9' done -{% endhighlight %} +``` You can view the state of the Tomcat server with the command below (which drills into the application named "Tomcat Cluster", then into its child entity named "Cluster", and then into the first member of the cluster named "Tomcat Server"): -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity "Tomcat Server" -{% endhighlight %} +``` <pre> Id: tOpMeYYr @@ -379,9 +375,9 @@ br application "Tomcat Cluster" entity "Cluster" entity "Tomcat Server" <!-- COMMENT: You can view its activity, to see the call to restart, using: -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity "Tomcat Server" activity -{% endhighlight %} +``` TODO Why doesn't the restart() show in the activity view?! --> @@ -404,9 +400,9 @@ You can view the list of Tomcat servers in the cluster with the command below (w application named "Tomcat Cluster", then into its child entity named "Cluster", and then lists the child entities): -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity -{% endhighlight %} +``` <pre> Id Name Type @@ -434,7 +430,7 @@ To generate load, you can use your web-browser by repeatedly refreshing that pag you could use a load generator like jmeter, or use a script such as the one shown below (changing URL for the URL of your load-balancer): -{% highlight bash %} +```bash URL=http://10.10.10.101:8000/ for i in {1..600}; do for j in {1..50}; do @@ -443,14 +439,14 @@ for i in {1..600}; do echo "Finished batch $i" sleep 1 done -{% endhighlight %} +``` While those curl commands run in a separate terminal, you can look at the metrics for the first Tomcat server using the command: -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity "Tomcat Server" sensor -{% endhighlight %} +``` <pre> Name Description Value @@ -469,9 +465,9 @@ br application "Tomcat Cluster" entity "Cluster" entity "Tomcat Server" sensor You can look at the average requests per second on the cluster with the command: -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" sensor "webapp.reqs.perSec.perNode" -{% endhighlight %} +``` <pre> 25.765557404326124 @@ -480,9 +476,9 @@ br application "Tomcat Cluster" entity "Cluster" sensor "webapp.reqs.perSec.perN When this value exceeds 3 for two seconds, the cluster with scale up. You can see the new instance using the command: -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity -{% endhighlight %} +``` <pre> Id Name Type @@ -495,9 +491,9 @@ br application "Tomcat Cluster" entity "Cluster" entity Cancel the curl commands (or wait for them to finish), and then wait for the one minute `resizeDownStabilizationDelay`. The cluster will scale back to the minimum one instance. -{% highlight bash %} +```bash br application "Tomcat Cluster" entity "Cluster" entity -{% endhighlight %} +``` <pre> Id Name Type http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/18c248c5/guide/start/running.md ---------------------------------------------------------------------- diff --git a/guide/start/running.md b/guide/start/running.md index 7298ec3..5816ad7 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -37,18 +37,20 @@ Firstly, download and install: * [Vagrant](https://www.vagrantup.com/downloads.html){:target="_blank"} * [Oracle VirtualBox](https://www.virtualbox.org/wiki/Downloads){:target="_blank"} -Then download the provided Apache Brooklyn vagrant configuration from {% if site.brooklyn-version contains 'SNAPSHOT' %} -[here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-vagrant&v={{site.brooklyn-version}}&c=dist&e=zip){:target="_blank"}. +Then download the provided Apache Brooklyn vagrant configuration from +{% if book.brooklyn-version %} + [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-vagrant&v={{book.brooklyn-version}}&c=dist&e=zip). {% else %} -[here](https://www.apache.org/dyn/closer.lua?action=download&filename=brooklyn/apache-brooklyn-{{site.brooklyn-version}}/apache-brooklyn-{{site.brooklyn-version}}-vagrant.tar.gz){:target="_blank"}. -{% endif %} This archive contains everything you need to create an environment for use with this guide, providing an Apache Brooklyn instance and some blank VMs. + [here](https://www.apache.org/dyn/closer.lua?action=download&filename=brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-vagrant.tar.gz). +{% endif %} +This archive contains everything you need to create an environment for use with this guide, providing an Apache Brooklyn instance and some blank VMs. -Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{site.brooklyn-version}}-vagrant` folder {% if site.brooklyn-version contains 'SNAPSHOT' %}(note: as this is a -SNAPSHOT version, your filename will be slightly different){% endif %} +Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{book.brooklyn-version}}-vagrant` folder {% if book.brooklyn-version %}(note: as this is a -SNAPSHOT version, your filename will be slightly different){% endif %} -{% highlight bash %} -$ tar xvf apache-brooklyn-{{site.brooklyn-version}}-vagrant.tar.gz -$ cd apache-brooklyn-{{site.brooklyn-version}}-vagrant -{% endhighlight %} +```bash +$ tar xvf apache-brooklyn-{{book.brooklyn-version}}-vagrant.tar.gz +$ cd apache-brooklyn-{{book.brooklyn-version}}-vagrant +``` </div> @@ -56,23 +58,23 @@ $ cd apache-brooklyn-{{site.brooklyn-version}}-vagrant <strong class="hidden started-pdf-include">b) Centos / RHEL 7</strong> -{% if site.brooklyn-version contains 'SNAPSHOT' %}<strong>Please note, an RPM is not available for snapshot builds</strong>{% endif %} +{% if book.brooklyn-version %}<strong>Please note, an RPM is not available for snapshot builds</strong>{% endif %} For Centos 7 and RHEL 7 users, the recommended way to install Apache Brooklyn on RPM-based Linux distributions is by using the RPM package. RPM is the de facto standard for packaging software on these Linux distributions and provides a mechanism for installing, upgrading and removing packages such as Apache Brooklyn. The RPM package contains all the necessary files associated with the Apache Brooklyn application. -{% if site.brooklyn-version contains 'SNAPSHOT' %} -This is a snapshot build and no RPM is available, please download [a different version]({{site.path.website}}/download/). +{% if book.brooklyn-version %} +This is a snapshot build and no RPM is available, please download [a different version]({{book.path.website}}/download/). {% else %} -Download the Apache Brooklyn [RPM distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{site.brooklyn-version}}/apache-brooklyn-{{site.brooklyn-version}}-1.noarch.rpm){:target="_blank"}. +Download the Apache Brooklyn [RPM distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-1.noarch.rpm){:target="_blank"}. {% endif %} Once downloaded, run the following shell command as root: -{% highlight bash %} -$ yum install apache-brooklyn-{{site.brooklyn-version}}-1.rpm -{% endhighlight %} +```bash +$ yum install apache-brooklyn-{{book.brooklyn-version}}-1.rpm +``` </div> <div id="impl-3" class="tab-pane fade"> @@ -83,41 +85,41 @@ For Ubuntu and Debian users, the recommended way to install Apache Brooklyn is t The deb file is the de facto standard for packaging software on these Linux distributions and provides a mechanism for installing, upgrading and removing packages such as Apache Brooklyn. The deb package contains all the necessary files associated with the Apache Brooklyn application. -{% if site.brooklyn-version contains 'SNAPSHOT' %} -Download the Apache Brooklyn [deb distribution](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=deb-packaging&v={{site.brooklyn-version}}&e=deb){:target="_blank"}. +{% if book.brooklyn-version %} +Download the Apache Brooklyn [deb distribution](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=deb-packaging&v={{book.brooklyn-version}}&e=deb){:target="_blank"}. {% else %} -Download the Apache Brooklyn [deb distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn_{{site.brooklyn-version}}_noarch.deb){:target="_blank"}. +Download the Apache Brooklyn [deb distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn_{{book.brooklyn-version}}_noarch.deb){:target="_blank"}. {% endif %} Once downloaded, run the following shell command: -{% highlight bash %} -$ sudo dpkg -i apache-brooklyn_{{site.brooklyn-version}}_noarch.deb -{% endhighlight %} +```bash +$ sudo dpkg -i apache-brooklyn_{{book.brooklyn-version}}_noarch.deb +``` </div> <div id="impl-4" class="tab-pane fade"> <strong class="hidden started-pdf-include">d) OSX / Linux</strong> -For Linux or OSX please download the Apache Brooklyn `tar.gz` archive from the [download]({{site.path.website}}/download/){:target="_blank"} section. +For Linux or OSX please download the Apache Brooklyn `tar.gz` archive from the [download]({{book.path.website}}/download/){:target="_blank"} section. -{% if site.brooklyn-version contains 'SNAPSHOT' %} +{% if book.brooklyn-version %} Extract the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different): {% else %} -Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{ site.brooklyn-version }}` folder. +Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{ book.brooklyn-version }}` folder. {% endif %} -{% if site.brooklyn-version contains 'SNAPSHOT' %} -{% highlight bash %} -$ tar -zxf apache-brooklyn-dist-{{ site.brooklyn-version }}-timestamp-dist.tar.gz -$ cd apache-brooklyn-{{ site.brooklyn.version }} -{% endhighlight %} +{% if book.brooklyn-version %} +```bash +$ tar -zxf apache-brooklyn-dist-{{ book.brooklyn-version }}-timestamp-dist.tar.gz +$ cd apache-brooklyn-{{ book.brooklyn.version }} +``` {% else %} -{% highlight bash %} -$ tar -zxf apache-brooklyn-{{ site.brooklyn-version }}-dist.tar.gz -$ cd apache-brooklyn-{{ site.brooklyn.version }} -{% endhighlight %} +```bash +$ tar -zxf apache-brooklyn-{{ book.brooklyn-version }}-dist.tar.gz +$ cd apache-brooklyn-{{ book.brooklyn.version }} +``` {% endif %} </div> @@ -125,7 +127,7 @@ $ cd apache-brooklyn-{{ site.brooklyn.version }} <strong class="hidden started-pdf-include">e) Windows</strong> -For all versions of Microsoft Windows, please download the Apache Brooklyn zip file from [here]({{site.path.website}}/download/){:target="_blank"}. +For all versions of Microsoft Windows, please download the Apache Brooklyn zip file from [here]({{book.path.website}}/download/){:target="_blank"}. Extract this zip file to a directory on your computer such as `c:\Program Files\brooklyn` where `c` is the letter of your operating system drive. @@ -138,9 +140,9 @@ By default, no authentication is required and the web-console will listen on all For a production system, or if Apache Brooklyn is publicly reachable, it is strongly recommended to configure security. Documentation of configuration options include: -* [Security]({{ site.path.guide }}/ops/configuration/brooklyn_cfg.html) -* [Persistence]({{ site.path.guide }}/ops/persistence/) -* [Cloud credentials]({{ site.path.guide }}/locations/) +* [Security]({{ book.path.guide }}/ops/configuration/brooklyn_cfg.html) +* [Persistence]({{ book.path.guide }}/ops/persistence/) +* [Cloud credentials]({{ book.path.guide }}/locations/) ## Launch Apache Brooklyn @@ -160,15 +162,15 @@ to configure security. Documentation of configuration options include: Now start Apache Brooklyn with the following command: -{% highlight bash %} +```bash $ vagrant up brooklyn -{% endhighlight %} +``` You can see if Apache Brooklyn launched OK by viewing the log files with the command -{% highlight bash %} +```bash $ vagrant ssh brooklyn --command 'sudo journalctl -n15 -f -u brooklyn' -{% endhighlight %} +``` </div> @@ -178,11 +180,11 @@ $ vagrant ssh brooklyn --command 'sudo journalctl -n15 -f -u brooklyn' Apache Brooklyn should now have been installed and be running as a system service. It can stopped and started with the standard systemctl commands: -{% highlight bash %} +```bash $ systemctl start|stop|restart|status brooklyn -{% endhighlight %} +``` -The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{ site.path.guide }}/ops/paths.html) page for the locations of these. +The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{ book.path.guide }}/ops/paths.html) page for the locations of these. </div> <div id="impl-3" class="tab-pane fade"> @@ -191,11 +193,11 @@ The application should then output its logs to `brooklyn.debug.log` and `brookly Apache Brooklyn should now have been installed and be running as a system service. It can be stopped and started with the standard service commands: -{% highlight bash %} +```bash $ sudo service brooklyn start|stop|restart|status -{% endhighlight %} +``` -The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{ site.path.guide }}/ops/paths.html) page for the locations of these. +The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{ book.path.guide }}/ops/paths.html) page for the locations of these. </div> <div id="impl-4" class="tab-pane fade"> @@ -204,11 +206,11 @@ The application should then output its logs to `brooklyn.debug.log` and `brookly Now start Apache Brooklyn with the following command: -{% highlight bash %} +```bash $ bin/start -{% endhighlight %} +``` -The application should then output its log to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{ site.path.guide }}/ops/paths.html) page for the locations of these. +The application should then output its log to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{ book.path.guide }}/ops/paths.html) page for the locations of these. </div> <div id="impl-5" class="tab-pane fade"> @@ -238,23 +240,23 @@ INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://br By default it can be accessed by opening [127.0.0.1:8081](http://127.0.0.1:8081){:target="_blank"} in your web browser. The rest of this getting started guide uses the Apache Brooklyn command line interface (CLI) tool, `br`. -This tool is both distributed with Apache Brooklyn or can be downloaded {% if site.brooklyn-version contains 'SNAPSHOT' %} -from [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-client-cli&v={{site.brooklyn-version}}&c=bin&e=zip). +This tool is both distributed with Apache Brooklyn or can be downloaded {% if book.brooklyn-version %} +from [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-client-cli&v={{book.brooklyn-version}}&c=bin&e=zip). {% else %} using the most appropriate link for your OS: -* [Windows](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{site.brooklyn-version}}/apache-brooklyn-{{site.brooklyn-version}}-client-cli-windows.zip) -* [Linux](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{site.brooklyn-version}}/apache-brooklyn-{{site.brooklyn-version}}-client-cli-linux.tar.gz) -* [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{site.brooklyn-version}}/apache-brooklyn-{{site.brooklyn-version}}-client-cli-macosx.tar.gz) +* [Windows](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-client-cli-windows.zip) +* [Linux](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-client-cli-linux.tar.gz) +* [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-client-cli-macosx.tar.gz) {% endif %} -For details on the CLI, see the [Client CLI Reference]({{ site.path.guide }}/ops/cli/) page. +For details on the CLI, see the [Client CLI Reference]({{ book.path.guide }}/ops/cli/) page. ## Next <div class="started-pdf-exclude"> -The first thing we want to do with Brooklyn is **[deploy a blueprint]({{ site.path.guide }}/start/blueprints.html)**. +The first thing we want to do with Brooklyn is **[deploy a blueprint]({{ book.path.guide }}/start/blueprints.html)**. </div>
