Skip to content

document add'l constraints #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asfgit merged 1 commit into from
Sep 24, 2018
Merged

document add'l constraints #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions guide/blueprints/entity-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,19 @@ and for a complete reference on the syntax of `brooklyn.parameters` see that sec

#### Config Key Constraints

The config keys in the `brooklyn.parameters` can also have constraints defined, for what values
The config keys in the `brooklyn.parameters` can also have a list of constraints defined, for what values
are valid. If more than one constraint is defined, then they must all be satisfied. The constraints
can be any of:

* `required`: deployment will fail if no value is supplied for this config key.
* `regex: ...`: the value will be compared against the given regular expression.
* A predicate, declared using the DSL `$brooklyn:object`.
* `required`: deployment will fail if no value is supplied for this config key
* `regex: <pattern>`: the value must match the regular expression `<pattern>`
* `glob: <pattern>`: the value must match the bash-style wildcard glob `<pattern>`
* `urlExists: <url>`: the server must be able to resolve and access the URL `<url>`
* `forbiddenIf: <key>`: setting a value is disallowed if the config key `<key>` has a value set
* `forbiddenUnless: <key>`: setting a value is disallowed if the config key `<key>` does not have a value set
* `requiredIf: <key>`: a value is required if the config key `<key>` has a value set
* `requiredUnless: <key>`: a value is required if the config key `<key>` does not have a value set
* Any java `Predicate`, declared using the DSL `$brooklyn:object`.

This is illustrated in the example below:

Expand Down