You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by m4...@apache.org on 2017/10/25 21:05:14 UTC
[29/50] [abbrv] brooklyn-docs git commit: Remove accordions in the
monitoring page
Remove accordions in the monitoring page
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/1ca81c22
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/1ca81c22
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/1ca81c22
Branch: refs/heads/master
Commit: 1ca81c2249967d2ce9306fa80f8e89b6ca18a3ca
Parents: fe43f07
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Authored: Wed Oct 11 13:52:54 2017 +0100
Committer: Thomas Bouron <th...@cloudsoftcorp.com>
Committed: Mon Oct 16 14:56:04 2017 +0100
----------------------------------------------------------------------
guide/start/managing.md | 259 +++++++++++++++++--------------------------
guide/start/running.md | 4 -
2 files changed, 102 insertions(+), 161 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ca81c22/guide/start/managing.md
----------------------------------------------------------------------
diff --git a/guide/start/managing.md b/guide/start/managing.md
index 62736c5..619fe2e 100644
--- a/guide/start/managing.md
+++ b/guide/start/managing.md
@@ -24,42 +24,36 @@ Having created the application, we can find a summary of all deployed applicatio
$ br application
```
-<pre>
+```bash
Id Name Status Location
hTPAF19s Tomcat RUNNING ajVVAhER
-</pre>
+```
```application``` can be shortened to the alias ```app```, for example:
```bash
$ br app
```
-<pre>
+
+```bash
Id Name Status Location
hTPAF19s Tomcat RUNNING ajVVAhER
-</pre>
+```
A full list of abbreviations such as this can be found in the [CLI reference guide](../ops/cli/cli-ref-guide.md#abbreviations).
In the above example the Id `hTPAF19s` and the Name `Tomcat` are shown. You can use either of these handles to monitor and control the application. The Id shown for your application will be different to this but the name should be the same, note that if you are running multiple applications the Name may not be unique.
-#### Things we might want to do
-
-<div class="panel-group" id="accordion">
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordion" href="#collapseOne"><div class="panel-heading">
- <h4 class="panel-title">
- Get the application details
- </h4>
- </div></a>
- <div id="collapseOne" class="panel-collapse collapse in">
- <div class="panel-body">
-<p>
+### Things we might want to do
+
+#### Get the application details
+
Using the name `Tomcat` we can get the application details:
-</p>
+
```bash
$ br application Tomcat
```
-<pre>
+
+```bash
Id: hTPAF19s
Name: Tomcat
Status: RUNNING
@@ -70,75 +64,50 @@ $ br application Tomcat
LocationName: FixedListMachineProvisioningLocation:ajVV
LocationSpec: vagrantbyon
LocationType: org.apache.brooklyn.location.byon.FixedListMachineProvisioningLocation
-</pre>
- </div>
- </div>
- </div>
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordion" href="#collapseTwo"><div class="panel-heading">
- <h4 class="panel-title">
- Explore the hierarchy of all applications
- </h4>
- </div></a>
- <div id="collapseTwo" class="panel-collapse collapse">
- <div class="panel-body">
-<p>
+```
+
+#### Explore the hierarchy of all applications
+
We can explore the management hierarchy of all applications, which will show us the entities they are composed of.
-</p>
+
```bash
$ br tree
```
-<pre>
+
+```text
|- Tomcat
+- org.apache.brooklyn.entity.stock.BasicApplication
|- tomcatServer
+- org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
-</pre>
- </div>
- </div>
- </div>
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordion" href="#collapseThree"><div class="panel-heading">
- <h4 class="panel-title">
- View our application's blueprint
- </h4>
- </div></a>
- <div id="collapseThree" class="panel-collapse collapse">
- <div class="panel-body">
-<p>
+```
+
+#### View our application's blueprint
+
You can view the blueprint for the application again:
-</p>
+
```bash
$ br application Tomcat spec
```
-<pre>
-"name: Tomcat\nlocation:\n mylocation\nservices:\n- serviceType: brooklyn.entity.webapp.tomcat.TomcatServer\n"
-</pre> </div>
- </div>
- </div>
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordion" href="#collapseFour"><div class="panel-heading">
- <h4 class="panel-title">
- View our application's configuration
- </h4>
- </div></a>
- <div id="collapseFour" class="panel-collapse collapse">
- <div class="panel-body">
-<p>
+
+```yaml
+name: Tomcat
+location: mylocation
+services:
+- type: brooklyn.entity.webapp.tomcat.TomcatServer
+```
+
+#### View our application's configuration
+
You can view the configuration of the application:
-</p>
+
```bash
$ br application Tomcat config
```
-<pre>
+```bash
Key Value
camp.template.id l67i25CM
brooklyn.wrapper_app true
-</pre>
- </div>
- </div>
- </div>
- </div>
+```
## Entities
@@ -149,10 +118,10 @@ To list the entities of the application you can use the `entity` or `ent` comman
```bash
$ br application Tomcat entity
```
-<pre>
+```bash
Id Name Type
Wx7r1C4e tomcatServer org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
-</pre>
+```
This shows one entity is available: `tomcatServer`. Note that this is the name we gave the entity in the YAML in [Launching from a Blueprint](blueprints.md#launching-from-a-blueprint) on the previous page.
@@ -161,21 +130,23 @@ You can get summary information for this entity by providing its name (or ID).
```bash
$ br application Tomcat entity tomcatServer
```
-<pre>
+
+```bash
Id: Wx7r1C4e
Name: tomcatServer
Status: RUNNING
ServiceUp: true
Type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
CatalogItemId: null
-</pre>
+```
Also you can see the configuration of this entity with the ```config``` command.
```bash
$ br application Tomcat entity tomcatServer config
```
-<pre>
+
+```bash
Key Value
jmx.agent.mode JMXMP_AND_RMI
brooklyn.wrapper_app true
@@ -183,7 +154,7 @@ camp.template.id yBcQuFZe
onbox.base.dir /home/vagrant/brooklyn-managed-processes
onbox.base.dir.resolved true
install.unique_label TomcatServer_7.0.65
-</pre>
+```
## Sensors
@@ -194,21 +165,23 @@ You can view the sensors available on the application using:
```bash
$ br application Tomcat sensor
```
-<pre>
+
+```bash
Name Description Value
service.isUp Whether the service is active and availability (confirmed and monitored) true
service.notUp.indicators A map of namespaced indicators that the service is not up {}
service.problems A map of namespaced indicators of problems with a service {}
service.state Actual lifecycle state of the service "RUNNING"
service.state.expected Last controlled change to service state, indicating what the expected state should be "running @ 1450356994928 / Thu Dec 17 12:56:34 GMT 2015"
-</pre>
+```
To explore sensors on a specific entity use the `sensor` command with an entity specified:
```bash
$ br application Tomcat entity tomcatServer sensor
```
-<pre>
+
+```bash
Name Description Value
download.addon.urls URL patterns for downloading named add-ons (will substitute things like ${version} automatically)
download.url URL pattern for downloading the installer (will substitute things like ${version} automatically) "http://download.nextag.com/apache/tomcat/tomcat-7/v${version}/bin/apache-tomcat-${version}.tar.gz"
@@ -219,7 +192,7 @@ host.sshAddress user@host:port for ssh'ing (or null if inappropriate)
host.subnet.address Host address as known internally in the subnet where it is running (if different to host.name) "10.10.10.101"
host.subnet.hostname Host name as known internally in the subnet where it is running (if different to host.name) "10.10.10.101"
# etc. etc.
-</pre>
+```
To display the value of a selected sensor, give the command the sensor name as an argument
@@ -227,10 +200,10 @@ To display the value of a selected sensor, give the command the sensor name as a
```bash
$ br application Tomcat entity tomcatServer sensor webapp.url
```
-<pre>
-"http://10.10.10.101:8080/"
-</pre>
+```text
+http://10.10.10.101:8080/
+```
## Effectors
@@ -239,12 +212,13 @@ Effectors are a means by which you can manipulate the entities in an application
```bash
$ br application Tomcat effector
```
-<pre>
+
+```bash
Name Description Parameters
restart Restart the process/service represented by an entity
start Start the process/service represented by an entity locations
stop Stop the process/service represented by an entity
-</pre>
+```
For example, to stop an application, use the ```stop``` effector. This will cleanly shutdown all components in the application and return any cloud machines that were being used.
Note that the three "lifecycle" related effectors, ```start```, ```stop```, and ```restart```, are common to all applications and software process entities in Brooklyn.
@@ -254,7 +228,8 @@ You can list the effectors for a specific entity using the command:
```bash
$ br application Tomcat entity tomcatServer effector
```
-<pre>
+
+```bash
Name Description Parameters
deploy Deploys the given artifact, from a source URL, to a given deployment filename/context url,targetName
populateServiceNotUpDiagnostics Populates the attribute service.notUp.diagnostics, with any available health indicators
@@ -262,17 +237,18 @@ restart Restart the process/service represented by an
start Start the process/service represented by an entity locations
stop Stop the process/service represented by an entity stopProcessMode,stopMachineMode
undeploy Undeploys the given context/artifact targetName
-</pre>
+```
To view the details for a specific effector, append it's name to the command:
```bash
$ br application Tomcat entity tomcatServer effector deploy
```
-<pre>
+
+```bash
Name Description Parameters
deploy Deploys the given artifact, from a source URL, to a given deployment filename/context url,targetName
-</pre>
+```
These effectors can also be invoked by appending ```invoke``` to this command. Some effectors require parameters for their invocation. For example, if we look at the details for ```deploy``` above we can see it requires a url and targetName.
@@ -286,11 +262,14 @@ $ br application Tomcat entity tomcatServer effector deploy invoke -P url=https:
$ webapp=$(br application Tomcat entity tomcatServer sensor webapp.url | tr -d '"')
$ curl $webapp/sample/
```
- <html>
- <head>
- <title>Sample "Hello, World" Application</title>
- </head>
- ...
+
+```html
+<html>
+<head>
+<title>Sample "Hello, World" Application</title>
+</head>
+...
+```
**Note** that at present a ```tr``` command is required in the second line below to strip quotation characters from the returned sensor value.
@@ -303,7 +282,8 @@ To view a list of all activities associated with an entity enter:
```bash
$ br application Tomcat entity tomcatServer activity
```
-<pre>
+
+```bash
Id Task Submitted Status Streams
LtD5P1cb start Thu Dec 17 15:04:43 GMT 2015 Completed
l2qo4vTl provisioning (FixedListMachineProvisi... Thu Dec 17 15:04:43 GMT 2015 Completed
@@ -311,14 +291,15 @@ wLD764HE pre-start Thu Dec 17 15:04:43 GMT 20
KLTxDkoa ssh: initializing on-box base dir ./b... Thu Dec 17 15:04:43 GMT 2015 Completed env,stderr,stdin,stdout
jwwcJWmF start (processes) Thu Dec 17 15:04:43 GMT 2015 Completed
...
-</pre>
+```
To view the details of an individual activity, add its ID to the command. In our case this is `jwwcJWmF`
```bash
$ br application Tomcat entity tomcatServer activity jwwcJWmF
```
-<pre>
+
+```bash
Id: jwwcJWmF
DisplayName: start (processes)
Description:
@@ -335,78 +316,50 @@ Streams:
DetailedStatus: "Completed after 4m 16s
No return value (null)"
-</pre>
+```
+### Things we might want to do
-#### Things we might want to do
+#### View Input and Output Streams
-<div class="panel-group" id="accordionB">
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordionB" href="#collapseOneB"><div class="panel-heading">
- <h4 class="panel-title">
- View Input and Output Streams
- </h4>
- </div></a>
- <div id="collapseOneB" class="panel-collapse collapse in">
- <div class="panel-body">
-<p>
If an activity has associated input and output streams, these may be viewed by providing the activity scope and
using the commands, "env", "stdin", "stdout", and "stderr". For example, for the "initializing on-box base dir"
activity from the result of the earlier example,
-</p>
+
```bash
$ br application Tomcat entity tomcatServer act KLTxDkoa stdout
```
-<pre>
+
+```bash
BASE_DIR_RESULT:/home/vagrant/brooklyn-managed-processes:BASE_DIR_RESULT
-</pre>
- </div>
- </div>
- </div>
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordionB" href="#collapseTwoB"><div class="panel-heading">
- <h4 class="panel-title">
- Monitor the progress of an effector
- </h4>
- </div></a>
- <div id="collapseTwoB" class="panel-collapse collapse">
- <div class="panel-body">
-
-<p>
+```
+
+#### Monitor the progress of an effector
+
To monitor progress on an application as it deploys, for example, one could use a shell loop:
-</p>
+
```bash
$ while br application Tomcat entity tomcatServer activity | grep 'In progress' ; do
sleep 1; echo ; date;
done
```
-<p>
+
This loop will exit when the application has deployed successfully or has failed. If it fails then the 'stderr'
command may provide information about what happened in any activities that have associated streams:
-</p>
+
```bash
$ br application Tomcat entity tomcatServer act KLTxDkoa stderr
-```
-
- </div>
- </div>
- </div>
- <div class="panel panel-default">
- <a data-toggle="collapse" data-parent="#accordionB" href="#collapseThreeB"><div class="panel-heading">
- <h4 class="panel-title">
- Diagnose a failure
- </h4>
- </div></a>
- <div id="collapseThreeB" class="panel-collapse collapse">
- <div class="panel-body">
-
-<p>
+```
+
+#### Diagnose a failure
+
If an activity has failed, the "DetailedStatus" value will help us diagnose what went wrong by showing information about the failure.
-</p>
+
```bash
$ br application evHUlq0n entity tomcatServer activity lZZ9x662
```
-<pre>
+
+```bash
Id: lZZ9x662
DisplayName: post-start
Description:
@@ -434,15 +387,16 @@ java.lang.IllegalStateException: Software process entity TomcatServerImpl{id=qZe
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
at java.lang.Thread.run(Thread.java:745)"
-</pre>
-<p>
+```
+
Adding the "--children" or "-c" parameter will show the activity's child activities, to allow the hierarchical structure
of the activities to be investigated:
-</p>
+
```bash
$ br application Tomcat entity tomcatServer activity -c jwwcJWmF
```
-<pre>
+
+```bash
Id Task Submitted Status
UpYRc3fw copy-pre-install-resources Thu Dec 17 15:04:43 GMT 2015 Completed
ig8sBHQr pre-install Thu Dec 17 15:04:43 GMT 2015 Completed
@@ -457,15 +411,8 @@ STavcRc8 pre-launch-command Thu Dec 17 15:08:58 GMT 2015 Completed
HKrYfH6h launch Thu Dec 17 15:08:58 GMT 2015 Completed
T1m8VXbq post-launch-command Thu Dec 17 15:08:59 GMT 2015 Completed
n8eK5USE post-launch Thu Dec 17 15:08:59 GMT 2015 Completed
-</pre>
-
- </div>
- </div>
- </div>
- </div>
-
+```
-{::comment}
## 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):
@@ -487,8 +434,6 @@ $ br application Tomcat entity tomcatServer config
```
runs the ```config``` command with application scope of ```Tomcat``` and entity scope of ```tomcatServer```.
-{:/comment}
-
## 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/brooklyn-docs/blob/1ca81c22/guide/start/running.md
----------------------------------------------------------------------
diff --git a/guide/start/running.md b/guide/start/running.md
index c9c3bb9..0039316 100644
--- a/guide/start/running.md
+++ b/guide/start/running.md
@@ -115,8 +115,6 @@ Extract this zip file to a directory on your computer such as `c:\Program Files\
{% endmethod %}
----
-
By default, no authentication is required and the web-console will listen on all network interfaces.
For a production system, or if Apache Brooklyn is publicly reachable, it is strongly recommended
to configure security. Documentation of configuration options include:
@@ -192,8 +190,6 @@ Even several minutes before or after the actual time could cause problems._
{% endmethod %}
----
-
## Control Apache Brooklyn
Apache Brooklyn has a web console which can be used to control the application. The Brooklyn log will contain the