summaryrefslogtreecommitdiffstats
path: root/doc/15-Service-apply-for-example.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:43:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:43:12 +0000
commitcd989f9c3aff968e19a3aeabc4eb9085787a6673 (patch)
treefbff2135e7013f196b891bbde54618eb050e4aaf /doc/15-Service-apply-for-example.md
parentInitial commit. (diff)
downloadicingaweb2-module-director-cd989f9c3aff968e19a3aeabc4eb9085787a6673.tar.xz
icingaweb2-module-director-cd989f9c3aff968e19a3aeabc4eb9085787a6673.zip
Adding upstream version 1.10.2.upstream/1.10.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/15-Service-apply-for-example.md')
-rw-r--r--doc/15-Service-apply-for-example.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/15-Service-apply-for-example.md b/doc/15-Service-apply-for-example.md
new file mode 100644
index 0000000..531e4a7
--- /dev/null
+++ b/doc/15-Service-apply-for-example.md
@@ -0,0 +1,44 @@
+<a id="Service-apply-for-example"></a>Working with Apply for rules - tcp ports example
+==============================================
+
+This example wants to show you how to make use of `Apply For` rule for services.
+
+First you need to define a `tcp_ports` data field of type `Array` assigned to a `Host Template`.
+Refer to [Working with fields](14-Fields-example-interfaces-array.md) section to setup a data field.
+You also need to define a `tcp_port` data field of type `String`, we will associate it to a
+`Service Template` later.
+
+Then, please go to the `Dashboard` and choose the `Monitored services` dashlet:
+
+![Dashboard - Monitored services](screenshot/director/15_apply-for-services/151_monitored_services.png)
+
+Then create a new `Service template` with check command `tcp`:
+
+![Define service template - tcp](screenshot/director/15_apply-for-services/152_add_service_template.png)
+
+Then associate the data field `tcp_port` to this `Service template`:
+
+![Associate field to service template - tcp_port](screenshot/director/15_apply-for-services/153_add_service_template_field.png)
+
+Then create a new `apply-rule` for the `Service template`:
+
+![Define apply rule](screenshot/director/15_apply-for-services/154_create_apply_rule.png)
+
+Now define the `Apply For` property, select the previously defined field `tcp_ports` associated to
+the host template. `Apply For` rule define a variable `config` that can be used as `$config$`, it
+corresponds to the item of the array it will iterate on.
+
+Set the `Tcp port` property to `$config$`:
+
+![Add field to template](screenshot/director/15_apply-for-services/155_configure_apply_for.png)
+
+(Side note: if you can't see your `tcp_ports` property in `Apply For` dropdown, try to create one
+host with a non-empty `tcp_ports` value.)
+
+That's it, now all your hosts defining a `tcp_ports` variable will be assigned the `Tcp Check`
+service.
+
+Have a look at the config preview, it will show you how `Apply For` services will look like once
+deployed:
+
+![Host config preview with Array](screenshot/director/15_apply-for-services/156_config_preview.png)