From 5f34d3a5c82f2e7280bf0b9c046169df109cc0c9 Mon Sep 17 00:00:00 2001 From: Christoph Breit Date: Wed, 18 Oct 2023 08:41:48 +0200 Subject: [PATCH] remove unnecessary code and add readme and changelog --- ...dd_businessprocess_module_installation.yml | 3 ++ doc/role-icingaweb2/module-businessprocess.md | 36 +++++++++++++++++++ .../tasks/modules/businessprocess.yml | 24 ++----------- 3 files changed, 42 insertions(+), 21 deletions(-) create mode 100644 changelogs/fragments/feature_add_businessprocess_module_installation.yml diff --git a/changelogs/fragments/feature_add_businessprocess_module_installation.yml b/changelogs/fragments/feature_add_businessprocess_module_installation.yml new file mode 100644 index 00000000..3a3df168 --- /dev/null +++ b/changelogs/fragments/feature_add_businessprocess_module_installation.yml @@ -0,0 +1,3 @@ +--- +major_changes: + - Added Installation of Business Process Modeling Module diff --git a/doc/role-icingaweb2/module-businessprocess.md b/doc/role-icingaweb2/module-businessprocess.md index e69de29b..265552c8 100644 --- a/doc/role-icingaweb2/module-businessprocess.md +++ b/doc/role-icingaweb2/module-businessprocess.md @@ -0,0 +1,36 @@ +## Module Icinga Business Process Modeling + +The module Icinga Business Process Modeling provides a visualization for hierarchical business processes based on objects monitored by Icinga. + +## Configuration + +The general module parameter like `enabled` and `source` can be applied here. + +For every config file, create a dictionary with sections as keys and the parameters as values. For all parameters please check the [module documentation](https://icinga.com/docs/icinga-business-process-modeling/latest/doc/01-About/) + + + +Example: +``` +icingaweb2_modules: + businessprocess: + enabled: true + source: package +``` + +### Custom Process Files: + +Custom process files are a great way to transfer existing business process configurations into the Business Process Modeling Module. + +To copy existing processes into the processes folder please use the `custom_process_files` dictionary. + +The `src_path` will search within any `files/` directory in the Ansible environment. +``` +icingaweb2_modules: + businessprocess: + enabled: true + source: package + custom_process_files: + - name: test.conf + src_path: processes/test.conf +``` \ No newline at end of file diff --git a/roles/icingaweb2/tasks/modules/businessprocess.yml b/roles/icingaweb2/tasks/modules/businessprocess.yml index 6ff2c415..1bcee37a 100644 --- a/roles/icingaweb2/tasks/modules/businessprocess.yml +++ b/roles/icingaweb2/tasks/modules/businessprocess.yml @@ -1,8 +1,4 @@ -# - name: Module Icinga Business Process Modeling | Install -# debug: -# msg: "Module Business Process Modeling installed" - -- name: Module Graphite | Ensure config directory +- name: Module Icinga Business Process Modeling | Ensure config directory ansible.builtin.file: state: directory dest: "{{ icingaweb2_modules_config_dir }}/{{ item.key }}" @@ -10,29 +6,15 @@ group: "{{ icingaweb2_group }}" mode: "2770" -- name: Module Graphite | Ensure processes directory +- name: Module Icinga Business Process Modeling | Ensure processes directory ansible.builtin.file: state: directory dest: "{{ icingaweb2_modules_config_dir }}/{{ item.key }}/processes" owner: "{{ icingaweb2_httpd_user }}" group: "{{ icingaweb2_group }}" mode: "2770" - -# - name: Module Business Process Modelling | Ensure Process Directory - -- name: Module Business Process Modeling | Manage process files - ansible.builtin.include_tasks: manage_module_config.yml - loop: "{{_files}}" - loop_control: - loop_var: _file - when: vars['icingaweb2_modules'][_module][_file] is defined - vars: - _module: "{{ item.key }}" - _files: - - processes - -- name: Module Icinga Businessprocess | Copy Process +- name: Module Icinga Business Process Modeling | Copy Process ansible.builtin.copy: owner: "{{ icingaweb2_httpd_user }}" group: "{{ icingaweb2_group }}"