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/10/26 12:16:44 UTC
[4/7] incubator-brooklyn git commit: Tidying description of adding to
and deleting from the catalog.
Tidying description of adding to and deleting from the catalog.
Fix the URL example for deleting an application to use .../application instead of .../entity (actually both of them work, but .../application is surely more appropriate for applications).
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/faa5e421
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/faa5e421
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/faa5e421
Branch: refs/heads/master
Commit: faa5e421cd12f9486aa16b72aed72d3916f24e6b
Parents: 9d0648b
Author: Geoff Macartney <ge...@cloudsoftcorp.com>
Authored: Tue Oct 20 10:25:55 2015 +0100
Committer: Geoff Macartney <ge...@cloudsoftcorp.com>
Committed: Tue Oct 20 10:25:55 2015 +0100
----------------------------------------------------------------------
docs/guide/ops/catalog/images/add-to-catalog.png | Bin 0 -> 4919 bytes
docs/guide/ops/catalog/index.md | 13 +++++++++----
2 files changed, 9 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/faa5e421/docs/guide/ops/catalog/images/add-to-catalog.png
----------------------------------------------------------------------
diff --git a/docs/guide/ops/catalog/images/add-to-catalog.png b/docs/guide/ops/catalog/images/add-to-catalog.png
new file mode 100644
index 0000000..0565e7e
Binary files /dev/null and b/docs/guide/ops/catalog/images/add-to-catalog.png differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/faa5e421/docs/guide/ops/catalog/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/catalog/index.md b/docs/guide/ops/catalog/index.md
index dea666f..700b24f 100644
--- a/docs/guide/ops/catalog/index.md
+++ b/docs/guide/ops/catalog/index.md
@@ -238,7 +238,10 @@ The Catalog tab in the web console will show all versions of catalog items,
and allow you to add new items.
-##### Adding to the Catalog
+#### Adding to the Catalog
+
+On the UI the "add" button <img src="images/add-to-catalog.png" width="24" alt="add-to-catalog" /> at the top of the menu panel allows the
+addition of new Applications to the catalog, via YAML, and of new Locations.
In addition to the GUI, items can be added to the catalog via the REST API
with a `POST` of the YAML file to `/v1/catalog` endpoint.
@@ -250,13 +253,15 @@ curl http://127.0.0.1:8081/v1/catalog --data-binary @/path/to/riak.catalog.bom
-##### Deleting from the Catalog
+#### Deleting from the Catalog
+
+On the UI, if an item is selected, a 'Delete' button in the detail panel can be used to delete it from the catalog.
-You can delete a versioned item from the catalog using the same endpoint as the REST API.
+Using the REST API, you can delete a versioned item from the catalog using the corresponding endpoint.
For example, to delete the item with id `datastore` and version `1.0` with `curl`:
~~~ bash
-curl -X DELETE http://127.0.0.1:8081/v1/catalog/entities/datastore/1.0
+curl -X DELETE http://127.0.0.1:8081/v1/catalog/applications/datastore/1.0
~~~
**Note:** Catalog items should not be deleted if there are running apps which were created using the same item.