upstream/icingaweb2-module-businessprocess
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2-module-businessprocess.git synced 2026-02-02 16:39:25 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Adjust accordingly to our new packaging docs

Browse source
This commit is contained in:
Johannes Meyer 2023-10-11 15:14:11 +02:00
parent 517fe787af
commit 148b8f133f
16 changed files with 74 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/01-About.md
View file

@ -1,10 +1,9 @@
# Icinga Business Process Modelling
# Icinga Business Process Modeling
If you want to visualize and monitor hierarchical business processes based on
any or all objects monitored by Icinga, the Icinga Web 2 business process
module is the way to go.
objects monitored by Icinga, Icinga Business Process Modeling is the solution.
[![Dashboard](screenshot/16_dashboard/1603_businessprocesses_on_dashboard.png)](doc/16-Add-To-Dashboard.md)
[![Dashboard](screenshot/16_dashboard/1603_businessprocesses_on_dashboard.png)](16-Add-To-Dashboard.md)
Want to create custom process-based dashboards? Trigger notifications at
process or sub-process level? Provide a quick top-level view for thousands of

32
doc/02-Installation.md
View file

@ -1,20 +1,24 @@
# Installation
<!-- {% if index %} -->
# Installing Icinga Business Process Modeling
## Requirements
The recommended way to install Icinga Business Process Modeling 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
Business Process Modeling and if it is not already set up, it is best to do this first.
* PHP (>= 7.2)
* Icinga Web 2 (>= 2.9)
* Icinga Web 2 libraries:
* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (>= 0.8)
* [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (>= 0.11)
* Icinga Web 2 modules:
* The `monitoring` or `icingadb` module needs to be configured and enabled.
The following steps will guide you through installing and setting up Icinga Business Process Modeling.
<!-- {% else %} -->
<!-- {% if not icingaDocs %} -->
## Install Icinga Business Process Modeling
## Installing the Package
Install it [like any other module](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation).
Use `businessprocess` as name.
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-businessprocess` package
or install [from source](02-Installation.md.d/From-Source.md).
<!-- {% endif %} --><!-- {# end if not icingaDocs #} -->
## Create your first Business Process definition
## Configuring Icinga Business Process Modeling
That's it, *Business Process* is now ready for use. Please read more on [how to get started](03-Getting-Started.md).
That's it, Icinga Business Process Modeling is now ready to use.
Please read more on [how to get started](03-Getting-Started.md).
<!-- {% endif %} --><!-- {# end else if index #} -->

15
doc/02-Installation.md.d/From-Source.md Normal file
View file

@ -0,0 +1,15 @@
# Installing Icinga Business Process Modeling from Source
Please see the Icinga Web documentation on
[how to install modules](https://icinga.com/docs/icinga-web/latest/doc/08-Modules/#installation) from source.
Make sure you use `businessprocess` 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.8.0)
* [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (≥0.11.0)
<!-- {% include "02-Installation.md" %} -->

13
doc/03-Getting-Started.md
View file

@ -1,13 +1,11 @@
<a id="Getting-Started"></a>Getting Started
===========================================
# Getting Started
Once you enable the *Business Process* module, it will pop up in your menu.
When you click on it, it will show you a new Dashboard:
Once you enable Icinga Business Process Modeling, it will pop up in your menu.
If you click on it, it will show you a new Dashboard:
![Empty Dashboard](screenshot/03_getting-started/0201_empty-dashboard.png)
A new Business Process configuration
-------------------------------------------
## A new Business Process configuration
From here we choose to create a new *Business Process configuration*:
@ -65,8 +63,7 @@ first five configurations a user is allowed to see will be shown there:
That's all for now, click `Add` to store your new (still empty) Business Process
configuration.
Empty configuration
===================
## Empty configuration
You are redirected to your newly created Business Process configuration:

6
doc/04-Create-your-first-process-node.md
View file

@ -1,5 +1,4 @@
<a id="Create-your-first-process-node"></a>Create your first Business Process Node
==================================================================================
# Create your first Business Process Node
A *Business Process Node* consists of a *name*, *title*, an *operator* and one or
more child nodes. It can be a Root Node, child node of other Business Process
@ -7,8 +6,7 @@ Nodes - or both.
![Empty Config](screenshot/04_first-root-node/0301_empty-config.png)
Configuring our first node
--------------------------
## Configuring our first node
To create our first *Business Process Node* we click the *Add* button. This
leads to the related configuration form:

9
doc/05-Importing-Processes.md
View file

@ -1,5 +1,4 @@
<a id="Importing-Processes"></a>Importing Processes
===================================================
# Importing Processes
To avoid redundancy and make complex *Business Process Configurations* easier
to maintain it is possible to import processes from other configurations.
@ -9,8 +8,7 @@ import processes into the root level.
![Subprocesses Only](screenshot/05_importing_nodes/0401_subprocesses_only.png)
Importing a Process
-------------------
## Importing a Process
Once the related configuration form is open, choose `Existing Process` and wait
for the form to refresh.
@ -37,8 +35,7 @@ to save your changes!
![Import Successful](screenshot/05_importing_nodes/0405_import_successful.png)
Navigation with Imported Processes
----------------------------------
## Navigation with Imported Processes
### Seamless Breadcrumbs

9
doc/06-Customize-Node-Order.md
View file

@ -1,5 +1,4 @@
<a id="Customize-Node-Order"></a>Customize Node Order
=====================================================
# Customize Node Order
By default all nodes are ordered alphabetically while viewing them in the UI.
Though, it is also possible to order nodes entirely manually.
@ -9,8 +8,7 @@ Though, it is also possible to order nodes entirely manually.
> Once manual order is applied (no matter where) alphabetical order is
> disabled for the entire configuration.
Reorder by Drag'n'Drop
----------------------
## Reorder by Drag'n'Drop
Make sure to unlock the configuration first to be able to reorder nodes.
@ -34,8 +32,7 @@ The tree view also has an advantage the tile view has not. It is possible to
move nodes within the entire hierarchy. But remember to unfold processes first,
if you want to move a node into them.
File Format Extensions
----------------------
## File Format Extensions
The configuration file format has slightly been changed to accommodate the new
manual order. Though, previous configurations are perfectly upwards compatible.

12
doc/09-Operators.md
View file

@ -1,15 +1,15 @@
# Operators <a id="operators">
# Operators
Every Business Process requires an Operator. This operator defines its behaviour and specifies how its very own state is
going to be calculated.
## AND <a id="and-operator">
## AND
The `AND` operator selects the **WORST** state of its child nodes:
![And Operator](screenshot/09_operators/0901_and-operator.png)
## OR <a id="or-operator">
## OR
The `OR` operator selects the **BEST** state of its child nodes:
@ -17,7 +17,7 @@ The `OR` operator selects the **BEST** state of its child nodes:
![Or Operator #2](screenshot/09_operators/0903_or-operator-without-ok.png)
## XOR <a id="xor-operator">
## XOR
The `XOR` operator shows OK if only one of n children is OK at the same time. In all other cases the parent node is CRITICAL.
Useful for a service on n servers, only one of which may be running. If both were running,
@ -27,7 +27,7 @@ race conditions and duplication of data could occur.
![Xor Operator #2](screenshot/09_operators/0907_xor-operator-not-ok.png)
## DEGRADED <a id="deg-operator">
## DEGRADED
The `DEGRADED` operator behaves like an `AND`, but if the resulting
state is **CRITICAL** it transforms it into a **WARNING**.
@ -36,7 +36,7 @@ analysis of the statuses.
![Degraded Operator](screenshot/09_operators/0905_deg-operator.jpg)
## MIN n <a id="min-operator">
## MIN n
The `MIN` operator selects the **WORST** state out of the **BEST n** child node states:

9
doc/12-Web-Components-Breadcrumb.md
View file

@ -1,5 +1,4 @@
<a id="Web-Components-Breadcrumb"></a>Web Components: Breadcrumb
================================================================
# Web Components: Breadcrumb
All Business Process renderers show a **breadcrumb** component to always give
you a quick indication of your current location.
@ -24,8 +23,7 @@ column view to make it obvious that you moved to another context. It is also
perfectly legal to open any of the available links in a new browser tab or
window.
Available actions below the Breadcrumb
--------------------------------------
## Available actions below the Breadcrumb
### Choose a renderer
@ -60,8 +58,7 @@ settings for the your currently loaded *Business Process Configuration*:
But there is more. When unlocked, all nodes provide links allowing you to modify or
to delete them. Host/Service Nodes now allow you to simulate a specific state.
Other main actions
------------------
## Other main actions
### Add content to your Dashboard

3
doc/13-Web-Components-Tile-Renderer.md
View file

@ -1,5 +1,4 @@
<a id="Web-Components-Tile-Renderer"></a>Web Components: Tile Renderer
======================================================================
# Web Components: Tile Renderer
The default Business Process *Renderer* is the *Tile Renderer*. It always shows
one level of your tree, enriched with badges giving some hint on lower level

3
doc/14-Web-Components-Tree-Renderer.md
View file

@ -1,5 +1,4 @@
<a id="Web-Components-Tree-Renderer"></a>Web Components: Tree Renderer
======================================================================
# Web Components: Tree Renderer
The main advantage of the *Tree Renderer* is that it is able to show all nodes
of Business Process trees at once. This works fine even for huge trees with lots

6
doc/16-Add-To-Dashboard.md
View file

@ -1,5 +1,4 @@
<a id="Add-To-Dashboard"></a>Show Processes on a Dashboard
==========================================================
# Show Processes on a Dashboard
When being in *Locked mode*, you can add any Business Process at top or sub level
to any Icinga Web 2 Dashboard. The related link can be found in the Tab bar:
@ -13,8 +12,7 @@ want to create a dedicated Dashboard as shown in this example:
![Add to Dashboard - Form](screenshot/16_dashboard/1602_add_to_dashboard-form.png)
Want more?
----------
## Want more?
Head on and add multiple Business Processes to your Dashboard to show all of
them at once:

6
doc/21-Store-Config.md
View file

@ -1,5 +1,4 @@
<a id="Store-Config"></a>Store your Configuration
=================================================
# Store your Configuration
Changes to your *Business Process Configuration* are added to a stack and will
not be stored immediately. In case there are pending unstored changes, this will
@ -13,8 +12,7 @@ you created your [very first configuration](03-Getting-Started.md):
![Store Config](screenshot/21_store-config/2102_Store-Config.png)
Config Diff
-----------
## Config Diff
If unsure what changes you're going to store, you can still check the *Config Diff*
before finally storing to disk:

8
doc/22-Upload-Config.md
View file

@ -1,5 +1,4 @@
<a id="Upload-Config"></a>Upload a Configuration File
=====================================================
# Upload a Configuration File
You can upload a formerly downloaded or even a manually created file directly
through the web frontend. Given sufficient permissions, the Dashboard provides
@ -7,14 +6,13 @@ a related link:
![From Dashboard to Upload](screenshot/22_upload-config/2201_go-to-upload.png)
Chose a file
------------
## Chose a file
This can be any file:
![Choose a File](screenshot/22_upload-config/2202_choose-file.png)
It should be valid of course, but don't worry - the *Business Process* module
It should be valid of course, but don't worry - Icinga Business Process Modeling
protects you from syntax errors:
![Syntax Error](screenshot/22_upload-config/2203_syntax-error.png)

9
doc/31-Permissions.md
View file

@ -1,10 +1,8 @@
<a id="Permission System"></a>Permission System
=================================================
# Permission System
The permission system of the module is based on permissions and restrictions.
Permissions
-----------
## Permissions
The module has five levels of permissions:
@ -14,8 +12,7 @@ The module has five levels of permissions:
* Permission to view all business processes regardless restrictions. (`businessprocess/showall`)
* Full permissions. (`businessprocess/*`)
Restrictions
-----------
## Restrictions
There are two ways to configure restrictions: prefix-based and access controls

11
doc/81-History.md
View file

@ -1,15 +1,13 @@
Project History
===============
# Project History
The Business Process module is based on the ideas of the Nagios(tm) [Business
Icinga Business Process Modeling is based on the ideas of the Nagios(tm) [Business
Process AddOn](http://bp-addon.monitoringexchange.org/) written by Bernd
Strößenreuther. We always loved its simplicity, and while it looks pretty
oldschool right now there are still many shops happily using it in production.
![BpAddOn Overview](screenshot/81_history/8101_bpaddon-overview.png)
Compatibility
-------------
## Compatibility
We fully support the BPaddon configuration language and will continue to do so.
It's also perfectly valid to run both products in parallel based on the very same
@ -33,8 +31,7 @@ backends like SQL databases or the Icinga 2 DSL.
This would make it easier to distribute configuration in large environments.
Improvements
------------
## Improvements
Major focus has been put on execution speed. So while the Web integration shows
much more details at once and is able to display huge unfolded trees, it should