[icinga-checkins] icinga.org: icingaweb2-module-director/feature/assign-for-11976: Add documentation for `Apply For` services

git at icinga.org git at icinga.org
Fri Oct 21 23:17:19 CEST 2016


Module: icingaweb2-module-director
Branch: feature/assign-for-11976
Commit: 50bd24855f400ea8647070a86f27355c0dcc81ce
URL:    https://git.icinga.org/?p=icingaweb2-module-director.git;a=commit;h=50bd24855f400ea8647070a86f27355c0dcc81ce

Author: Corentin Ardeois <cardeois at internap.com>
Date:   Thu Sep  1 14:52:57 2016 -0400

Add documentation for `Apply For` services

---

 doc/15-Service-apply-for-example.md                |   42 ++++++++++++++++++++
 .../151_monitored_services.png                     |  Bin 0 -> 58184 bytes
 .../152_add_service_template.png                   |  Bin 0 -> 33134 bytes
 .../153_add_service_template_field.png             |  Bin 0 -> 53038 bytes
 .../154_create_apply_rule.png                      |  Bin 0 -> 13927 bytes
 .../155_configure_apply_for.png                    |  Bin 0 -> 35848 bytes
 .../15_apply-for-services/156_config_preview.png   |  Bin 0 -> 30190 bytes
 7 files changed, 42 insertions(+)

diff --git a/doc/15-Service-apply-for-example.md b/doc/15-Service-apply-for-example.md
new file mode 100644
index 0000000..d6c0bf8
--- /dev/null
+++ b/doc/15-Service-apply-for-example.md
@@ -0,0 +1,42 @@
+<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 got 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 `value` that can be used as `$$value$$`, it 
+corresponds to the item of the array it will iterate on. Set the `Tcp port` property to `$$value$$`:
+
+![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)
diff --git a/doc/screenshot/director/15_apply-for-services/151_monitored_services.png b/doc/screenshot/director/15_apply-for-services/151_monitored_services.png
new file mode 100644
index 0000000..bbb321d
Binary files /dev/null and b/doc/screenshot/director/15_apply-for-services/151_monitored_services.png differ
diff --git a/doc/screenshot/director/15_apply-for-services/152_add_service_template.png b/doc/screenshot/director/15_apply-for-services/152_add_service_template.png
new file mode 100644
index 0000000..8e3652d
Binary files /dev/null and b/doc/screenshot/director/15_apply-for-services/152_add_service_template.png differ
diff --git a/doc/screenshot/director/15_apply-for-services/153_add_service_template_field.png b/doc/screenshot/director/15_apply-for-services/153_add_service_template_field.png
new file mode 100644
index 0000000..f2677ce
Binary files /dev/null and b/doc/screenshot/director/15_apply-for-services/153_add_service_template_field.png differ
diff --git a/doc/screenshot/director/15_apply-for-services/154_create_apply_rule.png b/doc/screenshot/director/15_apply-for-services/154_create_apply_rule.png
new file mode 100644
index 0000000..3b621b9
Binary files /dev/null and b/doc/screenshot/director/15_apply-for-services/154_create_apply_rule.png differ
diff --git a/doc/screenshot/director/15_apply-for-services/155_configure_apply_for.png b/doc/screenshot/director/15_apply-for-services/155_configure_apply_for.png
new file mode 100644
index 0000000..8d6c6e3
Binary files /dev/null and b/doc/screenshot/director/15_apply-for-services/155_configure_apply_for.png differ
diff --git a/doc/screenshot/director/15_apply-for-services/156_config_preview.png b/doc/screenshot/director/15_apply-for-services/156_config_preview.png
new file mode 100644
index 0000000..f4c0392
Binary files /dev/null and b/doc/screenshot/director/15_apply-for-services/156_config_preview.png differ



More information about the icinga-checkins mailing list