diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 12:43:12 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 12:43:12 +0000 |
| commit | cd989f9c3aff968e19a3aeabc4eb9085787a6673 (patch) | |
| tree | fbff2135e7013f196b891bbde54618eb050e4aaf /doc/24-Working-with-agents.md | |
| parent | Initial commit. (diff) | |
| download | icingaweb2-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/24-Working-with-agents.md')
| -rw-r--r-- | doc/24-Working-with-agents.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/24-Working-with-agents.md b/doc/24-Working-with-agents.md new file mode 100644 index 0000000..24473db --- /dev/null +++ b/doc/24-Working-with-agents.md @@ -0,0 +1,80 @@ +<a id="Working-with-agents"></a>Working with Agents and Config Zones +==================================================================== + +Working with Icinga 2 Agents can be quite tricky, as each Agent needs +its own Endpoint and Zone definition, correct parent, peering host and +log settings. There may always be reasons for a completely custom-made +configuration. However, I'd **strongly suggest** using the **Director- +assisted** variant. It will save you a lot of headaches. + + +Preparation +----------- + +Agent settings are not available for modification directly on a host +object. This requires you to create an "Icinga Agent" template. You +could name it exactly like that; it's important to use meaningful names +for your templates. + + + +As long as you're not using Satellite nodes, a single Agent zone is all +you need. Otherwise, you should create one Agent template per satellite +zone. If you want to move an Agent to a specific zone, just assign it +the correct template and you're all done. + + +Usage +----- + +Well, create a host, choose an Agent template, that's it: + + + +Once you import the "Icinga Agent" template, you'll see a new "Agent" tab. +It tries to assist you with the initial Agent setup by showing a sample +config: + + + + + +The preview shows that the Icinga Director would deploy multiple objects +for your newly created host: + + + + +Create Agent-based services +--------------------------- + +Similar game for services that should run on your Agents. First, create a +template with a meaningful name. Then, define that Services inheriting from +this template should run on your Agents. + + + +Please do not set a cluster zone, as this would rarely be necessary. +Agent-based services will always be deployed to their Agent's zone by +default. All you need to do now for services that should be executed +on your Agents is importing that template: + + + +Config preview shows that everything works as expected: + + + +It's perfectly valid to assign services to host templates. Look how the +generated config differs now: + + + +While services added to a host template are implicitly rendered as +assign rules, you could of course also use your `Agent-based service` +template in custom apply rules: + + + + + |