Update documentation

This commit is contained in:
Lord Hepipud 2019-11-04 15:53:05 +01:00
parent 32f641552c
commit 02dbe9bb09
11 changed files with 8 additions and 98 deletions

View file

@ -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
---

View file

@ -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)

View file

@ -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)

View file

@ -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

View file

@ -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.

View file

@ -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
```

View file

@ -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\