From 18db984057b83ca4962c89b6b79bdce6a660b58f Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 28 Apr 2024 14:42:35 +0200 Subject: Adding upstream version 2.4.0. Signed-off-by: Daniel Baumann --- doc/03-Getting-Started.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 doc/03-Getting-Started.md (limited to 'doc/03-Getting-Started.md') diff --git a/doc/03-Getting-Started.md b/doc/03-Getting-Started.md new file mode 100644 index 0000000..e90dfc2 --- /dev/null +++ b/doc/03-Getting-Started.md @@ -0,0 +1,80 @@ +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: + +![Empty Dashboard](screenshot/03_getting-started/0201_empty-dashboard.png) + +A new Business Process configuration +------------------------------------------- + +From here we choose to create a new *Business Process configuration*: + +![New Business Process](screenshot/03_getting-started/0202_create-new-configuration.png) + +Let's have a look at the single fields: + +### Configuration name + +![Configuration name](screenshot/03_getting-started/0203_create-new_name.png) + +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 + +![Configuration name](screenshot/03_getting-started/0204_create-new_title.png) + +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 +default to the name. + +### Description + +![Description](screenshot/03_getting-started/0205_create-new_description.png) + +Provide a short description explaining within 100-150 character what this +configuration provides. This will be shown on the Dashboard. + +### Backend + +![Backend](screenshot/03_getting-started/0206_create-new_backend.png) + +**Hint:** *Usually this should not be changed* + +Icinga Web 2 currently uses only one Monitoring Backend, but in theory you +could configure multiple ones. They won't be usable in a meaningful way at the +time of this writing. Still, you might want to use a different backend as a data +provider for your Business Process. + +### State Type + +![State Type](screenshot/03_getting-started/0207_create-new_state-type.png) + +You can decide whether `SOFT` or `HARD` states should be the used as a base when +calculating the state of a Business Process definition. + +### Add to menu + +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: + +![Add to menu](screenshot/03_getting-started/0208_create-new_add-to-menu.png) + +That's all for now, click `Add` to store your new (still empty) Business Process +configuration. + +Empty configuration +=================== + +You are redirected to your newly created Business Process configuration: + +![Empty configuration](screenshot/03_getting-started/0209_new-empty-configuration.png) + +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: + +![New on Dashboard](screenshot/03_getting-started/0210_new-on-dashboard.png) + +Now let's move on and [create your first Nodes](04-Create-your-first-process-node.md). -- cgit v1.2.3