Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LordHepipud committed Nov 4, 2019
1 parent f39c26b commit 9958329
Show file tree
Hide file tree
Showing 11 changed files with 8 additions and 98 deletions.
4 changes: 2 additions & 2 deletions doc/02-Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
40 changes: 0 additions & 40 deletions doc/03-WebIntegration.md

This file was deleted.

3 changes: 2 additions & 1 deletion doc/04-DeveloperGuide.md → doc/04-Developer-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions doc/05-IcingaIntegration.md → doc/05-Icinga-Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 1 addition & 12 deletions doc/10-InstallService.md → doc/10-Install-Service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
40 changes: 0 additions & 40 deletions doc/11-IcingaWeb2Integration.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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\
Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit 9958329

Please sign in to comment.