From 02dbe9bb09461aab1ba8dc62cadedac625ab5025 Mon Sep 17 00:00:00 2001 From: Lord Hepipud Date: Mon, 4 Nov 2019 15:53:05 +0100 Subject: [PATCH] Update documentation --- doc/02-Installation.md | 4 +- doc/03-WebIntegration.md | 40 ------------------- ...eveloperGuide.md => 04-Developer-Guide.md} | 3 +- ...ntegration.md => 05-Icinga-Integration.md} | 4 +- ...nstallService.md => 10-Install-Service.md} | 13 +----- doc/11-IcingaWeb2Integration.md | 40 ------------------- ...ewIcingaCheck.md => 01-New-IcingaCheck.md} | 0 ...ectorBaskets.md => 01-Director-Baskets.md} | 2 +- ...entExample.md => 02-Manual-Integration.md} | 0 ...kstartScript.md => 01-Kickstart-Script.md} | 0 ...tallation.md => 02-Manual-Installation.md} | 0 11 files changed, 8 insertions(+), 98 deletions(-) delete mode 100644 doc/03-WebIntegration.md rename doc/{04-DeveloperGuide.md => 04-Developer-Guide.md} (76%) rename doc/{05-IcingaIntegration.md => 05-Icinga-Integration.md} (76%) rename doc/{10-InstallService.md => 10-Install-Service.md} (76%) delete mode 100644 doc/11-IcingaWeb2Integration.md rename doc/developerguide/{01-NewIcingaCheck.md => 01-New-IcingaCheck.md} (100%) rename doc/icingaintegration/{01-DirectorBaskets.md => 01-Director-Baskets.md} (91%) rename doc/icingaintegration/{02-Icinga2AgentExample.md => 02-Manual-Integration.md} (100%) rename doc/installation/{01-KickstartScript.md => 01-Kickstart-Script.md} (100%) rename doc/installation/{02-ManualInstallation.md => 02-Manual-Installation.md} (100%) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index 554e7c3d..acf6c390 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -6,8 +6,8 @@ Installing the module is managed by different ways, depending on the user enviro Instructions --- -* Install the Module with the [Kickstart Script](installation/01-KickstartScript.md) -* Install the Module [manually](installation/02-ManualInstallation.md) +* Install the Module with the [Kickstart Script](installation/01-Kickstart-Script.md) +* Install the Module [manually](installation/02-Manual-Installation.md) Testing the installation --- diff --git a/doc/03-WebIntegration.md b/doc/03-WebIntegration.md deleted file mode 100644 index e0286e27..00000000 --- a/doc/03-WebIntegration.md +++ /dev/null @@ -1,40 +0,0 @@ -Web Integration (Deprecated) -=== - -Before you can use this module, you will require to install and configure it. Once done, you are ready to start. - -Configure the module ---- - -Once the module is installed, you will want to run the initial setup. Therefor you will simply have to type in the command - -```powershell -Install-Icinga -``` - -This will create the base configuration of the module including the setup of directories and required files within the **PowerShell Module Directory**. - -Once completed successfully, you are ready to get started with using it. This will include - -* Using it localy with scripts -* Integration into for the Icinga 2 Agent -* Use it as Remote Execution target -* Integrate it into Icinga Web 2 - -If you wish to provide a Rest-Api of this module, you can run this Module as daemon. It will then listen on the default port **5891** - -```powershell -Start-Icinga-Daemon -``` - -Of course if you wish to actively send data to Icinga Web 2 for example, you can do so by running the Checker component - -```powershell -Start-Icinga-Checker -``` - -For additional setup possibilities, please take a look at the following pages: - -* [Use the module as Icinga Plugin Framework](12-Icinga2AgentExample.md) -* [Install the module as Windows Service](10-InstallService.md) -* [Integration into Icinga Web 2](11-IcingaWeb2Integration.md) diff --git a/doc/04-DeveloperGuide.md b/doc/04-Developer-Guide.md similarity index 76% rename from doc/04-DeveloperGuide.md rename to doc/04-Developer-Guide.md index cd3a4fb3..09a08f87 100644 --- a/doc/04-DeveloperGuide.md +++ b/doc/04-Developer-Guide.md @@ -10,4 +10,5 @@ Functions A detailed overview of functions can be found below -* [New-IcingaCheck](developerguide/01-NewIcingaCheck.md) +* [New-IcingaCheck](developerguide/01-New-IcingaCheck.md) +* [New-IcingaCheckPackage](developerguide/02-New-IcingaCheckPackage.md) diff --git a/doc/05-IcingaIntegration.md b/doc/05-Icinga-Integration.md similarity index 76% rename from doc/05-IcingaIntegration.md rename to doc/05-Icinga-Integration.md index 1015674d..f51c4102 100644 --- a/doc/05-IcingaIntegration.md +++ b/doc/05-Icinga-Integration.md @@ -16,5 +16,5 @@ Configuring Check-Commands To get started, there are two ways to configure check command objects: -* [Automated configuration](icingaintegration/01-DirectorBaskets.md) with Baskets -* [Manual configuration](icingaintegration/02-Icinga2AgentExample.md) of check commands +* [Automated configuration](icingaintegration/01-Director-Baskets.md) with Baskets +* [Manual configuration](icingaintegration/02-Manual-Integration.md) of check commands diff --git a/doc/10-InstallService.md b/doc/10-Install-Service.md similarity index 76% rename from doc/10-InstallService.md rename to doc/10-Install-Service.md index 3709a677..b35441c8 100644 --- a/doc/10-InstallService.md +++ b/doc/10-Install-Service.md @@ -30,20 +30,9 @@ icinga-service.exe Now lets install the service with the help of the PowerShell Module: ```powershell -Install-IcingaFrameworkService -ServicePath 'C:\Program Files\Icinga-Framework-Service\icinga-service.exe' +Install-IcingaFrameworkService -Path 'C:\Program Files\Icinga-Framework-Service\icinga-service.exe' ``` You can validate if the service has been installed properly by using the Get Service Cmdlet: -```powershell -Get-IcingaFrameworkService -``` - -Of course there are more Cmdlets available, making the management of this Icinga Service alot easier, which should be self explaining: - -* Start-IcingaFrameworkService -* Stop-IcingaFrameworkService -* Restart-IcingaFrameworkService -* Uninstall-IcingaFrameworkService - Each enabled background daemon component is afterwards being started and executed. diff --git a/doc/11-IcingaWeb2Integration.md b/doc/11-IcingaWeb2Integration.md deleted file mode 100644 index cc776e63..00000000 --- a/doc/11-IcingaWeb2Integration.md +++ /dev/null @@ -1,40 +0,0 @@ -Integrating Icinga Web 2 (Deprecated) -===================================== - -The PowerShell Module provides the possibility to directly (or indirectly over Proxies) connect to an Icinga Web 2 Api to send informations there. - -Requirements --------------- - -In order to make this work, you will require the Icinga Web 2 Module from the [GitHub Repository](https://github.com/LordHepipud/icingaweb2-module-windows). - -Configure the Module --------------- - -Once you installed the [Icinga Web 2 Windows Module](https://github.com/LordHepipud/icingaweb2-module-windows), you will have to tell the PowerShell Module where it should send it's data to. - -The Icinga Web 2 Endpoint for this is - -``` - windows/checkresult -``` - -A full Url example could look like this (which we will use in this documentation): - -``` - https://example.com/icingaweb2/windows/checkresult -``` - -To change configuration elements of the PowerShell Module, there is a Cmdlet available. In order to set the Icinga Web 2 endpoint, you can do it like this: - -```powershell - Set-Icinga-Config -Key 'checker.server.host' -Value 'https://example.com/icingaweb2/windows/checkresult' -``` - -Once sucessfully changed, you will have to restart either the Service or the running PowerShell instance. - -To validate if the configuration change really worked, you can review it with - -```powershell - Get-Icinga-Config -ListConfig -``` \ No newline at end of file diff --git a/doc/developerguide/01-NewIcingaCheck.md b/doc/developerguide/01-New-IcingaCheck.md similarity index 100% rename from doc/developerguide/01-NewIcingaCheck.md rename to doc/developerguide/01-New-IcingaCheck.md diff --git a/doc/icingaintegration/01-DirectorBaskets.md b/doc/icingaintegration/01-Director-Baskets.md similarity index 91% rename from doc/icingaintegration/01-DirectorBaskets.md rename to doc/icingaintegration/01-Director-Baskets.md index 2cd71703..0590f47e 100644 --- a/doc/icingaintegration/01-DirectorBaskets.md +++ b/doc/icingaintegration/01-Director-Baskets.md @@ -28,7 +28,7 @@ If you wish to specify specific commands only, you can filter them as well: Get-IcingaCheckCommandConfig -CheckName Invoke-IcingaCheckBiosSerial, Invoke-IcingaCheckCPU ``` -Last but not least you can output the JSON-Basket directly into a file. To do this, simply use the `OutFile` argument. You only require to specify a directory here, as the file including a timestamp is generated by the Cmdlet itself +Last but not least you can output the JSON-Basket directly into a file. To do this, simply use the `OutDirectory` argument. You only require to specify a directory here, as the file including a timestamp is generated by the Cmdlet itself ```powershell Get-IcingaCheckCommandConfig -OutDirectory 'C:\Users\myuser\Documents\ diff --git a/doc/icingaintegration/02-Icinga2AgentExample.md b/doc/icingaintegration/02-Manual-Integration.md similarity index 100% rename from doc/icingaintegration/02-Icinga2AgentExample.md rename to doc/icingaintegration/02-Manual-Integration.md diff --git a/doc/installation/01-KickstartScript.md b/doc/installation/01-Kickstart-Script.md similarity index 100% rename from doc/installation/01-KickstartScript.md rename to doc/installation/01-Kickstart-Script.md diff --git a/doc/installation/02-ManualInstallation.md b/doc/installation/02-Manual-Installation.md similarity index 100% rename from doc/installation/02-ManualInstallation.md rename to doc/installation/02-Manual-Installation.md