You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by dr...@apache.org on 2017/04/10 11:35:33 UTC
[1/2] brooklyn-docs git commit: BROOKLYN-460: Brooklyn Camp syntax
guidance
Repository: brooklyn-docs
Updated Branches:
refs/heads/master a0b2263a4 -> 57746af03
BROOKLYN-460: Brooklyn Camp syntax guidance
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/733dcb5b
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/733dcb5b
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/733dcb5b
Branch: refs/heads/master
Commit: 733dcb5bd606ea335f91b69c8da17bcda6bf8e14
Parents: 2453ea5
Author: Valentin Aitken <bo...@gmail.com>
Authored: Thu Apr 6 16:08:55 2017 +0300
Committer: Valentin Aitken <bo...@gmail.com>
Committed: Mon Apr 10 14:33:08 2017 +0300
----------------------------------------------------------------------
guide/yaml/yaml-reference.md | 40 ++++++++++++++++++++-------------------
1 file changed, 21 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/733dcb5b/guide/yaml/yaml-reference.md
----------------------------------------------------------------------
diff --git a/guide/yaml/yaml-reference.md b/guide/yaml/yaml-reference.md
index fd63d34..c72d055 100644
--- a/guide/yaml/yaml-reference.md
+++ b/guide/yaml/yaml-reference.md
@@ -79,38 +79,40 @@ the entity being defined, with these being the most common:
* `default`: a default value; this will be coerced to the declared `type`
* `pinned`: mark the parameter as pinned (always displayed) for the UI. The default is `true`
* `constraints`: a list of constraints the parameter should meet;
- for details, see [Entity Configuration]({{ site.path.guide }}/yaml/entity-configuration.html#config-key-constraints).
+ for details, see [Entity Configuration]({{ site.path.guide }}/yaml/entity-configuration.html#config-key-constraints).
A shorthand notation is also supported where just the name of the parameter is supplied
as an item in the list, with the other values being unset or the default.
See `displayName` in the following example for an illustration of this:
-~~~ yaml
-brooklyn.parameters:
-# user.age parameter is required, pinned and fully specified
-- name: user.age
+ ~~~ yaml
+ brooklyn.parameters:
+ # user.age parameter is required, pinned and fully specified
+ - name: user.age
type: integer
label: Age
description: the age of the user
pinned: true
constraints:
- required
-# user.name is optional, is not pinned and has a default
-- name: user.name
+ # user.name is optional, is not pinned and has a default
+ - name: user.name
default: You
pinned: false
-# shorthand notation: displayName will be an optional config of type string with no default
-- displayName
-~~~
-
-Entities, policies, and initializers may accept additional key-value pairs,
-usually documented in their documentation (e.g. javadoc), or in the case of Java
-often as static fields in the underlying Java class.
-Often there are config keys or flags (indicated by `@SetFromFlag`) declared on the class;
-these declared flags and config keys may be passed in at the root of the `ServiceSpecification` or in `brooklyn.config`.
-(Undeclared config is only accepted in the `brooklyn.config` map.)
-Referencing the parameters from within java classes is identical to using config keys. In yaml it's
-usually referenced using `$brooklyn:scopeRoot().config("displayName")`. See below for more details on scopes.
+ # shorthand notation: displayName will be an optional config of type string with no default
+ - displayName
+ ~~~
+
+ Entities, policies, and initializers may accept additional key-value pairs,
+ usually documented in their documentation (e.g. javadoc), or in the case of Java
+ often as static fields in the underlying Java class.
+ Often there are config keys or flags (indicated by `@SetFromFlag`) declared on the class;
+ these declared flags and config keys may be passed in at the root of the `ServiceSpecification` or in `brooklyn.config`.
+ (Undeclared config is only accepted in the `brooklyn.config` map.)
+ Referencing the parameters from within java classes is identical to using config keys. In yaml it's
+ usually referenced using `$brooklyn:scopeRoot().config("displayName")`. See below for more details on scopes.
+
+* `brooklyn.tags`: documents a list of tag objects which should be assigned to the entity.
## Location Specification Elements
[2/2] brooklyn-docs git commit: This closes #162
Posted by dr...@apache.org.
This closes #162
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/57746af0
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/57746af0
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/57746af0
Branch: refs/heads/master
Commit: 57746af03e8a77fd248b5b7023e2a65456a031b4
Parents: a0b2263 733dcb5
Author: Duncan Godwin <dr...@googlemail.com>
Authored: Mon Apr 10 12:35:22 2017 +0100
Committer: Duncan Godwin <dr...@googlemail.com>
Committed: Mon Apr 10 12:35:22 2017 +0100
----------------------------------------------------------------------
guide/yaml/yaml-reference.md | 40 ++++++++++++++++++++-------------------
1 file changed, 21 insertions(+), 19 deletions(-)
----------------------------------------------------------------------