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 91cc2de8 add info on the triggers supported by sensor feeds
91cc2de8 is described below
commit 91cc2de8a5b543062199ff1b76b807f80a9f0a7e
Author: Alex Heneveld <[email protected]>
AuthorDate: Tue Aug 16 16:53:29 2022 +0100
add info on the triggers supported by sensor feeds
---
guide/blueprints/custom-entities.md | 6 ++++--
guide/blueprints/yaml-reference.md | 18 ++++++++++++++----
2 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/guide/blueprints/custom-entities.md
b/guide/blueprints/custom-entities.md
index b727802c..305a26c1 100644
--- a/guide/blueprints/custom-entities.md
+++ b/guide/blueprints/custom-entities.md
@@ -261,7 +261,9 @@ This blueprint also uses initializers to define sensors on
the `netcat-server` e
period: 1s
command: tail -1 server-input
-#### ContainerSensor
+More information on this and the sensors described below are in the [YAML
Reference](yaml-reference.md).
+
+#### Container Sensor
This blueprint uses initializers to define a `ContainerSensor` on a
`BasicStartable` entity so that a random number is generated by executing a
command on a container for this specific purpose, and destroyed afterwards.
@@ -282,7 +284,7 @@ services:
{% endhighlight %}
-`ContainerSensor` shared configuration details with `ContainerEffector`, so
for more details about the `ContainerSensor` available configuration keys, see
[here](/guide/blueprints/effectors.html#ContainerEffector).
+`ContainerSensor` shared configuration details with `ContainerEffector`, so
for more details about the `ContainerSensor` available configuration keys, see
[here](effectors.md#ContainerEffector).
#### Windows Command Sensor
diff --git a/guide/blueprints/yaml-reference.md
b/guide/blueprints/yaml-reference.md
index 22a43248..b70525bc 100644
--- a/guide/blueprints/yaml-reference.md
+++ b/guide/blueprints/yaml-reference.md
@@ -57,12 +57,22 @@ the entity being defined, with these being the most common:
(on an entity which as an ssh-able machine)
* `org.apache.brooklyn.core.sensor.ssh.SshCommandSensor`: takes a `name` and
`command`,
- and optionally a `period`, to create a sensor feed which populates the
sensor with
- the given name by running the given command (on an entity which as an
ssh-able machine)
+ and optionally a `period` (e.g. `1h`) or `triggers` (a sensor name, or
list containing sensor names or
+ maps of the form `{entity: id, sensor: name}`), to create a sensor feed
which populates the sensor with
+ the given name by running the given command (on an entity which as an
ssh-able machine);
+ this also takes an optional `type` to coerce the output from YAML or JSON
+ (if the `---` document separator is used, only the output after the last
such separator is coerced,
+ allowing output to be verbose until the final section)
+
+ * `org.apache.brooklyn.core.sensor.ssh.SshCommandSensor`: takes a `name` and
`image`,
+ and optionally either `bashScript` or `command`,
+ and optionally the same `period` and `triggers` and `type` as
`SshCommandSensor`,
+ to create a sensor feed which runs the given container to populate the
sensor
* `org.apache.brooklyn.core.sensor.windows.WinRmCommandSensor`: For a
command supplied via WinRm. Takes a `name`, `command`,
- and optionally a `period` and `executionDir`, to create a sensor feed
which populates the sensor with
- the given name by running the given command (on an entity which as an
WinRM-able machine).<br/>
+ and optionally a `period` or `triggers`, and optionally `executionDir`,
+ to create a sensor feed which populates the sensor with
+ the given name by running the given command (on an entity which as an
WinRM-able machine);
_`"~"` will use the default execution directory for the WinRm session
which is usually `%USERPROFILE%`_
When specifying the type of an initializer, registered types (added to the
catalog) are preferred,
