Merge pull request #274 from Icinga/unify-documentation
Update docs for operators and about section
Eric Lippmann
GitHub
13
README.md
|
|
@ -26,11 +26,12 @@ Documentation
|
|||
-------------
|
||||
|
||||
### Basics
|
||||
* [Installation](doc/01-Installation.md)
|
||||
* [Getting Started](doc/02-Getting-Started.md)
|
||||
* [Create your first process node](doc/03-Create-your-first-process-node.md)
|
||||
* [Importing Processes](doc/04-Importing-Processes.md)
|
||||
* [Customize Node Order](doc/05-Customize-Node-Order.md)
|
||||
* [Installation](doc/02-Installation.md)
|
||||
* [Getting Started](doc/03-Getting-Started.md)
|
||||
* [Create your first process node](doc/04-Create-your-first-process-node.md)
|
||||
* [Importing Processes](doc/05-Importing-Processes.md)
|
||||
* [Customize Node Order](doc/06-Customize-Node-Order.md)
|
||||
* [Operators](doc/09-Operators.md)
|
||||
|
||||
### Web Components
|
||||
* [Breadcrumb](doc/12-Web-Components-Breadcrumb.md)
|
||||
|
|
@ -44,5 +45,3 @@ Documentation
|
|||
|
||||
### The Project
|
||||
* [Project History](doc/81-History.md)
|
||||
* [Changelog](doc/82-Changelog.md)
|
||||
* [Contributing](doc/84-Contributing.md)
|
||||
|
|
|
|||
22
doc/01-About.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# Icinga Business Process Modelling
|
||||
|
||||
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.
|
||||
|
||||
[](doc/13-Web-Components-Tile-Renderer.md)
|
||||
[](doc/14-Web-Components-Tree-Renderer.md)
|
||||
[](doc/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
|
||||
components on a single screen? That's what this module has been designed for!
|
||||
|
||||
You're running a huge cloud, want to get rid of the monitoring noise triggered
|
||||
by your auto-scaling platform but still want to have detailed information just
|
||||
a couple of clicks away in case you need them? You will love this little module!
|
||||
|
||||
## Documentation
|
||||
|
||||
* [Installation](02-Installation.md)
|
||||
* [Getting Started](03-Getting-Started.md)
|
||||
|
|
@ -54,11 +54,11 @@ icingacli module enable businessprocess
|
|||
|
||||
Or go to your Icinga Web 2 frontend, choose `Configuration` -> `Modules`...
|
||||
|
||||
|
||||
|
||||
|
||||
...choose the `businessprocess` module and `enable` it:
|
||||
|
||||
|
||||
|
||||
|
||||
It might afterwards be necessary to refresh your web browser to be sure that
|
||||
newly provided styling is loaded.
|
||||
|
|
@ -66,4 +66,4 @@ newly provided styling is loaded.
|
|||
Create your first Business Process definition
|
||||
---------------------------------------------
|
||||
|
||||
That's it, *Business Process* is now ready for use. Please read more on [how to get started](02-Getting-Started.md).
|
||||
That's it, *Business Process* is now ready for use. Please read more on [how to get started](03-Getting-Started.md).
|
||||
|
|
@ -4,27 +4,27 @@
|
|||
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:
|
||||
|
||||
|
||||
|
||||
|
||||
A new Business Process configuration
|
||||
-------------------------------------------
|
||||
|
||||
From here we choose to create a new *Business Process configuration*:
|
||||
|
||||
|
||||
|
||||
|
||||
Let's have a look at the single fields:
|
||||
|
||||
### Configuration name
|
||||
|
||||
|
||||
|
||||
|
||||
The Business Process definition will be stored with this name. This is going to
|
||||
be used when referencing this process in URLs and in Check Commands.
|
||||
|
||||
### Title
|
||||
|
||||
|
||||
|
||||
|
||||
You might optionally want to provide an additional title. In that case the title
|
||||
is shown in the GUI, while the name is still used as a reference. The title will
|
||||
|
|
@ -32,14 +32,14 @@ default to the name.
|
|||
|
||||
### Description
|
||||
|
||||
|
||||
|
||||
|
||||
Provide a short description explaining within 100-150 character what this
|
||||
configuration provides. This will be shown on the Dashboard.
|
||||
|
||||
### Backend
|
||||
|
||||
|
||||
|
||||
|
||||
**Hint:** *Usually this should not be changed*
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ provider for your Business Process.
|
|||
|
||||
### State Type
|
||||
|
||||
|
||||
|
||||
|
||||
You can decide whether `SOFT` or `HARD` states should be the used as a base when
|
||||
calculating the state of a Business Process definition.
|
||||
|
|
@ -60,7 +60,7 @@ calculating the state of a Business Process definition.
|
|||
Business Process configurations can be linked to the Icinga Web 2 menu. Only the
|
||||
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.
|
||||
|
|
@ -70,11 +70,11 @@ Empty configuration
|
|||
|
||||
You are redirected to your newly created Business Process configuration:
|
||||
|
||||
|
||||
|
||||
|
||||
From here we can now add as many deeply nested Business Processes as we want.
|
||||
But let's first have a look at our Dashboard once again:
|
||||
|
||||
|
||||
|
||||
|
||||
Now let's move on and [create your first Nodes](03-Create-your-first-process-node.md).
|
||||
Now let's move on and [create your first Nodes](04-Create-your-first-process-node.md).
|
||||
|
|
@ -5,7 +5,7 @@ A *Business Process Node* consists of a *name*, *title*, an *operator* and one o
|
|||
more child nodes. It can be a Root Node, child node of other Business Process
|
||||
Nodes - or both.
|
||||
|
||||
|
||||
|
||||
|
||||
Configuring our first node
|
||||
--------------------------
|
||||
|
|
@ -13,7 +13,7 @@ Configuring our first node
|
|||
To create our first *Business Process Node* we click the *Add* button. This
|
||||
leads to the related configuration form:
|
||||
|
||||
|
||||
|
||||
|
||||
First setting is the *Node name*, an identifier that must be unique throughout
|
||||
all Nodes that are going to be defined. This identifier will be used in every
|
||||
|
|
@ -25,14 +25,14 @@ Check*.
|
|||
As uniqueness sometimes leads to not-so-beautiful names, you are additionally
|
||||
allowed to specify a title. This is what the frontend is going to show:
|
||||
|
||||
|
||||
|
||||
|
||||
### Choose an operator
|
||||
|
||||
Every Business Process requires an *Operator*. This operator defines it's
|
||||
behaviour, this specifies how it's very own state is going to be calculated:
|
||||
|
||||
|
||||
|
||||
|
||||
### Specify where to display
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ to create a new *root node*. We could alternatively also create a sub process.
|
|||
As we are currently not adding it to another Node, this would lead to an *Unbound
|
||||
Node* that could be linked later on.
|
||||
|
||||
|
||||
|
||||
|
||||
### Provide an optional Info URL
|
||||
|
||||
|
|
@ -51,7 +51,7 @@ hints telling what should happen if outage occurs. You might not want to do so
|
|||
for every single Node, but it might come in handy for your most important (top
|
||||
level?) nodes:
|
||||
|
||||
|
||||
|
||||
|
||||
That's it, your are ready to submit the form.
|
||||
|
||||
|
|
@ -60,10 +60,10 @@ That's it, your are ready to submit the form.
|
|||
You are now shown your first Business Process Node. A red bar reminds you that
|
||||
your pending changes have not been stored yet:
|
||||
|
||||
|
||||
|
||||
|
||||
You could now *Store the Configuration* or move on with adding additional nodes
|
||||
to complete your configuration.
|
||||
|
||||
**Hint**: the blue arrow makes part of a breadcrumb showing your current position.
|
||||
You might want to learn more about [breadcrumbs](12-Web-Components-Breadcrumb.md).
|
||||
You might want to learn more about [breadcrumbs](12-Web-Components-Breadcrumb.md).
|
||||
|
|
@ -7,7 +7,7 @@ to maintain it is possible to import processes from other configurations.
|
|||
In order to be able to import a process create a root node first. You cannot
|
||||
import processes into the root level.
|
||||
|
||||
|
||||
|
||||
|
||||
Importing a Process
|
||||
-------------------
|
||||
|
|
@ -15,27 +15,27 @@ Importing a Process
|
|||
Once the related configuration form is open, choose `Existing Process` and wait
|
||||
for the form to refresh.
|
||||
|
||||
|
||||
|
||||
|
||||
### Choose Configuration
|
||||
|
||||
You can now choose the configuration to import processes from. Or simply hit
|
||||
`Next` to just utilize a process from the current configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
### Select Processes
|
||||
|
||||
Now select the processes you want to import and submit the form.
|
||||
|
||||
|
||||
|
||||
|
||||
### Import Successful
|
||||
|
||||
You are now looking at the result. The process has been imported. Do not forget
|
||||
to save your changes!
|
||||
|
||||
|
||||
|
||||
|
||||
Navigation with Imported Processes
|
||||
----------------------------------
|
||||
|
|
@ -46,11 +46,11 @@ You may have already noticed that the breadcrumbs integrate the hierarchy
|
|||
of the imported process. Once you navigate further the actions below the
|
||||
breadcrumbs change and don't permit to unlock editing.
|
||||
|
||||
|
||||
|
||||
|
||||
To change imported processes you need to open them in their original
|
||||
configuration first. To do so click on the arrow to the right which is
|
||||
displayed in a tile's action urls in the upper left. While in tree view
|
||||
these can be found at the very right of an process' row.
|
||||
|
||||
|
||||
|
||||
|
|
@ -19,16 +19,16 @@ Make sure to unlock the configuration first to be able to reorder nodes.
|
|||
To move a tile simply grab it with your mouse and drag it to the location you
|
||||
want it to appear at.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tree View
|
||||
|
||||
While in tree view nodes can be moved the same way. You just have a narrower
|
||||
area to grab them.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
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,
|
||||
24
doc/09-Operators.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Operators <a id="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">
|
||||
|
||||
The `AND` operator selects the **WORST** state of its child nodes:
|
||||
|
||||
|
||||
|
||||
## AND <a id="or-operator">
|
||||
|
||||
The `OR` operator selects the **BEST** state of its child nodes:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## MIN n <a id="min-operator">
|
||||
|
||||
The `MIN` operator selects the **WORST** state out of the **BEST n** child node states:
|
||||
|
||||
|
||||
|
|
@ -9,7 +9,7 @@ be shown on every screen:
|
|||
|
||||
A click on *Dismiss* immediately throws away all unstored changes. A click on
|
||||
*Store* brings you to the configuration form. You have seen this before, once
|
||||
you created your [very first configuration](02-Getting-Started.md):
|
||||
you created your [very first configuration](03-Getting-Started.md):
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,73 +0,0 @@
|
|||
<a id="Changelog"></a>Changelog
|
||||
===============================
|
||||
|
||||
2.2.0
|
||||
-----
|
||||
|
||||
### Issues and Features
|
||||
* You can find issues and feature requests related to this release on our
|
||||
[roadmap](https://github.com/Icinga/icingaweb2-module-businessprocess/milestone/6?closed=1)
|
||||
|
||||
### New Dependency
|
||||
|
||||
* The module now depends on the [Icinga PHP Library (ipl)](https://github.com/Icinga/icingaweb2-module-ipl)
|
||||
|
||||
### New Features
|
||||
|
||||
* Nodes can now be reordered by using Drag'n'Drop
|
||||
[#123](https://github.com/Icinga/icingaweb2-module-businessprocess/issues/123)
|
||||
* Importing nodes from other process configurations is now fully supported
|
||||
[#133](https://github.com/Icinga/icingaweb2-module-businessprocess/issues/133)
|
||||
|
||||
### Usability and Visualization
|
||||
|
||||
* Lighter Design for the tree view and breadcrumbs
|
||||
* Breadcrumbs provide a way back to the global overview now
|
||||
* Info urls to external sites now open in a new browser tab
|
||||
* Linked processes are now shown as part of a node's impact
|
||||
|
||||
### Permissions
|
||||
|
||||
* Users restricted by the monitoring module's `monitoring/filter/objects`
|
||||
restriction now get a properly filtered list of hosts and services
|
||||
while adding new nodes.
|
||||
[#67](https://github.com/Icinga/icingaweb2-module-businessprocess/issues/67)
|
||||
* Users with the permission `businessprocess/showall` were previously not able
|
||||
to see configurations if they were also restricted by other roles.
|
||||
[#200](https://github.com/Icinga/icingaweb2-module-businessprocess/issues/200)
|
||||
|
||||
2.1.0
|
||||
-----
|
||||
|
||||
### Issues and Features
|
||||
* You can find issues and feature requests related to this release on our
|
||||
[roadmap](https://github.com/Icinga/icingaweb2-module-businessprocess/milestone/4?closed=1)
|
||||
|
||||
### Usability and Visualization
|
||||
* Missing nodes are now shown in a generic error notice
|
||||
* `Unbound nodes` (nodes not being shown at top level and not in use as a sub
|
||||
node) are now reachable through a fake node
|
||||
* A bug with the Chrome browser showing messed up checkboxes has been fixed
|
||||
|
||||
### State Calculation
|
||||
* Missing nodes are now considered being `UNKNOWN` (or `UNREACHABLE` when
|
||||
being a host node). The former behaviour comes from Icinga 1.x, as a reload
|
||||
there had the potential to trigger false alarms. This is no longer an issue
|
||||
with Icinga 2.x, allowing us to be strict once again when it goes to missing
|
||||
nodes
|
||||
* Linking nodes from other process configuration files (still an undocumented
|
||||
feature) has been broken shortly before 2.0.0, this has now been fixed
|
||||
|
||||
### Permissions
|
||||
* Permissions have not been enforced as they should have been in 2.0.0, some
|
||||
links and operations have been accessible to roles that haven't been granted
|
||||
such. This has now been fixed
|
||||
* While we allow for granular permissions that can be persisted in every process
|
||||
configuration file (still an undocumented feature), there is now also a pretty
|
||||
simple but effective way of restricting access to your business processes based
|
||||
on process name prefixes.
|
||||
|
||||
2.0.0
|
||||
-----
|
||||
|
||||
* First officially stable version
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
Contributing
|
||||
============
|
||||
|
||||
The Businessprocess module is an Open Source project and lives from your contributions.
|
||||
No matter whether these are feature requests, issues, translations, documentation or
|
||||
code.
|
||||
|
||||
* Please check whether a related issue alredy exists on our [Issue Tracker](https://github.com/icinga/icingaweb2-module-businessprocess/issues)
|
||||
* Make sure your code conforms to the [PSR-2: Coding Style Guide](http://www.php-fig.org/psr/psr-2/)
|
||||
* Unit-Tests would be great
|
||||
* Send a [Pull Request](https://github.com/Icinga/icingaweb2-module-businessprocess/pulls)
|
||||
(it will automatically be tested on Travis-CI, PSR-2 is enforced)
|
||||
* We try hard to keep our master always green: [](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess)
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
|
||||
The Business Process module is tested on PHP versions 5.3 up to 7.1 (including
|
||||
nightly builds).
|
||||
|
Before Width: | Height: | Size: 7.1 KiB After Width: | Height: | Size: 7.1 KiB |
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
|
Before Width: | Height: | Size: 6.8 KiB After Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
|
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |
|
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 4 KiB After Width: | Height: | Size: 4 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 7.8 KiB After Width: | Height: | Size: 7.8 KiB |
|
Before Width: | Height: | Size: 7.9 KiB After Width: | Height: | Size: 7.9 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
BIN
doc/screenshot/09_operators/0901_and-operator.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
doc/screenshot/09_operators/0902_or-operator.png
Normal file
|
After Width: | Height: | Size: 63 KiB |
BIN
doc/screenshot/09_operators/0903_or-operator-without-ok.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
doc/screenshot/09_operators/0904_min-operator.png
Normal file
|
After Width: | Height: | Size: 92 KiB |