From c1b5cb1f66fa1f5845162458a6b5c8fe1cb49aae Mon Sep 17 00:00:00 2001 From: Thomas Gelf Date: Sun, 17 Apr 2016 18:20:20 +0200 Subject: [PATCH] doc/agents: link images, complete text --- doc/24-Working-with-agents.md | 53 ++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/doc/24-Working-with-agents.md b/doc/24-Working-with-agents.md index d16031f7..b360ec27 100644 --- a/doc/24-Working-with-agents.md +++ b/doc/24-Working-with-agents.md @@ -7,6 +7,7 @@ log settings. There may always be reasons for a completely custom-made configuration. I'd however strongly suggest to give the Director-assisted variant at least a try first. It might safe you a lot of headaches. + Preparation ----------- @@ -15,6 +16,8 @@ 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. +![Create an Agent template](screenshot/director/24-agents/2401_agent_template.png) + 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 @@ -24,6 +27,54 @@ the correct template and you're all done. Usage ----- +Well, create a host, choose an Agent template, that's it: + +![Create an Agent-based host](screenshot/director/24-agents/2402_create_agent_based_host.png) + 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 +config: + +![Agent instructions 1](screenshot/director/24-agents/2403_show_agent_instructions_1.png) + +![Agent instructions 2](screenshot/director/24-agents/2404_show_agent_instructions_2.png) + +The preview shows that the Icinga Director would deploy multiple objects +for your newly created host: + +![Agent preview](screenshot/director/24-agents/2405_agent_preview.png) + + +Create Agent-based services +--------------------------- + +Similar game for services that should run on your Agents. First create a +template with a meaningful name and define that Services inheriting from +this template should run on your Agents. + +![Agent-based service](screenshot/director/24-agents/2406_agent_based_service.png) + +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 ist importing that template: + +![Agent-based load check](screenshot/director/24-agents/2407_create_agent_based_load_check.png) + +Config preview shows that everything works as expected: + +![Agent-based service preview](screenshot/director/24-agents/2409_agent_based_service_rendered_for_host.png) + +It's perfectly valid to assign services to host templates. Look how the +generated config differs now: + +![Agent-based service assigned to host template](screenshot/director/24-agents/2410_agent_based_service_rendered_for_host_template.png) + +While a service added to a host template are implicitely rendered as +assign rules, you could of course also use your `Agent-based service` +template in custom apply rules: + +![Agent-based service applied](screenshot/director/24-agents/2411_assign_agent_based_service.png) + + +