diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/01-About.md | 56 | ||||
| -rw-r--r-- | doc/02-Installation.md | 23 | ||||
| -rw-r--r-- | doc/02-Installation.md.d/From-Source.md | 15 | ||||
| -rw-r--r-- | doc/img/cube_action-links.png | bin | 0 -> 36553 bytes | |||
| -rw-r--r-- | doc/img/cube_director.png | bin | 0 -> 97465 bytes | |||
| -rw-r--r-- | doc/img/cube_move-up.png | bin | 0 -> 189410 bytes | |||
| -rw-r--r-- | doc/img/cube_simple.png | bin | 0 -> 88338 bytes | |||
| -rw-r--r-- | doc/img/cube_slice.png | bin | 0 -> 177946 bytes |
8 files changed, 94 insertions, 0 deletions
diff --git a/doc/01-About.md b/doc/01-About.md new file mode 100644 index 0000000..bd9dd58 --- /dev/null +++ b/doc/01-About.md @@ -0,0 +1,56 @@ +# Icinga Cube + +The Icinga Cube is a tiny but useful [Icinga Web](https://github.com/Icinga/icingaweb2) +module. It currently shows host and service statistics (total count, health) grouped by +various custom variables in multiple dimensions. + + + +It will be your new best friend in case you are running a large environment and +want to get a quick answers to questions like: + +* Which project uses how many servers per environment at which location/site? + * Who occupies most servers? + * How many of those are used in production? + * Which project has only development and test boxes? +* Which operating system is used for which project and in which environment? + * Do we still have Debian Lenny? + * Which projects are to blame for this? + * Do we have applications where the operating systems used differ in staging + and production? +* Which project uses which operating system version for which application? + * Which projects have homogeneous environments? + * Which projects are at a consistent patch level? + * How many RHEL 6 variants (6.1, 6.2, 6.3...) do we use? + * Who is running the oldest ones? In production? +* Which projects are still using physical servers in which environment? + +For Businessmen - Drill and Slice +--------------------------------- + +Get answers to your questions. Quick and fully autonomous, using the cube +requires no technical skills. Choose amongst all available dimensions and rotate +the Cube to fit your needs. + + + +Want to drill down? Choose a slice and get your answers: + + + +All facts configured for systems monitored by [Icinga](https://www.icinga.com/) +can be used for your research. + +For Icinga Director users +------------------------- + +In case you are using the [Icinga Director](https://github.com/Icinga/icingaweb2-module-director), +in addition to the multi-selection/edit feature the cube provides a nice way to +modify multiple hosts at once. + + + +Installation +------------ + +To install Icinga Cube see [Installation](02-Installation.md). diff --git a/doc/02-Installation.md b/doc/02-Installation.md new file mode 100644 index 0000000..d6f3271 --- /dev/null +++ b/doc/02-Installation.md @@ -0,0 +1,23 @@ +<!-- {% if index %} --> +# Installing Icinga Cube + +The recommended way to install Icinga Cube is to use prebuilt packages for +all supported platforms from our official release repository. +Please note that [Icinga Web](https://icinga.com/docs/icinga-web) is required to run Icinga Cube +and if it is not already set up, it is best to do this first. + +The following steps will guide you through installing and setting up Icinga Cube. +<!-- {% else %} --> +<!-- {% if not icingaDocs %} --> + +## Installing the Package + +If the [repository](https://packages.icinga.com) is not configured yet, please add it first. +Then use your distribution's package manager to install the `icinga-cube` package +or install [from source](02-Installation.md.d/From-Source.md). +<!-- {% endif %} --><!-- {# end if not icingaDocs #} --> + +## Configuring Icinga Cube + +No additional steps are required to set up Icinga Cube and it is ready to use right after installation. +<!-- {% endif %} --><!-- {# end else if index #} --> diff --git a/doc/02-Installation.md.d/From-Source.md b/doc/02-Installation.md.d/From-Source.md new file mode 100644 index 0000000..92ac15e --- /dev/null +++ b/doc/02-Installation.md.d/From-Source.md @@ -0,0 +1,15 @@ +# Installing Icinga Cube from Source + +Please see the Icinga Web documentation on +[how to install modules](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation) from source. +Make sure you use `cube` as the module name. The following requirements must also be met. + +## Requirements + +* PHP (≥7.2) +* [Icinga Web](https://github.com/Icinga/icingaweb2) (≥2.9) +* [Icinga DB Web](https://github.com/Icinga/icingadb-web) (≥1.0) +* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (≥0.13.0) + +If you are using PostgreSQL, you need at least version 9.5 which provides the `ROLLUP` feature. +<!-- {% include "02-Installation.md" %} --> diff --git a/doc/img/cube_action-links.png b/doc/img/cube_action-links.png Binary files differnew file mode 100644 index 0000000..2f3abe3 --- /dev/null +++ b/doc/img/cube_action-links.png diff --git a/doc/img/cube_director.png b/doc/img/cube_director.png Binary files differnew file mode 100644 index 0000000..b081c1d --- /dev/null +++ b/doc/img/cube_director.png diff --git a/doc/img/cube_move-up.png b/doc/img/cube_move-up.png Binary files differnew file mode 100644 index 0000000..1fb3c09 --- /dev/null +++ b/doc/img/cube_move-up.png diff --git a/doc/img/cube_simple.png b/doc/img/cube_simple.png Binary files differnew file mode 100644 index 0000000..91bb8f2 --- /dev/null +++ b/doc/img/cube_simple.png diff --git a/doc/img/cube_slice.png b/doc/img/cube_slice.png Binary files differnew file mode 100644 index 0000000..4880cc3 --- /dev/null +++ b/doc/img/cube_slice.png |
