You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by sj...@apache.org on 2015/11/30 12:50:35 UTC
[1/3] incubator-brooklyn git commit: Added some advanced YAML
examples and made a CollectionFunctionals constructor public
Repository: incubator-brooklyn
Updated Branches:
refs/heads/master e7425c1bf -> aeb56fdf1
Added some advanced YAML examples and made a CollectionFunctionals constructor public
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/4ce39902
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/4ce39902
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/4ce39902
Branch: refs/heads/master
Commit: 4ce39902dc8032e4b56df6ddf836e77f389c287d
Parents: b03f77e
Author: Graeme-Miller <gr...@cloudsoftcorp.com>
Authored: Wed Nov 25 18:57:32 2015 +0000
Committer: Graeme-Miller <gr...@cloudsoftcorp.com>
Committed: Wed Nov 25 18:57:54 2015 +0000
----------------------------------------------------------------------
docs/guide/yaml/advanced-example.md | 177 +++++++++++++++++++
.../brooklyn-elasticsearch-catalog.bom | 126 +++++++++++++
.../yaml/example_yaml/brooklyn-elk-catalog.bom | 37 ++++
.../example_yaml/brooklyn-kibana-catalog.bom | 52 ++++++
.../example_yaml/brooklyn-logstash-catalog.bom | 59 +++++++
docs/guide/yaml/index.md | 1 +
.../util/collections/CollectionFunctionals.java | 4 +-
7 files changed, 454 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/docs/guide/yaml/advanced-example.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/advanced-example.md b/docs/guide/yaml/advanced-example.md
new file mode 100644
index 0000000..8a7f2a7
--- /dev/null
+++ b/docs/guide/yaml/advanced-example.md
@@ -0,0 +1,177 @@
+---
+title: YAML BLueprint Advanced Example
+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 Example
+
+The example itself is a deployment of an ELK stack. ELK stands for Elasticsearch, Logstash and Kibana- and this blueprint deploys, installs, runs and manages all three. Briefly, the component parts are:
+
+* Elasticsearch: A clustered search engine
+* Logstash: Collects, parses and stores logs. For our application it will store logs in Elasticsearch
+* Kibana: A front end to Elasticsearch
+
+For more about the ELK stack, please see the documentation [here](https://www.elastic.co/webinars/introduction-elk-stack).
+
+In our example, we will be creating the ELK stack, and a Tomcat8 server which sends its logs using Logstash to Elasticsearch.
+
+#### The Blueprints
+-----------
+
+There are four blueprints that make up this application. Each of them are used to add one or more catalog items to Brooklyn. You can find them below:
+
+* [Elasticsearch](example_yaml/brooklyn-elasticsearch-catalog.bom)
+* [Logstash](example_yaml/brooklyn-logstash-catalog.bom)
+* [Kibana](example_yaml/brooklyn-kibana-catalog.bom)
+* [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.
+
+#### Exploring the example
+After the example has been deployed, you can ensure it is working as expected by checking the following:
+
+* There is a Kibana sensor called "main.uri", the value of which points to the Kibana front end. You can explore this front end, and observe the logs stored in Elasticsearch. Many Brooklyn applications have a "main.uri" set to point you in the right direction.
+* You can also use the Elasticsearch REST API to explore further. The ES entity has an "urls.http.list" sensor. Choosing an url from there you will be able to access the REST API. The following URL will give you the state of the cluster "{es-url}/\_cluster/health?pretty=true". As you can see the number_of_nodes is currently 2, indicating that the Elasticsearch nodes are communicating with each other.
+
+### Interesting Feature Spotlight
+We will mainly focus on the Elasticsearch blueprint, and will be clear when another blueprint is being discussed. This blueprint is a cluster of Elasticsearch nodes. Clustering is a useful technique that is explained in more depth [here](../clusters.html).
+
+#### Provisioning Properties
+Our Elasticsearch blueprint has a few requirements of the location in which it is run. Firstly, it must be run on an Ubuntu machine to simplify installation. Secondly, there are two ports that need to be opened to ensure that the entities can be accessed from the outside world. These are configured on the provisioning.properties as follows:
+
+~~~yaml
+provisioning.properties:
+ osFamily: ubuntu
+ inboundPorts:
+ - $brooklyn:config("elasticsearch.http.port")
+ - $brooklyn:config("elasticsearch.tcp.port")
+~~~
+
+#### VanillaSoftwareProcess
+When composing a YAML blueprint, the VanillaSoftwareProcess is a very useful entity to be aware of. A VanillaSoftwareProcess will instruct Brooklyn to provision an instance, and run a series of shell commands to setup, run, monitor and teardown your program. The commands are specified as configuration on the VanillaSoftwareProcess and there are several available. We will spotlight a few now. To simplify this blueprint, we have specified ubuntu only installs so that our commands can be tailored to this system (E.G. use apt-get rather than YUM).
+
+##### Customize Command
+The Customize Command is run after the application has been installed but before it is run. It is the perfect place to create and amend config files. Please refer to the following section of the Elasticsearch blueprint:
+
+~~~yaml
+customize.command: |
+ $brooklyn:formatString("
+ sudo rm -fr sudo tee /etc/elasticsearch/elasticsearch.yml;
+ echo discovery.zen.ping.multicast.enabled: false | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo discovery.zen.ping.unicast.enabled: true | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo 'discovery.zen.ping.unicast.hosts: %s' | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo http.port: %s | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo transport.tcp.port: %s | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ ",
+ $brooklyn:component("parent", "").attributeWhenReady("urls.tcp.withBrackets"),
+ $brooklyn:config("elasticsearch.http.port"),
+ $brooklyn:config("elasticsearch.tcp.port")
+ )
+~~~
+The purpose of this section is to create a YAML file with all of the required configuration. We use the YAML literal style "|" indicator to write a multi line command. We then use $brooklyn:formatString notation to build the string from configuration. We start our series of commands by using the "rm" command to remove the previous config file. We then use "echo" and "tee" to create the new config file and insert the config. Part of the configuration is a list of all hosts that is set on the parent entity- this is done by using a combination of the "component" and "attributeWhenReady" DSL commands. More on how this is generated later.
+
+##### Check running
+After an app is installed and run, this command will be run regularly and used to populate the "service.isUp" sensor. If this command is not specified, or returns an exit code of anything other than zero, then Brooklyn will assume that your entity is broken and will display the fire status symbol. Please refer to the following section of the Elasticsearch blueprint:
+
+~~~yaml
+checkRunning.command: |
+ $brooklyn:formatString("counter=`wget -T 15 -q -O- %s:%s | grep -c \"status. : 200\"`; if [ $counter -eq 0 ]; then exit 1; fi",
+ $brooklyn:attributeWhenReady("host.address"),
+ $brooklyn:config("elasticsearch.http.port"))
+~~~
+There are many different ways to implement this command. For this example, we are querying the REST API to get the status. This command creates a variable called counter, and populates it by performing a "WGET" call to the status URL or the Elasticsearch node, grepping for a 200 status OK code. We then check the counter is populated (I.E. that the end point does return status 200) and exit with an error code of one if not.
+
+#### Enrichers
+
+##### Elasticsearch URLS
+To ensure that all Elasticsearch nodes can communicate with each other they need to be configured with the TCP URL of all other nodes. Similarly, the Logstash instances need to be configured with all the HTTP URLs of the Elasticsearch nodes. The mechanism for doing this is the same, and involves using Transformers, Aggregators and Joiners, as follows:
+
+~~~yaml
+brooklyn.enrichers:
+ - type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("host.address")
+ enricher.targetSensor: $brooklyn:sensor("url.tcp")
+ 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:
+
+~~~yaml
+brooklyn.enrichers:
+ - type: org.apache.brooklyn.enricher.stock.Aggregator
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("url.tcp")
+ enricher.targetSensor: $brooklyn:sensor("urls.tcp.list")
+ 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:
+
+~~~yaml
+- type: org.apache.brooklyn.enricher.stock.Joiner
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("urls.tcp.list")
+ enricher.targetSensor: $brooklyn:sensor("urls.tcp.string")
+ uniqueTag: urls.quoted.string
+~~~
+
+Finally, the string has brackets added to the start and end:
+
+~~~yaml
+- type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("urls.tcp.string")
+ enricher.targetSensor: $brooklyn:sensor("urls.tcp.withBrackets")
+ enricher.targetValue: $brooklyn:formatString("[%s]", $brooklyn:attributeWhenReady("urls.tcp.string"))
+~~~
+
+The resulting sensor will be called urls.tcp.withBrackets and will be used by all Elasticsearch nodes during setup.
+
+##### Kibana URL
+Kibana also needs to be configured such that it can access the Elasticsearch cluster. However, Kibana can only be configured to point at one Elasticsearch instance. To enable this, we use another enricher in the cluster to select the first URL from the list, as follows:
+
+~~~yaml
+- type: org.apache.brooklyn.enricher.stock.Aggregator
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("host.address")
+ enricher.targetSensor: $brooklyn:sensor("host.address.first")
+ enricher.aggregating.fromMembers: true
+ enricher.transformation:
+ $brooklyn:object:
+ type: "org.apache.brooklyn.util.collections.CollectionFunctionals$FirstElementFunction"
+~~~
+
+Similar to the above Aggregator, this Aggregator collects all the URLs from the members of the cluster. However, this Aggregator specifies a transformation. In this instance a transformation is a Java class that implements a Guava Function\<? super Collection\<?\>, ?\>\>, I.E. a function that takes in a collection and returns something. In this case we specify the FirstElementFunction from the CollectionFunctionals to ensure that we only get the first member of the URL list.
+
+#### Latches
+In the ELK blueprint, there is a good example of a latch. Latches are used to force an entity to wait until certain conditions are met before continuing. For example:
+
+~~~yaml
+- type: kibana-standalone
+ ...
+ name: kibana
+ customize.latch: $brooklyn:component("es").attributeWhenReady("service.isUp")
+~~~
+
+This latch is used to stop Kibana customizing until the Elasticsearch cluster is up. We do this to ensure that the URL sensors have been setup, so that they can be passed into Kibana during the customization phase.
+
+#### Child entities
+The ELK blueprint also contains a good example of a child entity.
+
+~~~yaml
+- type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
+ brooklyn.config:
+ children.startable.mode: background_late
+ ...
+ brooklyn.children:
+ - type: logstash-child
+~~~
+
+In this example, a logstash-child is started as a child of the parent Tomcat server. The tomcat server needs to be configured with a "children.startable.mode" to inform Brooklyn when to bring up the child. In this case we have selected background so that the child is disassociated from the parent entity, and late to specify that the parent entity should start before we start the child.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/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
new file mode 100644
index 0000000..864bf92
--- /dev/null
+++ b/docs/guide/yaml/example_yaml/brooklyn-elasticsearch-catalog.bom
@@ -0,0 +1,126 @@
+brooklyn.catalog:
+ id: elasticsearch
+ version: 1.0
+ iconUrl: https://avatars0.githubusercontent.com/u/6764390?v=3&s=400
+ name: Elasticsearch
+ license: Apache-2.0
+ maintainer_name: Graeme Miller
+ maintainer_email: graeme.miller@cloudsoftcorp.com
+ issues_url: https://github.com/Graeme-Miller/brooklyn-elasticsearch/issues
+ item:
+ type: brooklyn.entity.group.DynamicCluster
+ initialSize: 2
+ name: Elasticsearch Cluster
+ id: elasticsearch-cluster
+ description: A cluster of Elasticsearch nodes
+
+ brooklyn.config:
+ install.version: 1.7.1
+ elasticsearch.http.port: 9220
+ elasticsearch.tcp.port: 9330
+
+ brooklyn.enrichers:
+ - type: org.apache.brooklyn.enricher.stock.Aggregator
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("url.tcp")
+ enricher.targetSensor: $brooklyn:sensor("urls.tcp.list")
+ enricher.aggregating.fromMembers: true
+ - type: org.apache.brooklyn.enricher.stock.Joiner
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("urls.tcp.list")
+ enricher.targetSensor: $brooklyn:sensor("urls.tcp.string")
+ uniqueTag: urls.quoted.string
+ - type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("urls.tcp.string")
+ enricher.targetSensor: $brooklyn:sensor("urls.tcp.withBrackets")
+ enricher.targetValue: $brooklyn:formatString("[%s]", $brooklyn:attributeWhenReady("urls.tcp.string"))
+ - type: org.apache.brooklyn.enricher.stock.Aggregator
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("url.http")
+ enricher.targetSensor: $brooklyn:sensor("urls.http.list")
+ enricher.aggregating.fromMembers: true
+ - type: org.apache.brooklyn.enricher.stock.Joiner
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("urls.http.list")
+ enricher.targetSensor: $brooklyn:sensor("urls.http.string")
+ uniqueTag: urls.http.quoted.string
+ - type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("urls.http.string")
+ enricher.targetSensor: $brooklyn:sensor("urls.http.withBrackets")
+ enricher.targetValue: $brooklyn:formatString("[%s]", $brooklyn:attributeWhenReady("urls.http.string"))
+ - type: org.apache.brooklyn.enricher.stock.Aggregator
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("host.address")
+ enricher.targetSensor: $brooklyn:sensor("host.address.first")
+ enricher.aggregating.fromMembers: true
+ enricher.transformation:
+ $brooklyn:object:
+ type: "org.apache.brooklyn.util.collections.CollectionFunctionals$FirstElementFunction"
+
+ memberSpec:
+ $brooklyn:entitySpec:
+ - type: brooklyn.entity.basic.VanillaSoftwareProcess
+ name: Elasticsearch Node
+
+ provisioning.properties:
+ osFamily: ubuntu
+ inboundPorts:
+ - $brooklyn:config("elasticsearch.http.port")
+ - $brooklyn:config("elasticsearch.tcp.port")
+
+ install.command: |
+ $brooklyn:formatString("
+ sudo apt-get update
+ sudo apt-get install -y openjdk-7-jdk wget
+
+ wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
+ echo \"deb http://packages.elastic.co/elasticsearch/1.7/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.7.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.6/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.6.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.5/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.5.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.4/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.4.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.3/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.3.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.2/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.2.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.1/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.1.list
+ echo \"deb http://packages.elastic.co/elasticsearch/1.0/debian stable main\" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.0.list
+ sudo apt-get update && sudo apt-get -y install elasticsearch=%s
+ ",
+ $brooklyn:config("install.version")
+ )
+
+ customize.command: |
+ $brooklyn:formatString("
+ sudo rm -fr sudo tee /etc/elasticsearch/elasticsearch.yml;
+ echo discovery.zen.ping.multicast.enabled: false | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo discovery.zen.ping.unicast.enabled: true | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo 'discovery.zen.ping.unicast.hosts: %s' | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo http.port: %s | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ echo transport.tcp.port: %s | sudo tee -a /etc/elasticsearch/elasticsearch.yml;
+ ",
+ $brooklyn:component("parent", "").attributeWhenReady("urls.tcp.withBrackets"),
+ $brooklyn:config("elasticsearch.http.port"),
+ $brooklyn:config("elasticsearch.tcp.port")
+ )
+
+
+ launch.command: sudo service elasticsearch start
+
+ stop.command: sudo service elasticsearch stop
+
+ checkRunning.command: |
+ $brooklyn:formatString("counter=`wget -T 15 -q -O- %s:%s | grep -c \"status. : 200\"`; if [ $counter -eq 0 ]; then exit 1; fi",
+ $brooklyn:attributeWhenReady("host.address"),
+ $brooklyn:config("elasticsearch.http.port"))
+
+ brooklyn.enrichers:
+ - type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("host.address")
+ enricher.targetSensor: $brooklyn:sensor("url.tcp")
+ enricher.targetValue: $brooklyn:formatString("%s:%s", $brooklyn:attributeWhenReady("host.address"), $brooklyn:config("elasticsearch.tcp.port"))
+ - type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("host.address")
+ enricher.targetSensor: $brooklyn:sensor("url.http")
+ enricher.targetValue: $brooklyn:formatString("%s:%s", $brooklyn:attributeWhenReady("host.address"), $brooklyn:config("elasticsearch.http.port"))
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/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
new file mode 100644
index 0000000..0c25d4b
--- /dev/null
+++ b/docs/guide/yaml/example_yaml/brooklyn-elk-catalog.bom
@@ -0,0 +1,37 @@
+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: graeme.miller@cloudsoftcorp.com
+ issues_url: https://github.com/Graeme-Miller/brooklyn-elk/issues
+ itemType: template
+ item:
+ type: org.apache.brooklyn.entity.stock.BasicApplication
+ name: ELK Stack
+ id: ELK-Stack
+ description: |
+ Simple ELK stack deployment: it installs ES, Kibana and lostash as a child of Apache Tomcat 8
+ services:
+ - type: elasticsearch
+ id: es
+ name: es
+ brooklyn.config:
+ install.version: 1.4.4
+ - type: kibana-standalone
+ id: kibana
+ name: kibana
+ customize.latch: $brooklyn:component("es").attributeWhenReady("service.isUp")
+ brooklyn.config:
+ kibana.elasticsearch.ip: $brooklyn:component("es").attributeWhenReady("host.address.first")
+ kibana.elasticsearch.port: $brooklyn:component("es").config("elasticsearch.http.port")
+ - type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
+ id: jboss
+ customize.latch: $brooklyn:component("es").attributeWhenReady("service.isUp")
+ brooklyn.config:
+ children.startable.mode: background_late
+ brooklyn.children:
+ - type: logstash-child
+ name: logstash-child
+ brooklyn.config:
+ logstash.elasticsearch.host: $brooklyn:component("es").attributeWhenReady("urls.http.withBrackets")
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/docs/guide/yaml/example_yaml/brooklyn-kibana-catalog.bom
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/example_yaml/brooklyn-kibana-catalog.bom b/docs/guide/yaml/example_yaml/brooklyn-kibana-catalog.bom
new file mode 100644
index 0000000..ee006d2
--- /dev/null
+++ b/docs/guide/yaml/example_yaml/brooklyn-kibana-catalog.bom
@@ -0,0 +1,52 @@
+brooklyn.catalog:
+ version: 0.0.2
+ iconUrl: http://blog.arungupta.me/wp-content/uploads/2015/07/kibana-logo.png
+ items:
+ - id: kibana-standalone
+ name: "Kibana server"
+ description: "Single Kibana server"
+ description: |
+ Kibana server. Callers should configure 'kibana.elasticsearch.ip'
+ item:
+ type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
+ provisioning.properties:
+ osFamily: ubuntu
+
+ brooklyn.config:
+ install.version: "4.1.1"
+ kibana.elasticsearch.ip: 127.0.0.1 # must be supplied by caller!
+ kibana.elasticsearch.port: 9200 # must be supplied by caller!
+ kibana.port: 5601
+
+ shell.env:
+ KIBANA_VERSION: $brooklyn:config("install.version")
+ ELASTICSEARCH_IP: $brooklyn:config("kibana.elasticsearch.ip")
+ ELASTICSEARCH_PORT: $brooklyn:config("kibana.elasticsearch.port")
+ KIBANA_PORT: $brooklyn:config("kibana.port")
+
+ install.command: |
+ # Install required dependencies
+ sudo apt-get update
+ sudo DEBIAN_FRONTEND=noninteractive apt-get install -y --allow-unauthenticated tzdata openjdk-7-jdk wget
+
+ # download kibana
+ sudo mkdir -p /opt/kibana/
+ cd /opt/kibana
+ sudo chmod -R 777 /opt/kibana
+ wget -qO - https://download.elastic.co/kibana/kibana/kibana-${KIBANA_VERSION}-linux-x64.tar.gz | tar xz
+
+ # customize config file for kibana
+ sed -i 's|http://localhost:9200|http://'"${ELASTICSEARCH_IP}"':'"${ELASTICSEARCH_PORT}"'|g' /opt/kibana/kibana-${KIBANA_VERSION}-linux-x64/config/kibana.yml
+ sed -i 's|5601|'"${KIBANA_PORT}"'|g' /opt/kibana/kibana-${KIBANA_VERSION}-linux-x64/config/kibana.yml
+ sed -i 's|# log_file: ./kibana.log|log_file: ./kibana.log|g' /opt/kibana/kibana-${KIBANA_VERSION}-linux-x64/config/kibana.yml
+
+ launch.command: |
+ nohup /opt/kibana/kibana-${KIBANA_VERSION}-linux-x64/bin/kibana &
+ echo $! > $PID_FILE
+
+ brooklyn.enrichers:
+ - type: org.apache.brooklyn.enricher.stock.Transformer
+ brooklyn.config:
+ enricher.sourceSensor: $brooklyn:sensor("host.address")
+ enricher.targetSensor: $brooklyn:sensor("main.uri")
+ enricher.targetValue: $brooklyn:formatString("http://%s:%s", $brooklyn:attributeWhenReady("host.address"), $brooklyn:config("kibana.port"))
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/docs/guide/yaml/example_yaml/brooklyn-logstash-catalog.bom
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/example_yaml/brooklyn-logstash-catalog.bom b/docs/guide/yaml/example_yaml/brooklyn-logstash-catalog.bom
new file mode 100644
index 0000000..7c431f5
--- /dev/null
+++ b/docs/guide/yaml/example_yaml/brooklyn-logstash-catalog.bom
@@ -0,0 +1,59 @@
+brooklyn.catalog:
+ version: 1.5.5
+ iconUrl: http://logstash.net/images/logstash.png
+ items:
+ - id: logstash-standalone
+ name: "Logstash server"
+ description: "Single Logstash server"
+ item:
+ type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
+ provisioning.properties:
+ osFamily: ubuntu
+
+ brooklyn.config:
+ install.version: "1.5.4"
+ logstash.config.input: input { file { path => "/var/log/*" } }
+ logstash.config.filter: ''
+ logstash.config.output: output { stdout { } }
+ logstash.config.dir: /etc/logstash/conf.d/
+
+ shell.env:
+ VERSION: $brooklyn:config("install.version")
+ INPUT_CONFIG: $brooklyn:config("logstash.config.input")
+ FILTER_CONFIG: $brooklyn:config("logstash.config.filter")
+ OUTPUT_CONFIG: $brooklyn:config("logstash.config.output")
+ CONFIG_DIR: $brooklyn:config("logstash.config.dir")
+
+ install.command: |
+ # Install required dependencies
+ sudo apt-get update
+ sudo DEBIAN_FRONTEND=noninteractive apt-get install -y --allow-unauthenticated tzdata openjdk-7-jdk wget
+
+ # download logstash
+ sudo mkdir -p /opt/logstash/
+ cd /opt/logstash
+ sudo chmod -R 777 /opt/logstash
+ wget -qO - https://download.elastic.co/logstash/logstash/logstash-${VERSION}.tar.gz | tar xz
+
+ # add a config file for logstash
+ sudo mkdir -p ${CONFIG_DIR}
+ echo "${INPUT_CONFIG} ${FILTER_CONFIG} ${OUTPUT_CONFIG}" | sudo tee ${CONFIG_DIR}/01-basic.conf
+
+ launch.command: |
+ sudo mkdir -p /var/log/logstash/
+ sudo chmod -R 777 /var/log/logstash/
+ nohup /opt/logstash/logstash-${VERSION}/bin/logstash agent -f ${CONFIG_DIR} -l /var/log/logstash/logstash.log &
+ echo $! > $PID_FILE
+ - id: logstash-child
+ name: "Logstash Child"
+ description: |
+ Logstash server to be embedded as a child of a SoftwareProcess who
+ publishes his 'log.location' as a sensor.
+ Callers should configure 'logstash.elasticsearch.host' (if using ES)
+ or 'logstash.config.output'.
+ item:
+ type: logstash-standalone
+ brooklyn.config:
+ logstash.config.input: $brooklyn:formatString("input { file { path => \"%s\" start_position => \"beginning\" } }", $brooklyn:parent().attributeWhenReady("log.location"))
+ logstash.elasticsearch.host: 127.0.0.1:9200 # must be supplied by caller!
+ logstash.config.output: $brooklyn:formatString("output { elasticsearch { host => %s protocol => \"http\" embedded => false } }", $brooklyn:config("logstash.elasticsearch.host"))
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/docs/guide/yaml/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/index.md b/docs/guide/yaml/index.md
index b0303cb..164f148 100644
--- a/docs/guide/yaml/index.md
+++ b/docs/guide/yaml/index.md
@@ -12,6 +12,7 @@ children:
- winrm/
- chef/
- test/
+- advanced-example.md
- { path: yaml-reference.md, title: YAML Blueprint Reference }
- { link: 'https://github.com/brooklyncentral/blueprint-library', title: 'GitHub Blueprint Library' }
---
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ce39902/utils/common/src/main/java/org/apache/brooklyn/util/collections/CollectionFunctionals.java
----------------------------------------------------------------------
diff --git a/utils/common/src/main/java/org/apache/brooklyn/util/collections/CollectionFunctionals.java b/utils/common/src/main/java/org/apache/brooklyn/util/collections/CollectionFunctionals.java
index 8446e55..aa6831b 100644
--- a/utils/common/src/main/java/org/apache/brooklyn/util/collections/CollectionFunctionals.java
+++ b/utils/common/src/main/java/org/apache/brooklyn/util/collections/CollectionFunctionals.java
@@ -107,12 +107,12 @@ public class CollectionFunctionals {
}
public static final class FirstElementFunction<T> implements Function<Iterable<? extends T>, T> {
- private FirstElementFunction() {
+ public FirstElementFunction() {
}
@Override
public T apply(Iterable<? extends T> input) {
- if (input==null) return null;
+ if (input==null || Iterables.isEmpty(input)) return null;
return Iterables.get(input, 0);
}
[2/3] incubator-brooklyn git commit: Minor updates to advanced yaml
documentation
Posted by sj...@apache.org.
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 <gr...@cloudsoftcorp.com>
Authored: Mon Nov 30 10:25:35 2015 +0000
Committer: Graeme-Miller <gr...@cloudsoftcorp.com>
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: graeme.miller@cloudsoftcorp.com
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: graeme.miller@cloudsoftcorp.com
issues_url: https://github.com/Graeme-Miller/brooklyn-elk/issues
itemType: template
item:
[3/3] incubator-brooklyn git commit: This closes #1070
Posted by sj...@apache.org.
This closes #1070
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/aeb56fdf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/aeb56fdf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/aeb56fdf
Branch: refs/heads/master
Commit: aeb56fdf1dab74844e4bc1317a761b5c88bba216
Parents: e7425c1 88e055f
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Authored: Mon Nov 30 11:50:19 2015 +0000
Committer: Sam Corbett <sa...@cloudsoftcorp.com>
Committed: Mon Nov 30 11:50:19 2015 +0000
----------------------------------------------------------------------
docs/guide/yaml/advanced-example.md | 177 +++++++++++++++++++
.../brooklyn-elasticsearch-catalog.bom | 124 +++++++++++++
.../yaml/example_yaml/brooklyn-elk-catalog.bom | 35 ++++
.../example_yaml/brooklyn-kibana-catalog.bom | 52 ++++++
.../example_yaml/brooklyn-logstash-catalog.bom | 59 +++++++
docs/guide/yaml/index.md | 1 +
.../util/collections/CollectionFunctionals.java | 4 +-
7 files changed, 450 insertions(+), 2 deletions(-)
----------------------------------------------------------------------