brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [07/21] incubator-brooklyn git commit: Parameters docs
Date Mon, 09 Nov 2015 12:55:16 GMT
Parameters docs


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

Branch: refs/heads/master
Commit: 5a69cd68796d041ea8608fb510f70344c5586e1c
Parents: 9b98543
Author: Svetoslav Neykov <svetoslav.neykov@cloudsoftcorp.com>
Authored: Tue Nov 3 17:58:23 2015 +0200
Committer: Svetoslav Neykov <svetoslav.neykov@cloudsoftcorp.com>
Committed: Thu Nov 5 15:23:38 2015 +0200

----------------------------------------------------------------------
 docs/guide/ops/catalog/index.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5a69cd68/docs/guide/ops/catalog/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/catalog/index.md b/docs/guide/ops/catalog/index.md
index 700b24f..b738954 100644
--- a/docs/guide/ops/catalog/index.md
+++ b/docs/guide/ops/catalog/index.md
@@ -111,6 +111,31 @@ The following optional catalog metadata is supported:
   This feature is experimental and may change or be removed.
   Also note that external OSGi dependencies are not supported 
   and other metadata (such as versions, etc) may not be applied.
+- `brooklyn.parameters`: a list of parameters the blueprint accepts. The items have
+  the following properties:
+  - `name` (required): identifier by which to reference the parameter when setting
+    or retrieving its value
+  - `label`: a value to present to the user, same as `name` if empty
+  - `description`: Short text describing the parameter behaviour/usage, presented
+    to the user
+  - `type`: the type of the parameter, one of `string`, `integer`, `long`, `float`,
+    `double`, `timestamp`, `port`, a fully qualified Java type name. Default is `string`.
+  - `default`: a default value, converted to the type above
+  - `constraints`: a list of constraints the parameter should meet, currently
+    `required` is supported
+  A shorthand notation is also supported where the name of the parameter is directly
+  passed as an item in the list. For example:
+
+~~~ yaml
+brooklyn.properties:
+- displayName
+- name: user.name
+  constraints:
+  - required
+- name: user.age
+  type: integer
+~~~
+
 - `brooklyn.libraries`: a list of pointers to OSGi bundles required for the catalog item.
   This can be omitted if blueprints are pure YAML and everything required is included in
the classpath and catalog.
   Where custom Java code or bundled resources is needed, however, OSGi JARs supply


Mime
View raw message