brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [1/2] brooklyn-docs git commit: Extend catalog include docs
Date Fri, 13 May 2016 12:07:31 GMT
Repository: brooklyn-docs
Updated Branches:
  refs/heads/master 50546b71d -> d0376bdaa


Extend catalog include docs


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

Branch: refs/heads/master
Commit: a67a2849200a7348e7b195cb2aff684ff179ef79
Parents: 56ed2ce
Author: Svetoslav Neykov <svetoslav.neykov@cloudsoftcorp.com>
Authored: Tue May 10 15:44:00 2016 +0300
Committer: Svetoslav Neykov <svetoslav.neykov@cloudsoftcorp.com>
Committed: Tue May 10 15:44:00 2016 +0300

----------------------------------------------------------------------
 guide/ops/catalog/index.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/a67a2849/guide/ops/catalog/index.md
----------------------------------------------------------------------
diff --git a/guide/ops/catalog/index.md b/guide/ops/catalog/index.md
index 96ff521..94e30aa 100644
--- a/guide/ops/catalog/index.md
+++ b/guide/ops/catalog/index.md
@@ -89,7 +89,21 @@ In addition to the above fields, exactly **one** of the following is also
requir
   if there are references between items, then order is important, 
   `items` are processed in order, depth-first, and forward references are not supported.
Entries
   can be URL to another catalog file to include, inheriting the meta from the current hierarchy.
-  Libraries defined so far in the meta will be used to load classpath entries.
+  Libraries defined so far in the meta will be used to load classpath entries. For example:
+
+~~~ yaml
+brooklyn.catalog:
+  displayName: Foo
+  brooklyn.libraries:
+  - http://some.server.or.other/path/my.jar
+  items:
+  - classpath://my-catalog-entries-inside-jar.bom
+  - some-property: value
+    include: classpath://more-catalog-entries-inside-jar.bom
+  - id: use-from-my-catalog
+    item:
+      type: some-type-defined-in-my-catalog-entries
+~~~
 
 The following optional catalog metadata is supported:
   
@@ -129,7 +143,9 @@ The following optional catalog metadata is supported:
   and if entities have been deployed against that version, their behavior may change in subtle
or potentially incompatible ways.
   To avoid this situation, it is highly recommended to use OSGi version stamps as part of
the URL.
 - `include`: A URL to another catalog file to include, inheriting the meta from the current
hierarchy.
-  Libraries defined so far in the meta will be used to load classpath entries.
+  Libraries defined so far in the meta will be used to load classpath entries. `include`
must be used
+  when you have sibling properties. If it's the only property it may be skipped by having
the URL as the
+  value - see `items` example above.
 
 
 #### Catalog YAML Examples


Mime
View raw message