Updated getting started up to the sensors section
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/0eb462e9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/0eb462e9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/0eb462e9 Branch: refs/heads/master Commit: 0eb462e97f525700a9c5438de47cb8aa63139638 Parents: 0398cfa Author: John McCabe <[email protected]> Authored: Mon Oct 19 17:54:51 2015 +0100 Committer: John McCabe <[email protected]> Committed: Mon Oct 19 17:54:51 2015 +0100 ---------------------------------------------------------------------- docs/guide/start/_my-web-cluster.yaml | 7 +++- docs/guide/start/blueprints.md | 37 +++++++++++-------- ...cation-catalog-web-cluster-with-db-large.png | Bin 131618 -> 165148 bytes ...-application-catalog-web-cluster-with-db.png | Bin 76065 -> 70109 bytes .../images/add-application-modal-yaml-large.png | Bin 0 -> 124297 bytes .../start/images/add-application-modal-yaml.png | Bin 68401 -> 55183 bytes .../start/images/my-db-activities-large.png | Bin 208313 -> 0 bytes .../images/my-db-activities-step1-large.png | Bin 0 -> 99671 bytes .../start/images/my-db-activities-step1.png | Bin 0 -> 57813 bytes .../images/my-db-activities-step2-large.png | Bin 0 -> 176900 bytes .../start/images/my-db-activities-step2.png | Bin 0 -> 97061 bytes .../images/my-db-activities-step3-large.png | Bin 0 -> 162986 bytes .../start/images/my-db-activities-step3.png | Bin 0 -> 84365 bytes docs/guide/start/images/my-db-activities.png | Bin 130262 -> 0 bytes docs/guide/start/images/my-web-large.png | Bin 0 -> 104519 bytes .../my-web-validating-app-endpoint-large.png | Bin 0 -> 123007 bytes .../images/my-web-validating-app-endpoint.png | Bin 0 -> 68969 bytes docs/guide/start/images/my-web.png | Bin 83081 -> 58849 bytes docs/guide/start/managing.md | 33 +++++++++++------ docs/guide/start/running.md | 25 +++++-------- 20 files changed, 57 insertions(+), 45 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/_my-web-cluster.yaml ---------------------------------------------------------------------- diff --git a/docs/guide/start/_my-web-cluster.yaml b/docs/guide/start/_my-web-cluster.yaml index ba22574..29a4538 100644 --- a/docs/guide/start/_my-web-cluster.yaml +++ b/docs/guide/start/_my-web-cluster.yaml @@ -1,6 +1,9 @@ name: My Web Cluster -location: localhost +location: + jclouds:aws-ec2: + identity: ABCDEFGHIJKLMNOPQRST + credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l services: @@ -18,4 +21,4 @@ services: id: db name: My DB brooklyn.config: - creationScriptUrl: https://bit.ly/brooklyn-visitors-creation-script + creationScriptUrl: https://bit.ly/brooklyn-visitors-creation-script \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/blueprints.md b/docs/guide/start/blueprints.md index 5966b77..0ccf664 100644 --- a/docs/guide/start/blueprints.md +++ b/docs/guide/start/blueprints.md @@ -12,41 +12,44 @@ children: ## Launching from a Blueprint -We'll start by deploying an application from a YAML blueprint. +We'll start by deploying an application via YAML blueprint consisting of the following layers. - +- Nginx load balancer +- Tomcat app server cluster +- MySQL DB -Copy the blueprint below into the large text box on the YAML tab. -But *before* you submit it, we need to make a modification. +When you first access the web console on [127.0.0.1:8081](http://127.0.0.1:8081) you will be requested to create your first application. + + +[](images/add-application-modal-yaml-large.png) + +Switch to the YAML tab and copy the blueprint below into the large text box. + +But *before* you submit it, modify the YAML to specify the location where the application will be deployed. {% highlight yaml %} {% readj _my-web-cluster.yaml %} {% endhighlight %} -Find the line near the top of the blueprint that starts `location:`. -Change this to have the right values for your preferred target; for example: +Replace the `location:` element with values for your chosen target environment, for example to use SoftLayer rather than AWS (updating with your own credentials): {% highlight yaml %} location: - jclouds:aws-ec2: + jclouds:softlayer: identity: ABCDEFGHIJKLMNOPQRST credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l {% endhighlight %} -Alternatively, if you have `ssh localhost` [configured](../ops/locations/#localhost) you can leave it as is. -See __[Locations](../ops/locations)__ in the Operations section of the User Guide for detail on setting up -cloud providers, including putting credentials in a file on disk rather than in the blueprint. +**Note**: See __[Locations](../ops/locations)__ in the Operations section of the User Guide for instructions on setting up alternate cloud providers, bring-your-own-nodes, or localhost targets, and storing credentials/locations in a file on disk rather than in the blueprint. With the modified YAML in the dialog, click "Finish". The dialog will close and Brooklyn will begin deploying your application. Your application will be shown as "Starting" on the web console's front page. +Depending on your choice of location it may take some time for the application nodes to start, the next page describes how you can monitor the progress of the application deployment and verify its successful deployment. ### Launching from the Catalog -Instead of pasting the YAML blueprint each time, -this blueprint can be [added to the catalog](../ops/catalog/). -With this YAML blueprint added, including the location, the Add Application dialog will offer -the "Demo Web Cluster with DB" as a template. +Instead of pasting the YAML blueprint each time, it can be added to Brooklyns Catalog where it will be accessible from the Catalog tab of the Create Application dialog. [](images/add-application-catalog-web-cluster-with-db-large.png) @@ -54,7 +57,9 @@ the "Demo Web Cluster with DB" as a template. rather than extensively document default.catalog.bom. also need to include instructions on stopping (currently in help, including stopping apps) --> +See __[Catalog](../ops/catalog/)__ in the Operations section of the User Guide for instructions on creating a new Catalog entry from your Blueprint YAML. + + ## Next -So far we have touched on Brooklyn's ability to *deploy* an application blueprint to a cloud provider, -but this just the beginning. **[Start managing this application.](managing.html)** +So far we have touched on Brooklyn's ability to *deploy* an application blueprint to a cloud provider, but this just the beginning, proceed to **[Monitoring and Managing Applications](managing.html)**. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/add-application-catalog-web-cluster-with-db-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/add-application-catalog-web-cluster-with-db-large.png b/docs/guide/start/images/add-application-catalog-web-cluster-with-db-large.png index b566b1a..1e1cf4e 100644 Binary files a/docs/guide/start/images/add-application-catalog-web-cluster-with-db-large.png and b/docs/guide/start/images/add-application-catalog-web-cluster-with-db-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/add-application-catalog-web-cluster-with-db.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/add-application-catalog-web-cluster-with-db.png b/docs/guide/start/images/add-application-catalog-web-cluster-with-db.png index ebb6f42..0a7d985 100644 Binary files a/docs/guide/start/images/add-application-catalog-web-cluster-with-db.png and b/docs/guide/start/images/add-application-catalog-web-cluster-with-db.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/add-application-modal-yaml-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/add-application-modal-yaml-large.png b/docs/guide/start/images/add-application-modal-yaml-large.png new file mode 100644 index 0000000..57c9e5c Binary files /dev/null and b/docs/guide/start/images/add-application-modal-yaml-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/add-application-modal-yaml.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/add-application-modal-yaml.png b/docs/guide/start/images/add-application-modal-yaml.png index c50b7ab..a9b2c35 100644 Binary files a/docs/guide/start/images/add-application-modal-yaml.png and b/docs/guide/start/images/add-application-modal-yaml.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-large.png b/docs/guide/start/images/my-db-activities-large.png deleted file mode 100644 index c214d9e..0000000 Binary files a/docs/guide/start/images/my-db-activities-large.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-step1-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-step1-large.png b/docs/guide/start/images/my-db-activities-step1-large.png new file mode 100644 index 0000000..c715ba3 Binary files /dev/null and b/docs/guide/start/images/my-db-activities-step1-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-step1.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-step1.png b/docs/guide/start/images/my-db-activities-step1.png new file mode 100644 index 0000000..382a198 Binary files /dev/null and b/docs/guide/start/images/my-db-activities-step1.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-step2-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-step2-large.png b/docs/guide/start/images/my-db-activities-step2-large.png new file mode 100644 index 0000000..3a6d1e3 Binary files /dev/null and b/docs/guide/start/images/my-db-activities-step2-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-step2.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-step2.png b/docs/guide/start/images/my-db-activities-step2.png new file mode 100644 index 0000000..e771a06 Binary files /dev/null and b/docs/guide/start/images/my-db-activities-step2.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-step3-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-step3-large.png b/docs/guide/start/images/my-db-activities-step3-large.png new file mode 100644 index 0000000..7f484a2 Binary files /dev/null and b/docs/guide/start/images/my-db-activities-step3-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities-step3.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities-step3.png b/docs/guide/start/images/my-db-activities-step3.png new file mode 100644 index 0000000..0e1b508 Binary files /dev/null and b/docs/guide/start/images/my-db-activities-step3.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-db-activities.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-db-activities.png b/docs/guide/start/images/my-db-activities.png deleted file mode 100644 index 0f2327c..0000000 Binary files a/docs/guide/start/images/my-db-activities.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-web-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-web-large.png b/docs/guide/start/images/my-web-large.png new file mode 100644 index 0000000..8954441 Binary files /dev/null and b/docs/guide/start/images/my-web-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-web-validating-app-endpoint-large.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-web-validating-app-endpoint-large.png b/docs/guide/start/images/my-web-validating-app-endpoint-large.png new file mode 100644 index 0000000..69005c4 Binary files /dev/null and b/docs/guide/start/images/my-web-validating-app-endpoint-large.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-web-validating-app-endpoint.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-web-validating-app-endpoint.png b/docs/guide/start/images/my-web-validating-app-endpoint.png new file mode 100644 index 0000000..d775717 Binary files /dev/null and b/docs/guide/start/images/my-web-validating-app-endpoint.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/images/my-web.png ---------------------------------------------------------------------- diff --git a/docs/guide/start/images/my-web.png b/docs/guide/start/images/my-web.png index 2bd6ac3..a370606 100644 Binary files a/docs/guide/start/images/my-web.png and b/docs/guide/start/images/my-web.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/managing.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/managing.md b/docs/guide/start/managing.md index e01edbf..befe2ee 100644 --- a/docs/guide/start/managing.md +++ b/docs/guide/start/managing.md @@ -17,10 +17,29 @@ We can explore the management hierarchy of the application, which will show us t -Clicking on the "My Web" entity will show the "Summary" tab, +Clicking on the "My Web Cluster" entity will show the "Summary" tab, giving a very high level of what that component is doing. - +[](images/my-web-large.png) + + +## Activities + +The Activity tab allows us to drill down into the tasks each entity is currently executing or has recently completed. It is possible to drill down through all child tasks, and view the commands issued, along with any errors or warnings that occurred. + +For example clicking on the NginxController in the left hand tree and opening its Activity tab you can observe the 'start' task is 'In progress'. + +**Note**: You may observe different tasks depending on how far your deployment has progressed). + +[](images/my-db-activities-step1-large.png) + +Clicking on the 'start' task you can discover more details on the actions being carried out by that task (a task may consist of additional subtasks). + +[](images/my-db-activities-step2-large.png) + +Continuing to drill down into the 'In progress' tasks you will eventually reach the currently active task where you can investigate the ssh command executed on the target node including the current stdin, stdout and stderr output. + +[](images/my-db-activities-step3-large.png) ## Sensors @@ -33,16 +52,6 @@ Explore the sensors and the tree to find a URL where the webapp we just deployed and open that in a new tab. Quickly return to the "Sensors" tab and observe the requests-per-second sensor increase. -##Â Activities - -The Activity tab allows us to drill down into the activities each entity is currently doing or has recently done. -It is possible to drill down to all child tasks, and view the commands issued, and any errors or warnings that occured. - -Drill into the "My DB" start operation. -Working down through "Start (processes)", then "launch", we can discover the ssh command used including the stdin, stdout and stderr. - -[](images/my-db-activities-large.png) - ## Stopping the Application http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0eb462e9/docs/guide/start/running.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md index 2f97bab..edb0c96 100644 --- a/docs/guide/start/running.md +++ b/docs/guide/start/running.md @@ -5,13 +5,13 @@ layout: website-normal menu_parent: index.md --- -This guide will walk you through deploying an example 3-tier web application to a public cloud. +This guide will walk you through deploying an example 3-tier web application to a public cloud, and demonstrate the autoscaling capabilities of the Brooklyn platform. This tutorial assumes that you are using Linux or Mac OS X. ## Install Apache Brooklyn -Download Apache Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download/). +Download the Apache Brooklyn binary distribution as described on [the download page]({{site.path.website}}/download/). {% if brooklyn_version contains 'SNAPSHOT' %} Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different): @@ -31,11 +31,14 @@ $ tar -zxf apache-brooklyn-{{ site.brooklyn-version }}-dist.tar.gz This will create a `apache-brooklyn-{{ site.brooklyn-version }}` folder. -**Note**: You'll need a Java JRE or SDK installed (version 1.7 or later), as Brooklyn is Java under the covers. - -**Note #2**: If you want to test Brooklyn on localhost, follow [these instructions]({{site.path.guide}}/ops/locations/#localhost) -to ensure that your Brooklyn can access your machine. +**Note**: You'll need a Java JRE or SDK installed (version 7 or later), as Brooklyn is Java under the covers. +It is not necessary at this time, but depending on what you are going to do, +you may wish to set up other configuration options first: + +* [Security](../ops/brooklyn_properties.html) +* [Persistence](../ops/persistence/) +* [Cloud credentials](../ops/locations/) ## Launch Apache Brooklyn @@ -53,16 +56,8 @@ INFO Starting brooklyn web-console on loopback interface because no security co INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and [] </pre> - ### Next Next, open the web console on [127.0.0.1:8081](http://127.0.0.1:8081). No applications have been deployed yet, so the "Create Application" dialog opens automatically: -let's remedy this by **[deploying a blueprint](blueprints.html)**. - -It is not necessary at this time, but depending on what you are going to do, -you may wish to set up other configuration options first: - -* [Security](../ops/brooklyn_properties.html) -* [Persistence](../ops/persistence/) -* [Cloud credentials](../ops/locations/) +let's remedy this by **[deploying a blueprint](blueprints.html)**. \ No newline at end of file
