[GitHub] brooklyn-ui pull request: Location wizard
Github user shartzel commented on the pull request: https://github.com/apache/brooklyn-ui/pull/17#issuecomment-198190837 sorry for the late reply; re: localhost, if I'm following, I believe I agree with what @ahgittin is saying. I understand the logic in remaining consistent with the top level cloud v byon v localhost, but I think it should be compressed away to one flow. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] incubator-brooklyn pull request: DO NOT MERGE - "Getting Started" ...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1116#discussion_r48182162
--- Diff: docs/guide/start/blueprints-cli.md ---
@@ -0,0 +1,80 @@
+---
+title: Deploying Blueprints
+layout: website-normal
+menu_parent: index-cli.md
+children:
+- { section: Launching from a Blueprint, title: Blueprint }
+- { section: Launching from the Catalog, title: Catalog }
+---
+
+
+## Launching from a Blueprint
+
+We'll start by deploying an application with a simple YAML blueprint
containing a Tomcat server.
+
+Copy the blueprint below into a text file, "myapp.yaml", in your
workspace, but *before* you create an application with
+it, modify the YAML to specify the location where the application will be
deployed. (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 %}
+name: Tomcat
+location:
+ jclouds:aws-ec2:
+identity: ABCDEFGHIJKLMNOPQRST
+credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
+services:
+- serviceType: brooklyn.entity.webapp.tomcat.TomcatServer
+{% endhighlight %}
+
+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:softlayer:
+identity: ABCDEFGHIJKLMNOPQRST
+credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
+{% endhighlight %}
+
+Or, if you already have machines provisioned, you can use the "bring your
own nodes" (byon) approach.
+Of course, replace the identity and address values below with your own
values.
+{% highlight yaml %}
+location:
+ byon:
+user: myuser
+password: mypassword
+# or...
+#privateKeyFile: ~/.ssh/my.pem
+hosts:
+- 192.168.0.18
+- 192.168.0.19
+{% endhighlight %}
+
+**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.
+(For the application above, if you are using a "Bring your own Nodes"
location, you will need at least three nodes.)
+
+First you will have to log in to brooklyn:
+{% highlight bash %}
+$ br login http://localhost:8081/
+{% endhighlight %}
+
+To secure the server you can add a username and password in Brooklyn's
properties file, as described in the User Guide.
+Then the login command will require the additional parameters of the
userid and password.
+
+Now you can create the application with the command below:
+
+{% highlight bash %}
+$ br deploy myapp.yaml
+Id: hTPAF19s
+Name: Tomcat
+Status: In progress
+{% endhighlight %}
+
+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.
+
+
+## Launching from the Catalog
+TODO
--- End diff --
Will the "TODO" be done (or removed) before publication?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: DO NOT MERGE - "Getting Started" ...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1116#discussion_r48183457
--- Diff: docs/guide/start/policies-cli.md ---
@@ -0,0 +1,172 @@
+---
+title: Getting Started - Policies
+title_in_menu: Policies
+layout: website-normal
+menu-parent: index-cli.md
+---
+
+
+
+
+## A Clustered Example
+
+We'll now look at a more complex example that better shows the
capabilities of Brooklyn.
+
+We'll start by deploying an application via YAML blueprint consisting of
the following layers.
+
+- A dynamically scalable Web App Cluster
+- A MySQL DB
+
+
+Copy the blueprint below into a text file, "mycluster.yaml", in your
workspace, but *before* you create an application
+with it, again modify the YAML to specify the location where the
application will be deployed.
+You will need at least five machines for this example, one for the DB, and
four for the tomcats
+(but you can reduce this by changing the "maxPoolSize" below.
+
+{% highlight yaml %}
+name: cluster
+
+location:
+ tbd
--- End diff --
Thoughts on changing this to a note reminding the reader to fill in the
location details? Or the ec2 or softlayer ABCDE... style?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192437
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
--- End diff --
this is the version of the CLI client, right? If so, should probably be
made explicit here.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: DO NOT MERGE - "Getting Started" ...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1116#discussion_r48184016
--- Diff: docs/guide/start/policies-cli.md ---
@@ -0,0 +1,172 @@
+---
+title: Getting Started - Policies
+title_in_menu: Policies
+layout: website-normal
+menu-parent: index-cli.md
+---
+
+
+
+
+## A Clustered Example
+
+We'll now look at a more complex example that better shows the
capabilities of Brooklyn.
+
+We'll start by deploying an application via YAML blueprint consisting of
the following layers.
+
+- A dynamically scalable Web App Cluster
+- A MySQL DB
+
+
+Copy the blueprint below into a text file, "mycluster.yaml", in your
workspace, but *before* you create an application
+with it, again modify the YAML to specify the location where the
application will be deployed.
+You will need at least five machines for this example, one for the DB, and
four for the tomcats
+(but you can reduce this by changing the "maxPoolSize" below.
+
+{% highlight yaml %}
+name: cluster
+
+location:
+ tbd
+
+services:
+- serviceType: brooklyn.entity.webapp.ControlledDynamicWebAppCluster
+ name: webcluster
+ brooklyn.config:
+wars.root:
http://search.maven.org/remotecontent?filepath=io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.6.0-M2/brooklyn-example-hello-world-sql-webapp-0.6.0-M2.war
+http.port: 9280+
+proxy.http.port: 9210+
+java.sysprops:
+ brooklyn.example.db.url:
$brooklyn:formatString("jdbc:%s%s?user=%s\\=%s",
+ component("db").attributeWhenReady("datastore.url"), "visitors",
"brooklyn", "br00k11n")
+ brooklyn.policies:
+ - policyType: brooklyn.policy.autoscaling.AutoScalerPolicy
+brooklyn.config:
+ metric:
$brooklyn:sensor("brooklyn.entity.webapp.DynamicWebAppCluster",
"webapp.reqs.perSec.windowed.perNode")
+ metricLowerBound: 10
+ metricUpperBound: 100
+ minPoolSize: 1
+ maxPoolSize: 4
+
+- serviceType: brooklyn.entity.database.mysql.MySqlNode
+ id: db
+ name: mysql
+ location: localhost
+ brooklyn.config:
+creationScriptUrl: https://bit.ly/brooklyn-visitors-creation-script
+{% endhighlight %}
+
+Explore this app using the 'application' and other commands from the
previous section.
+
+## Configuring Dependencies
+The App above illustrates how one component in a blueprint can be
configured with information relating to one of the other
+components in the blueprint. In this example the web cluster is
configured with a URL for JDBC connections to the database.
+{% highlight yaml %}
+java.sysprops:
+ brooklyn.example.db.url:
$brooklyn:formatString("jdbc:%s%s?user=%s\\=%s",
+ component("db").attributeWhenReady("datastore.url"), "visitors",
"brooklyn", "br00k11n")
+{% endhighlight %}
+
+the syntax ```$brooklyn:formatString(...)``` is an example of the Brooklyn
DSL (Domain Specific Language) which
+allows expressions referring to Brooklyn's management information to be
embedded in blueprints. The line above also illustrates the use of Brooklyn's
```component(...)``` and ```attributeWhenReady(...)``` to get an identified
component from a deployment, and to wait until the component is fully deployed
before reading one of its sensors ("datastore.url" in this case).
+
+## Managing with Policies
+
+
+The app server cluster has an `AutoScalerPolicy`and the loadbalancer has a
`Controller targets tracker` policy.
+
+For example
+{% highlight yaml %}
+$ br app cluster ent webcluster policy
+Id Name State
+mMZngBnb org.apache.brooklyn.policy.autoscaling.AutoScalerPolicy
RUNNING
+{% endhighlight %}
+
+You can investigate the status of the `AutoScalerPolicy` with
+
+{% highlight yaml %}
+$ br app cluster ent webcluster policy
org.apache.brooklyn.policy.autoscaling.AutoScalerPolicy
+"RUNNING"
+{% endhighlight %}
+
+A more detailed description of the parameters of the policy can be
obtained with
+{% highlight yaml %}
+$ br app cluster ent webcluster policy
org.apache.brooklyn.policy.autoscaling.AutoScalerPolicy
--- End diff --
should there be a PolicyID at the EOL here?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: DO NOT MERGE - "Getting Started" ...
Github user shartzel commented on the pull request: https://github.com/apache/incubator-brooklyn/pull/1116#issuecomment-166403842 Minor nits and questions. Looks good. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192801
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192824
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48193000
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
--- End diff --
This section is a great way to explain the scope expressions.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192813
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192788
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192896
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192891
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: Add CLI documentation to the Oper...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192836
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ access Show access control
+ activityShow the activity for an application / entity
+ add-catalog * Add a new catalog item from the supplied YAML
+ add-children* Add a child or children to this entity from
the supplied YAML
+ application Show the status and location of running
applications
+ catalog * List the available catalog applications
+ config Show the config for an application or entity
+ delete * Delete (expunge) a brooklyn application
+ deploy Deploy a new application from the given YAML (read from
file or stdin)
+ destroy-policy Destroy a policy
+ effectorShow the effectors for an application or entity
+ entity Show the entities of an application or entity
+ env Show the ENV stream for a given activity
+ invoke Invoke an effector of an application and entity
+ locations * List the available locations
+ login Login to brooklyn
+ policy Show the policies for an application or entity
+ rename Rename an application or entity
+ restart Invoke restart effector on an application and entity
+ sensor Show values of all sensors or named sensor for an
application or entity
+ set Set config for an entity
+ specGet the YAML spec used to create the entity, if
available
+ start Invoke start effector on an application and entity
+ start-policyStart or resume a policy
+ stderr Show the STDERR stream for a given activity
+ stdin Show the STDIN stream for a given activity
+ stdout Show the STDOUT stream for a given activity
+ stopInvoke stop effector on an application and
entity
+ stop-policy Suspends a policy
+ tree* Show the tree of all applications
+ version Display the version of the connected Brooklyn
+ help
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of ``.
+The various scopes should be replaced on the command line as:
+
+- ``
+ `application <Name|AppID>`
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- ``
+ `application <Name|AppID> effector `
+ `application <Name|AppID> entity <Name|EntityID> effector `
+
+- ``
+ `application <Name|AppID> entity <Name|EntityID> config `
+
+- ``
+ `activity `
+ `application <Name|AppID> entity <Name|EntityID> activity `
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the c
[GitHub] incubator-brooklyn pull request: DO NOT MERGE - "Getting Started" ...
Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1116#discussion_r48180991
--- Diff: docs/guide/start/managing-cli.md ---
@@ -0,0 +1,309 @@
+---
+title: Monitoring and Managing Applications
+title_in_menu: Monitoring and Managing Applications
+layout: website-normal
+menu_parent: index-cli.md
+children:
+- { section: Applications }
+- { section: Entities }
+- { section: Sensors }
+- { section: Effectors }
+- { section: Activities }
+---
+
+
+
+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.
+
+## Applications
+
+Having created the application we can query its status. We can find a
summary of all deployed apps:
+{% highlight bash %}
+$ br app
+ Id Name StatusLocation
+ hTPAF19s Tomcat RUNNING ajVVAhER
+{% endhighlight %}
+
+or the details of a given app. The ID, hTPAF19s, can also be used instead
of the name "Tomcat".
+{% highlight bash %}
+$ br app Tomcat
+ Id: hTPAF19s
+ Name:Tomcat
+ Status: RUNNING
+ ServiceUp: true
+ Type:org.apache.brooklyn.entity.stock.BasicApplication
+ CatalogItemId: null
+ LocationId: ajVVAhER
+ LocationName:FixedListMachineProvisioningLocation:ajVV
+ LocationSpec:vagrantbyon
+ LocationType:
org.apache.brooklyn.location.byon.FixedListMachineProvisioningLocation
+{% endhighlight %}
+
+To ease management of multiple applications, or even to reduce the amount
of typing required, it is convenient
--- End diff --
l43-49 can probably be dropped. It's a small digression from the flow that
we don't revisit anywhere following.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
