Skip to content

Commit 2833e57

Browse files
authored
Merge pull request #357 from Icinga:doc/icinga_for_windows_v1.6.0
Docs: Updates documentation for v1.6.0
2 parents 75eeac7 + 8fee6ab commit 2833e57

File tree

70 files changed

+1329
-1359
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+1329
-1359
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,27 @@ Icinga PowerShell Framework
44
The Icinga PowerShell Framework provides a wide range of configuration and check possibilities to ensure an easy integration and full monitoring of Windows environments.
55
Each single chapter of this documentation will describe parts of the module and the possibilities.
66

7-
Before you continue, please take a look at the [Installation Guide](doc/02-Installation.md)
7+
Before you continue, please take a look at the [Installation Guide](doc/110-Installation/01-Getting-Started.md)
88

99
Documentation
1010
-------------
1111

1212
Please take a look at the following content to get to know the possibilities of the module including examples on how to use it.
1313

14-
* [Introduction](doc/01-Introduction.md)
15-
* [Installation Guide](doc/02-Installation.md)
16-
* [Icinga Integration](doc/05-Icinga-Integration.md)
17-
* [Framework Usage Examples](doc/06-Framework-Usage.md)
18-
* [Icinga PowerShell Framework as Service](doc/service/01-Install-Service.md)
19-
* [Knowledge Base](doc/10-Knowledge-Base.md)
20-
* [Changelog](doc/31-Changelog.md)
14+
* [Introduction](doc/000-Introduction.md)
15+
* [Installation Guide](doc/110-Installation/01-Getting-Started.md)
16+
* [Repository Management](doc/120-Repository-Manager)
17+
* [JEA](doc/130-JEA)
18+
* [Icinga Integration](doc/200-Icinga-Integration/)
19+
* [Framework Usage Examples](doc/frameworkusage)
20+
* [Icinga PowerShell Framework as Service](doc/110-Installation/05-Background-Daemons.md)
21+
* [Knowledge Base](doc/300-Knowledge-Base.md)
22+
* [Changelog](doc/100-General/10-Changelog.md)
2123

2224
Developer Guide
2325
------------
2426

25-
If you wish to extend the Framework by yourself or write custom plugins for your environment, please have a look at the [Developer Guide](doc/04-Developer-Guide.md) for detailed explanations of functions and code examples.
27+
If you wish to extend the Framework by yourself or write custom plugins for your environment, please have a look at the [Developer Guide](doc/900-Developer-Guide) for detailed explanations of functions and code examples.
2628

2729
Contributing
2830
------------

doc/01-Introduction.md renamed to doc/000-Introduction.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,16 @@ Below you will find a list of currently available modules published by the Icing
6767

