Minor updates to advanced yaml documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/88e055f2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/88e055f2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/88e055f2 Branch: refs/heads/master Commit: 88e055f28b5b4fee87a1196790a425786466ca3c Parents: 4ce3990 Author: Graeme-Miller <[email protected]> Authored: Mon Nov 30 10:25:35 2015 +0000 Committer: Graeme-Miller <[email protected]> Committed: Mon Nov 30 10:25:35 2015 +0000 ---------------------------------------------------------------------- docs/guide/yaml/advanced-example.md | 8 ++++---- .../yaml/example_yaml/brooklyn-elasticsearch-catalog.bom | 2 -- docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom | 2 -- 3 files changed, 4 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/88e055f2/docs/guide/yaml/advanced-example.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/advanced-example.md b/docs/guide/yaml/advanced-example.md index 8a7f2a7..b55fdf5 100644 --- a/docs/guide/yaml/advanced-example.md +++ b/docs/guide/yaml/advanced-example.md @@ -5,7 +5,7 @@ layout: website-normal By this point you should be familiar with the fundamental concepts behind both Apache Brooklyn and YAML blueprints. This section of the documentation is intended to show a complete, advanced example of a YAML blueprint. -The intention is that this example is used to learn the more in-depth concepts, but also to serve as a reference point when writing your own blueprints. This page will first exaplin what the example is and how to run it, then it will spotlight interesting features. +The intention is that this example is used to learn the more in-depth concepts, but also to serve as a reference point when writing your own blueprints. This page will first explain what the example is and how to run it, then it will spotlight interesting features. ### The Example @@ -31,7 +31,7 @@ There are four blueprints that make up this application. Each of them are used t * [ELK](example_yaml/brooklyn-elk-catalog.bom) #### Running the example -First, add all four blueprints to the Brooklyn Catalog. This can be done by clicking the 'Catalog' tab, clinking the '+' symbol and pasting the YAML. Once this is done , click the 'Application' then the '+' button to bring up the add application wizard. A new Catalog item will be available called 'ELK Stack'. Using the add application wizard, you should be able to deploy an ELK stack to a location of your choosing. +First, add all four blueprints to the Brooklyn Catalog. This can be done by clicking the 'Catalog' tab, clinking the '+' symbol and pasting the YAML. Once this is done, click the 'Application' tab, then the '+' button to bring up the add application wizard. A new Catalog item will be available called 'ELK Stack'. Using the add application wizard, you should be able to deploy an ELK stack to a location of your choosing. #### Exploring the example After the example has been deployed, you can ensure it is working as expected by checking the following: @@ -101,7 +101,7 @@ brooklyn.enrichers: enricher.targetValue: $brooklyn:formatString("%s:%s", $brooklyn:attributeWhenReady("host.address"), $brooklyn:config("elasticsearch.tcp.port")) ~~~ -In this example, we take the host.address and append the TCP port, outputting the result as url.tcp. After this has been done, we now need to collet all the URLs into a list in the Cluster entity, as follows: +In this example, we take the host.address and append the TCP port, outputting the result as url.tcp. After this has been done, we now need to collect all the URLs into a list in the Cluster entity, as follows: ~~~yaml brooklyn.enrichers: @@ -112,7 +112,7 @@ brooklyn.enrichers: enricher.aggregating.fromMembers: true ~~~ -In the proceeding example, we aggregate all of the TCP urls generated in the early example. These are then stored in a sensor called urls.tcp.list. This list is then joined together into one long string: +In the preceding example, we aggregate all of the TCP urls generated in the early example. These are then stored in a sensor called urls.tcp.list. This list is then joined together into one long string: ~~~yaml - type: org.apache.brooklyn.enricher.stock.Joiner http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/88e055f2/docs/guide/yaml/example_yaml/brooklyn-elasticsearch-catalog.bom ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/example_yaml/brooklyn-elasticsearch-catalog.bom b/docs/guide/yaml/example_yaml/brooklyn-elasticsearch-catalog.bom index 864bf92..bbed240 100644 --- a/docs/guide/yaml/example_yaml/brooklyn-elasticsearch-catalog.bom +++ b/docs/guide/yaml/example_yaml/brooklyn-elasticsearch-catalog.bom @@ -4,8 +4,6 @@ brooklyn.catalog: iconUrl: https://avatars0.githubusercontent.com/u/6764390?v=3&s=400 name: Elasticsearch license: Apache-2.0 - maintainer_name: Graeme Miller - maintainer_email: [email protected] issues_url: https://github.com/Graeme-Miller/brooklyn-elasticsearch/issues item: type: brooklyn.entity.group.DynamicCluster http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/88e055f2/docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom b/docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom index 0c25d4b..ffca3df 100644 --- a/docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom +++ b/docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom @@ -2,8 +2,6 @@ brooklyn.catalog: version: 1.0 iconUrl: https://avatars0.githubusercontent.com/u/6764390?v=3&s=400 license: Apache-2.0 - maintainer_name: Graeme Miller - maintainer_email: [email protected] issues_url: https://github.com/Graeme-Miller/brooklyn-elk/issues itemType: template item:
