brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [01/29] incubator-brooklyn git commit: Updated blueprints and managing
Date Sat, 30 Jan 2016 03:38:26 GMT
Repository: incubator-brooklyn
Updated Branches:
  refs/heads/master 9d5ba14b9 -> a6f32193d


Updated blueprints and managing


Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/30853249
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/30853249
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/30853249

Branch: refs/heads/master
Commit: 30853249d1f01d5b0d754fec31eea8b51ed22cd3
Parents: 5644e28
Author: Duncan Godwin <duncan.godwin@cloudsoftcorp.com>
Authored: Fri Jan 15 11:51:42 2016 +0000
Committer: Duncan Godwin <duncan.godwin@cloudsoftcorp.com>
Committed: Fri Jan 15 12:04:29 2016 +0000

----------------------------------------------------------------------
 brooklyn-docs/guide/start/blueprints.md        | 46 ++++++++++-----------
 brooklyn-docs/guide/start/managing.md          | 44 ++++++++++----------
 brooklyn-docs/guide/start/running.md           |  4 +-
 brooklyn-docs/guide/yaml/test/test-entities.md |  2 +
 4 files changed, 49 insertions(+), 47 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/30853249/brooklyn-docs/guide/start/blueprints.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/start/blueprints.md b/brooklyn-docs/guide/start/blueprints.md
index 90d1d48..0c52de9 100644
--- a/brooklyn-docs/guide/start/blueprints.md
+++ b/brooklyn-docs/guide/start/blueprints.md
@@ -6,14 +6,14 @@ children:
 - { section: Launching from a Blueprint, title: Blueprint } 
 ---
 
-Blueprints are the descriptors or patterns which describe how Apache Brooklyn should deploy
applications.
+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
all of the entities available are defined in the __[Brooklyn Catalog](../../learnmore/catalog/)__.
 
 ## Launching from a Blueprint
 
-We'll start by deploying an application with a simple YAML blueprint containing a Tomcat
server.
+We'll start by deploying an application with a simple YAML blueprint containing an [Apache
Tomcat](https://tomcat.apache.org/){:target="_blank"} server.
 
 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.)
+hover your mouse over the right side of the text box below to get a Javascript "copy" button).
 
 {% highlight yaml %}
 name: Tomcat
@@ -25,9 +25,9 @@ services:
 
 ## Locations
 
-Before you create an application with the configuration you need to modify the YAML to specify
a location. Locations in Apache Brooklyn are server resources Brooklyn can use to deploy applications.
These locations may be servers or cloud providers which provide access to servers. 
+Before you can create an application with this configuration, you need to modify the YAML
to specify a location. Locations in Apache Brooklyn are server resources which Brooklyn can
use to deploy applications. These locations may be servers or cloud providers which provide
access to servers. 
 
-In order to configure the location Apache Brooklyn launches an application, replace the ```location:```
element with values for your chosen target environment, here are some examples for the variouss
location types.
+In order to configure the location in which Apache Brooklyn launches an application, replace
the ```location:``` element with values for your chosen target environment. Here are some
examples of the various location types:
 
 {::options parse_block_html="true" /}
 
@@ -35,21 +35,20 @@ In order to configure the location Apache Brooklyn launches an application,
repl
     <li class="active impl-1-tab"><a data-target="#impl-1, .impl-1-tab" data-toggle="tab"
href="#">Vagrant</a></li>
     <li class="impl-2-tab"><a data-target="#impl-2, .impl-2-tab" data-toggle="tab"
href="#">Clouds</a></li>
     <li class="impl-3-tab"><a data-target="#impl-3, .impl-3-tab" data-toggle="tab"
href="#">BYON</a></li>
-    <li class="impl-4-tab"><a data-target="#impl-4, .impl-4-tab" data-toggle="tab"
href="#">Localhost</a></li>
 </ul>
 
 <div class="tab-content">
 <div id="impl-1" class="tab-pane fade in active">
 
-The Vagrant configuration described in [Running Apache Brooklyn](./running.html), on the
previous page is the **recommended** way of running this tutorial. This configuration comes
with four blank vagrant configurations called byon1 to byon4
+The Vagrant configuration described in [Running Apache Brooklyn](./running.html), on the
previous page is the recommended way of running this tutorial. This configuration comes with
four blank vagrant configurations called byon1 to byon4.
 
-These can be launched by entering the following line into the terminal in the vagrant configuration
directory.
+These can be launched by entering the following command into the terminal in the vagrant
configuration directory.
 
 {% highlight bash %}
  $ vagrant up byon1 byon2 byon3 byon4
 {% endhighlight %}
 
-The location in "myapp.yaml" can then be replaced by the following YAML to launch to these
+The location in "myapp.yaml" can then be replaced with the following YAML to launch using
these.
 
 {% highlight yaml %}
 location:
@@ -66,9 +65,9 @@ location:
 </div>
 <div id="impl-2" class="tab-pane fade">
 
-Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/) to support a range of cloud
locations. More information on the range of providers and configurations is available [here](../ops/locations/#clouds).
+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](../ops/locations/#clouds){:target="_blank"}.
 
-As an example here is a configuration for [Amazon Web Services (AWS)](http://www.aws.amazon.com).
Swap the identity and credential with your AWS account details then replace the location in
your "myapp.yaml" with this.
+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 %}
 location:
@@ -80,7 +79,9 @@ location:
 </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](../ops/locations/#byon). 
+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](../ops/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 %}
 location:
@@ -95,36 +96,35 @@ location:
 {% endhighlight %}
 
 </div>
-<div id="impl-4" class="tab-pane fade">
-
-</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](../ops/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](../ops/locations)__ in the
Operations section of the User Guide.
 
 ## Deploying the Application
 
-First, log in to brooklyn with the command line tool (CLI) by typing:
+First, log in to brooklyn with the command line interface (CLI) tool by typing:
 {% highlight 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](../ops/brooklyn_properties.html). 
-Then the login command will require the additional parameters of the userid and password.
+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](../ops/brooklyn_properties.html){:target="_blank"}.

+If this is configured, the login command will then require additional parameters for the
userid and password.
 
 Now you can create the application with the command below:
 
 {% highlight bash %}
-$ br deploy myapp.yaml
+$ br deploy myapp.yaml 
+{% endhighlight %}
+<pre>
 Id:       hTPAF19s   
 Name:     Tomcat   
-Status:   In progress   
-{% endhighlight %}
+Status:   In progress  
+</pre>
 
 Depending on your choice of location it may take some time for the application to start,
the next page describes how 
-you can monitor the progress of the application deployment and verify its successful deployment.
+you can monitor the progress of the application deployment and verify if it was successful.
 
 ## Next
 

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/30853249/brooklyn-docs/guide/start/managing.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/start/managing.md b/brooklyn-docs/guide/start/managing.md
index da027a7..63742f9 100644
--- a/brooklyn-docs/guide/start/managing.md
+++ b/brooklyn-docs/guide/start/managing.md
@@ -16,28 +16,6 @@ children:
 So far we have touched on Brooklyn's ability to *deploy* an application blueprint to a cloud
provider, but this just 
 the beginning. The sections below outline how to manage the application that has been deployed.
 
-
-## Scopes in CLI commands
-Many commands require a "scope" expression to indicate the target on which they operate.
The scope expressions are
-as follows (values in brackets are aliases for the scope):
-
-- ```application``` APP-ID   (app, a)  
- Selects an application, e.g. "br app myapp"  
-- ```entity```      ENT-ID   (ent, e)  
- Selects an entity within an application scope, e.g. ```br app myapp ent myserver```  
-- ```effector```    EFF-ID   (eff, f)  
- Selects an effector of an entity or application, e.g. ```br a myapp e myserver eff xyz```
 
-- ```config```      CONF-KEY (conf, con, c)  
- Selects a configuration key of an entity e.g. ```br a myapp e myserver config jmx.agent.mode```
 
-- ```activity```    ACT-ID   (act, v)  
- Selects an activity of an entity e.g. ```br a myapp e myserver act iHG7sq1```  
-
-For example
-{% highlight bash %}
-$ br app Tomcat ent TomcatServer:Wx7r config
-{% endhighlight %}
-runs the ```config``` command with application scope of ```Tomcat``` and entity scope of
```TomcatServer:Wx7r```.
-
 ## Applications
 
 Having created the application we can query its status.  We can find a summary of all deployed
apps:
@@ -353,6 +331,28 @@ $ br app Tomcat ent TomcatServer:Wx7r act KLTxDkoa stderr
 {% endhighlight %}
 
 
+## Scopes in CLI commands
+Many commands require a "scope" expression to indicate the target on which they operate.
The scope expressions are
+as follows (values in brackets are aliases for the scope):
+
+- ```application``` APP-ID   (app, a)  
+ Selects an application, e.g. "br app myapp"  
+- ```entity```      ENT-ID   (ent, e)  
+ Selects an entity within an application scope, e.g. ```br app myapp ent myserver```  
+- ```effector```    EFF-ID   (eff, f)  
+ Selects an effector of an entity or application, e.g. ```br a myapp e myserver eff xyz```
 
+- ```config```      CONF-KEY (conf, con, c)  
+ Selects a configuration key of an entity e.g. ```br a myapp e myserver config jmx.agent.mode```
 
+- ```activity```    ACT-ID   (act, v)  
+ Selects an activity of an entity e.g. ```br a myapp e myserver act iHG7sq1```  
+
+For example
+{% highlight bash %}
+$ br app Tomcat ent TomcatServer:Wx7r config
+{% endhighlight %}
+runs the ```config``` command with application scope of ```Tomcat``` and entity scope of
```TomcatServer:Wx7r```.
+
+
 ## Next
 
 We will look next at a slightly more complex example, which will illustrate the capabilities
of Brooklyn's

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/30853249/brooklyn-docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/start/running.md b/brooklyn-docs/guide/start/running.md
index 3fefeb5..74dc687 100644
--- a/brooklyn-docs/guide/start/running.md
+++ b/brooklyn-docs/guide/start/running.md
@@ -7,7 +7,7 @@ menu_parent: index.md
 
 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.
 
-An overview of core [Brooklyn concepts](./concept-quickstart.html) is available for reference.
+An overview of core [Brooklyn concepts](./concept-quickstart.html){:target="_blank"} is available
for reference.
 
 Two methods of deployment are detailed in this tutorial, using virtualisation with Vagrant
and a local install. Both assume that you are using Linux or Mac OS X.
 
@@ -128,7 +128,7 @@ By default it can be accessed by opening [127.0.0.1:8081](http://127.0.0.1:8081)
 
 The rest of this getting started guide uses the Apache Brooklyn command line interface (CLI).
To use this, download and install the tool as described on the [CLI GitHub page](https://github.com/brooklyncentral/brooklyn-cli){:target="_blank"}.
 
-The CLI provides the command `br`, it's full usage is described in the user manual which
can be found [here](../ops/cli/)
+The CLI provides the command `br`, it's full usage is described in the user manual which
can be found [here](../ops/cli/){:target="_blank"}
 
 ## Next
 

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/30853249/brooklyn-docs/guide/yaml/test/test-entities.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/yaml/test/test-entities.md b/brooklyn-docs/guide/yaml/test/test-entities.md
index 2b9fdfe..a81a3d6 100644
--- a/brooklyn-docs/guide/yaml/test/test-entities.md
+++ b/brooklyn-docs/guide/yaml/test/test-entities.md
@@ -37,6 +37,7 @@ Timeouts on child entities should be set relative to the start of the `ParallelT
 The `LoopOverGroupMembersTestCase` entity is configured with a target group and a test specification.
For each member of the targeted group, the test case will create a TargetableTestComponent
entity from the supplied test specification and set the components target to be the group
member.
 
 {% highlight yaml %}
+{% readj example_yaml/entities/loopovergroupmembers-entity.yaml %}
 {% endhighlight %}
 
 #### Parameters
@@ -49,6 +50,7 @@ The `LoopOverGroupMembersTestCase` entity is configured with a target group
and
 The `InfrastructureDeploymentTestCase` will first create and deploy an infrastructure from
the `infrastructure.deployment.spec` config. It will then retrieve a deployment location by
getting the value of the infrastructures `infrastructure.deployment.location.sensor` sensor.
It will then create and deploy all entities from the `infrastructure.deployment.spec` config
to the deployment location.
 
 {% highlight yaml %}
+{% readj example_yaml/entities/infrastructuredeploymenttestcase-entity.yaml %}
 {% endhighlight %}
 
 #### Parameters


Mime
View raw message