This is an automated email from the ASF dual-hosted git repository.
heneveld pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/brooklyn-docs.git
The following commit(s) were added to refs/heads/master by this push:
new a648507e Documentation for more dependent configuration wait modes
a648507e is described below
commit a648507e172122c9ae802578956f5f333fc57225
Author: Alex Heneveld <[email protected]>
AuthorDate: Mon Oct 6 14:34:29 2025 +0100
Documentation for more dependent configuration wait modes
cf fe283dbe79ce641388d9f5271c944cb1390432a7
---
guide/blueprints/yaml-reference.md | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/guide/blueprints/yaml-reference.md
b/guide/blueprints/yaml-reference.md
index f6fc82e6..a99625ff 100644
--- a/guide/blueprints/yaml-reference.md
+++ b/guide/blueprints/yaml-reference.md
@@ -237,9 +237,14 @@ concise DSL defined here:
* `$brooklyn:attributeWhenReady("sensor")` will store a future which will be
blocked when it is accessed,
until the given `sensor` from this entity "truthy" (i.e. non-trivial,
non-empty, non-zero) value
(see below on `component` for looking up values on other sensors);
- this can take a second argument being a map of options `timeout`,
`timeout_if_down`, `abort_if_on_fire` (default `true`),
- and `wait_for_truthy` (default `true`);
- the default is `{ $brooklyn:attributeWhenReady: [ "sensor", { timeout:
"forever", timeouf_if_down: "1m" } ] }`
+ this can take a second argument being a map defining options:
+ * `wait_for_truthy` (default `true`): whether to wait for truthy values; if
unset, it will only wait if the value or entity is not resolvable
+ * `timeout` (default `forever`): how long to wait for the value, subject to
any additional conditional timeout or abort settings
+ * `abort_if_on_fire` (default `true`): stop waiting if the target entity is
on fire or goes on fire; equivalent to `timeout_if_on_fire=0` and
`timeout_if_on_fire_initial=15s` (unless either of those is explicitly set to a
non-null value, in which case this has no effect)
+ * `timeout_if_on_fire` (default unset): stop waiting if the target entity
goes on fire and stays on fire for this duration (where the value may be `0` to
abort immediately)
+ * `timeout_if_on_fire_initial` (default unset): as `timeout_if_on_fire`, but
always granting at minimum this duration from the start of the resolution for
the target entity to recover, for use when the target might be on fire but
might be recovering concurrently
+ * `timeout_if_down` (default `1m`): as `timeout_if_on_fire` but also
checking if the target entity is stopped or stopping in addition to on-fire
+ * `timeout_if_down_initial` (default unset): as `timeout_if_on_fire_initial`
but also checking if the target entity is stopped or stopping in addition to
on-fire
* `$brooklyn:config("key")` will insert the value set against the given key at
this entity (or nearest ancestor);
can be used to supply config at the root which is used in multiple places in
the plan
* `$brooklyn:sensor("sensor.name")` returns the given sensor on the current
entity if found, or an untyped (Object) sensor;
