You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by sv...@apache.org on 2016/10/26 05:37:58 UTC
[1/2] brooklyn-docs git commit: Documentation updates for
https://github.com/apache/brooklyn-client/pull/29.
Repository: brooklyn-docs
Updated Branches:
refs/heads/master 906f43f97 -> 928d62d34
Documentation updates for https://github.com/apache/brooklyn-client/pull/29.
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/e26b97d4
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/e26b97d4
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/e26b97d4
Branch: refs/heads/master
Commit: e26b97d4d3ed86f2348ffe2a3f092c6fe8297733
Parents: 906f43f
Author: Geoff Macartney <ge...@cloudsoftcorp.com>
Authored: Tue Oct 25 12:58:28 2016 +0100
Committer: Geoff Macartney <ge...@cloudsoftcorp.com>
Committed: Tue Oct 25 12:58:28 2016 +0100
----------------------------------------------------------------------
guide/java/archetype.md | 2 +-
guide/java/defining-and-deploying.md | 2 +-
guide/ops/catalog/index.md | 2 +-
guide/ops/cli/cli-ref-guide.md | 37 ++++++++++++++++++-------------
guide/ops/cli/cli-usage-guide.md | 4 +++-
5 files changed, 28 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e26b97d4/guide/java/archetype.md
----------------------------------------------------------------------
diff --git a/guide/java/archetype.md b/guide/java/archetype.md
index 8f51410..4bc7325 100644
--- a/guide/java/archetype.md
+++ b/guide/java/archetype.md
@@ -87,7 +87,7 @@ brooklyn.catalog:
The command below will use the CLI to add this to the catalog of a running Brooklyn instance:
{% highlight bash %}
- br add-catalog catalog.bom
+ br catalog add catalog.bom
{% endhighlight %}
After running that command, the OSGi bundle will have been added to the OSGi container, and the
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e26b97d4/guide/java/defining-and-deploying.md
----------------------------------------------------------------------
diff --git a/guide/java/defining-and-deploying.md b/guide/java/defining-and-deploying.md
index 4e6fc62..8c1fc6e 100644
--- a/guide/java/defining-and-deploying.md
+++ b/guide/java/defining-and-deploying.md
@@ -157,7 +157,7 @@ Substitute the credentials, URL and port for those of your server.
{% highlight bash %}
$ br login https://127.0.0.1:8443 admin pa55w0rd
-$ br add-catalog gist_generator.bom
+$ br catalog add gist_generator.bom
{% endhighlight %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e26b97d4/guide/ops/catalog/index.md
----------------------------------------------------------------------
diff --git a/guide/ops/catalog/index.md b/guide/ops/catalog/index.md
index 80e1b2c..355e84b 100644
--- a/guide/ops/catalog/index.md
+++ b/guide/ops/catalog/index.md
@@ -322,7 +322,7 @@ curl -u admin:password http://127.0.0.1:8081/v1/catalog --data-binary @/path/to/
Or using the CLI:
~~~ bash
-br add-catalog /path/to/riak.catalog.bom
+br catalog add /path/to/riak.catalog.bom
~~~
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e26b97d4/guide/ops/cli/cli-ref-guide.md
----------------------------------------------------------------------
diff --git a/guide/ops/cli/cli-ref-guide.md b/guide/ops/cli/cli-ref-guide.md
index 1148f57..e3b8c97 100644
--- a/guide/ops/cli/cli-ref-guide.md
+++ b/guide/ops/cli/cli-ref-guide.md
@@ -33,15 +33,19 @@ and likely to change in upcoming releases.
{% highlight text %}
COMMANDS:
+ Commands whose description begins with a "*" character are particularly experimental and likely to change in upcoming
+ releases. If not otherwise specified, "SCOPE" below means application or entity scope. If an entity scope is not
+ specified, the application entity is used as a default.
+
access Show access control
activity Show the activity for an application / entity
- add-catalog * Add a new catalog item from the supplied YAML
+ add-catalog (deprecated, use catalog add) Add a new catalog item from the supplied YAML (a file or http URL)
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
+ catalog Catalog operations
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)
+ deploy Deploy a new application from the given YAML (read from file or URL, or stdin)
destroy-policy Destroy a policy
effector Show the effectors for an application or entity
entity Show the entities of an application or entity
@@ -65,8 +69,9 @@ COMMANDS:
tree * Show the tree of all applications
version Display the version of the connected Brooklyn
help
-
+
GLOBAL OPTIONS:
+ --skipSslChecks Skip verification of server's certificate chain and hostname (for use with self-signed certs)
--help, -h show help
--version, -v print the version
{% endhighlight %}
@@ -119,8 +124,8 @@ policy pol
### Applications
-- `br deploy ( <FILE> | - )`
- Deploy an application based on the supplied YAML file or read from STDIN when `-` is given instead of a file name.
+- `br deploy ( <FILE|URL> | - )`
+ Deploy an application based on the supplied YAML file or URL, or read from STDIN when `-` is given instead of a file name.
- `br application`
List the running applications.
@@ -288,7 +293,6 @@ policy pol
### Miscellaneous
-These commands are likely to change significantly or be removed in later versions of the Brooklyn CLI.
#### Applications
@@ -297,19 +301,22 @@ These commands are likely to change significantly or be removed in later version
#### Entities
-- `br <entity-scope> add-children <FILE>`
- Add a child or children to the entity from a YAML file.
+- `br <entity-scope> add-children <FILE|URL>`
+ Add a child or children to the entity from local YAML file or a URL.
#### Catalog
-- `br catalog`
- List the application catalog.
-
-- `br add-catalog <FILE>`
- Add a catalog entry from a YAML file.
+- `br catalog list <TYPE>`
+ List the application catalog, where `TYPE` is one of "application", "entity", "location", or "policy"
+
+- `br catalog delete <TYPE> <ITEM_ID:VERSION>`
+ Delete an item from the catalog, where `TYPE` is as above, and supplying the item's id and version
+
+- `br catalog add <FILE|URL>`
+ Add catalog entries from a local YAML file or a URL. The id and version of added entries are displayed.
- `br locations`
- List the location catalog.
+ List the location catalog. (Includes all locations including those defined in `brooklyn.properties`)
- `br access`
Show if you have access to provision locations.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e26b97d4/guide/ops/cli/cli-usage-guide.md
----------------------------------------------------------------------
diff --git a/guide/ops/cli/cli-usage-guide.md b/guide/ops/cli/cli-usage-guide.md
index 95a329c..ae1c69e 100644
--- a/guide/ops/cli/cli-usage-guide.md
+++ b/guide/ops/cli/cli-usage-guide.md
@@ -18,7 +18,9 @@ by using the CLI to deploy an application then examine various aspects of it.
The YAML blueprint for the application that will be deployed is shown at the end of this document.
-**NOTE:** In the sample output, some additional line-wrapping has been used to aid readabilty.
+**NOTE:** In the sample output, some additional line-wrapping has been used to aid readabilty. Additionally, the
+vertical bar character is omitted from table output for readability. For scripting purposes it can be useful in
+conjunction with a shell pipeline like `some_command | cut -f 1 -d '|' | xargs -L1 some_other_command`.
## Login
First, login to the running Brooklyn server. This example assumes that the Brooklyn server
[2/2] brooklyn-docs git commit: Closes #118
Posted by sv...@apache.org.
Closes #118
Docs updates for "br" usability improvements
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/928d62d3
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/928d62d3
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/928d62d3
Branch: refs/heads/master
Commit: 928d62d349bc4470bf69460c3c188ad7b05de0c1
Parents: 906f43f e26b97d
Author: Svetoslav Neykov <sv...@neykov.name>
Authored: Wed Oct 26 08:37:21 2016 +0300
Committer: Svetoslav Neykov <sv...@neykov.name>
Committed: Wed Oct 26 08:37:21 2016 +0300
----------------------------------------------------------------------
guide/java/archetype.md | 2 +-
guide/java/defining-and-deploying.md | 2 +-
guide/ops/catalog/index.md | 2 +-
guide/ops/cli/cli-ref-guide.md | 37 ++++++++++++++++++-------------
guide/ops/cli/cli-usage-guide.md | 4 +++-
5 files changed, 28 insertions(+), 19 deletions(-)
----------------------------------------------------------------------