6868
| Icinga PowerShell Kickstart | Icinga PowerShell Framework | Icinga PowerShell Plugins |
6969
| --- | --- | --- |
70-
| [![Kickstart](images/02_icons/kickstart.png)](https://icinga.com/docs/windows/latest/kickstart/doc/01-Introduction/) | [![Frame](images/02_icons/framework.png)](https://icinga.com/docs/windows/latest/doc/02-Installation/) | [![Frame](images/02_icons/plugins.png)](https://icinga.com/docs/windows/latest/plugins/doc/01-Introduction/) |
70+
| [![Kickstart](images/02_icons/kickstart.png)](https://github.com/Icinga/icinga-powershell-kickstart) | [![Frame](images/02_icons/framework.png)](https://icinga.com/docs/windows/latest/doc/02-Installation/) | [![Frame](images/02_icons/plugins.png)](https://icinga.com/docs/windows/latest/plugins/doc/01-Introduction/) |
7171

7272
### Extensions
7373

74-
| Icinga PowerShell REST-Api | Icinga PowerShell Inventory |
75-
| --- | --- |
76-
| [![Rest-API](images/02_icons/restapi.png)](https://icinga.com/docs/windows/latest/restapi/doc/01-Introduction/) | [![Inventory](images/02_icons/inventory.png)](https://icinga.com/docs/windows/latest/inventory/doc/01-Introduction/) |
74+
| Icinga PowerShell REST-Api | Icinga PowerShell Inventory | Icinga PowerShell Api-Checks |
75+
| --- | --- | --- |
76+
| [![Rest-API](images/02_icons/restapi.png)](https://icinga.com/docs/windows/latest/restapi/doc/01-Introduction/) | [![Inventory](images/02_icons/inventory.png)](https://icinga.com/docs/windows/latest/inventory/doc/01-Introduction/) | [![Frame](images/02_icons/plugins.png)](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) |
7777

7878
### Additional Plugins
7979

80-
| Icinga PowerShell Hyper-V (soon)| Icinga PowerShell MSSQL |
81-
| --- | --- |
82-
| ![Hyper-V](images/02_icons/hyperv.png) | [![Inventory](images/02_icons/mssql.png)](https://icinga.com/docs/windows/latest/mssql/doc/01-Introduction/) |
80+
| Icinga PowerShell Hyper-V | Icinga PowerShell MSSQL | Icinga PowerShell Cluster |
81+
| --- | --- | --- |
82+
| [![Hyper-V](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/hyperv/doc/01-Introduction/) | [![MSSQL](images/02_icons/mssql.png)](https://icinga.com/docs/windows/latest/mssql/doc/01-Introduction/) | [![Cluster](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/cluster/doc/01-Introduction/) |

doc/02-Installation.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

doc/04-Developer-Guide.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

doc/05-Icinga-Integration.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

doc/06-Framework-Usage.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

doc/07-Repository-Manager.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
File renamed without changes.

doc/31-Changelog.md renamed to doc/100-General/10-Changelog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**The latest release announcements are available on [https://icinga.com/blog/](https://icinga.com/blog/).**
44

5-
Please read the [upgrading](https://icinga.com/docs/windows/latest/doc/30-upgrading-framework)
5+
Please read the [upgrading](01-Upgrading.md)
66
documentation before upgrading to a new release.
77

88
Released closed milestones can be found on [GitHub](https://github.com/Icinga/icinga-powershell-framework/milestones?state=closed).
@@ -75,7 +75,7 @@ You can read more on this on the [Knowledge Base Entry](https://icinga.com/docs/
7575
### Enhancements
7676

7777
* [#228](https://github.com/Icinga/icinga-powershell-framework/issues/228) Adds feature to suppress any kind of console output except for plugin output and performance data
78-
* [#229](https://github.com/Icinga/icinga-powershell-framework/pull/229) CustomFields defined as `SecureString` are now set to `hidden` within the Icinga Director configuration basket - please read the [upgrading docs](30-upgrading-framework.md) carefully
78+
* [#229](https://github.com/Icinga/icinga-powershell-framework/pull/229) CustomFields defined as `SecureString` are now set to `hidden` within the Icinga Director configuration basket - please read the [upgrading docs](01-Upgrading.md) carefully
7979
* [#234](https://github.com/Icinga/icinga-powershell-framework/pull/234) Adds support to allow custom exception lists for Icinga Exceptions, making it easier for different modules to ship their own exception messages
8080
* [#235](https://github.com/Icinga/icinga-powershell-framework/pull/235) Adds new Cmdlet `Show-IcingaEventLogAnalysis` to get a better overview on how many log entries are present within the EventLog based on hour, minute and day average/maximum for allowing a more dynamic configuration for `Invoke-IcingaCheckEventLog`
8181
* [#236](https://github.com/Icinga/icinga-powershell-framework/pull/236) Adds feature which stops the Icinga Agent before upgrading the Icinga PowerShell Framework and starting it again afterwards (in case it was running), to resolve some possible file lock issues
@@ -120,7 +120,7 @@ You can read more on this on the [Knowledge Base Entry](https://icinga.com/docs/
120120

121121
### Breaking Changes
122122

123-
There are changes made to the pre-compiled configuration files and `Get-IcingaCheckCommandConfig.` Please have a look on the [upgrading](30-upgrading-framework.md) before applying the new configuration files.
123+
There are changes made to the pre-compiled configuration files and `Get-IcingaCheckCommandConfig.` Please have a look on the [upgrading](01-Upgrading.md) before applying the new configuration files.
124124

125125
### Enhancements
126126

@@ -225,7 +225,7 @@ You can read more on this on the [Knowledge Base Entry](https://icinga.com/docs/
225225

226226
Check Command configuration generated by Icinga for Windows 1.2.0 require Icinga for Windows 1.2.0 or later deployed on all systems, otherwise you will run into issues with an unknown command `Exit-IcingaPluginNotInstalled` error.
227227

228-
* To properly catch errors on check execution you will have to import check commands as Director basket again by using `Get-IcingaCheckCommandConfig`. Further details can be found in the [upgrading docs](30-upgrading-framework.md)
228+
* To properly catch errors on check execution you will have to import check commands as Director basket again by using `Get-IcingaCheckCommandConfig`. Further details can be found in the [upgrading docs](01-Upgrading.md)
229229

230230
### Notes
231231

@@ -236,7 +236,7 @@ Check Command configuration generated by Icinga for Windows 1.2.0 require Icinga
236236

237237
### Enhancements
238238

239-
* Adds configuration for [Windows Terminal integration](icingaintegration/50-Windows-Terminal.md)
239+
* Adds configuration for [Windows Terminal integration](../110-Installation/50-Windows-Terminal.md)
240240
* Adds new Cmdlet `Show-IcingaPerformanceCounterInstances` to display all available instances for Performance Counters
241241
* [#76](https://github.com/Icinga/icinga-powershell-framework/issues/76) Adds support to test for required .NET Framework Version 4.6.0 or above before trying to install the Icinga Agent
242242
* [#87](https://github.com/Icinga/icinga-powershell-framework/issues/87) Adds wrapper command to test new code or functionality of Framework and/or plugins

doc/20-Eventlog.md renamed to doc/100-General/20-Eventlog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Framework Eventlog Documentation
1+
# Icinga for Windows Eventlog Documentation
22

33
Below you will find a list of EventId's which are exported by this module. The short and detailed message are both written directly into the eventlog. This documentation shall simply provide a summary of available EventId's
44

0 commit comments

Comments
 (0)