Merge pull request #93 from tribe29/devel

Bugfix agent role hostname usage and HTTP timeout for discovery

Author: robin-checkmk

changelogs/fragments/bugfix_agent_role.yml

@@ -0,0 +1,48 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+bugfixes:
+  - Fix usage of 'checkmk_agent_host_name'variable. Some tasks had 'inventory_hostname' hardcoded, which is not the desired behavior. This is fixed now.
+
+# known_issues:
+#   - This release is still in development and a heavy work in progress.
+#   - Discovery module is not feature complete yet.
+#   - Downtime module is not fully idempotent yet. This affects service downtimes and deletions.
+
+## Line Format
+# When writing a changelog entry, use the following format:
+
+# - scope - description starting with a lowercase letter and ending with a period at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself).
+
+# The scope is usually a module or plugin name or group of modules or plugins, for example, lookup plugins. While module names can (and should) be mentioned directly (foo_module), plugin names should always be followed by the type (foo inventory plugin).
+
+# For changes that are not really scoped (for example, which affect a whole collection), use the following format:
+
+# - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself).
+
+
+## Possible keys:
+
+# breaking_changes
+
+#     Changes that break existing playbooks or roles. This includes any change to existing behavior that forces users to update tasks. Displayed in both the changelogs and the Porting Guides.
+# major_changes
+
+#     Major changes to Ansible itself. Generally does not include module or plugin changes. Displayed in both the changelogs and the Porting Guides.
+# minor_changes
+
+#     Minor changes to Ansible, modules, or plugins. This includes new features, new parameters added to modules, or behavior changes to existing parameters.
+# deprecated_features
+
+#     Features that have been deprecated and are scheduled for removal in a future release. Displayed in both the changelogs and the Porting Guides.
+# removed_features
+
+#     Features that were previously deprecated and are now removed. Displayed in both the changelogs and the Porting Guides.
+# security_fixes
+
+#     Fixes that address CVEs or resolve security concerns. Include links to CVE information.
+# bugfixes
+
+#     Fixes that resolve issues.
+# known_issues
+
+#     Known issues that are currently not fixed or will not be fixed.

changelogs/fragments/bugfix_discovery_http_timeout.yml

@@ -0,0 +1,48 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+bugfixes:
+  - Increase HTTP timeout for the discovery module, because the discovery can take some time depending on the discovered device.
+
+# known_issues:
+#   - This release is still in development and a heavy work in progress.
+#   - Discovery module is not feature complete yet.
+#   - Downtime module is not fully idempotent yet. This affects service downtimes and deletions.
+
+## Line Format
+# When writing a changelog entry, use the following format:
+
+# - scope - description starting with a lowercase letter and ending with a period at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself).
+
+# The scope is usually a module or plugin name or group of modules or plugins, for example, lookup plugins. While module names can (and should) be mentioned directly (foo_module), plugin names should always be followed by the type (foo inventory plugin).
+
+# For changes that are not really scoped (for example, which affect a whole collection), use the following format:
+
+# - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself).
+
+
+## Possible keys:
+
+# breaking_changes
+
+#     Changes that break existing playbooks or roles. This includes any change to existing behavior that forces users to update tasks. Displayed in both the changelogs and the Porting Guides.
+# major_changes
+
+#     Major changes to Ansible itself. Generally does not include module or plugin changes. Displayed in both the changelogs and the Porting Guides.
+# minor_changes
+
+#     Minor changes to Ansible, modules, or plugins. This includes new features, new parameters added to modules, or behavior changes to existing parameters.
+# deprecated_features
+
+#     Features that have been deprecated and are scheduled for removal in a future release. Displayed in both the changelogs and the Porting Guides.
+# removed_features
+
+#     Features that were previously deprecated and are now removed. Displayed in both the changelogs and the Porting Guides.
+# security_fixes
+
+#     Fixes that address CVEs or resolve security concerns. Include links to CVE information.
+# bugfixes
+
+#     Fixes that resolve issues.
+# known_issues
+
+#     Known issues that are currently not fixed or will not be fixed.

galaxy.yml

@@ -9,7 +9,7 @@ namespace: tribe29
 name: checkmk
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 0.5.1
+version: 0.5.2
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/modules/discovery.py

@@ -136,7 +136,7 @@ def run_module():
     )
     url = base_url + api_endpoint
     response, info = fetch_url(
-        module, url, module.jsonify(params), headers=headers, method="POST"
+        module, url, module.jsonify(params), headers=headers, method="POST", timeout=60
     )
     http_code = info["status"]
 

roles/agent/README.md

@@ -41,6 +41,14 @@ The user used to authenticate against your Checkmk site.
 
 The password for the user used to authenticate against your Checkmk site.
 
+    checkmk_agent_add_host: 'false'
+
+Automatically add the host where the agent was installed to Checkmk.
+
+    checkmk_agent_discover: 'false'
+
+Automatically discover services on the host where the agent was installed.
+
     checkmk_agent_update: 'false'
 
 Register host for automatic updates. Make sure to have the server side prepared
@@ -59,14 +67,6 @@ Automatically configure the firewall to allow access to the Checkmk agent.
 
 Enable this to automatically install `xinetd` on hosts with systemd prior to version 220.
 
-    checkmk_agent_add_host: 'false'
-
-Automatically add the host where the agent was installed to Checkmk.
-
-    checkmk_agent_discover: 'false'
-
-Automatically discover services on the host where the agent was installed.
-
     checkmk_agent_delegate_api_calls: localhost
 
 Configure the host to which Checkmk API calls are delegated to.

roles/agent/defaults/main.yml

@@ -6,12 +6,12 @@ checkmk_agent_server: localhost
 checkmk_agent_site: my_site
 checkmk_agent_user: "{{ automation_user | default('automation') }}"
 checkmk_agent_pass: "{{ automation_secret | default('SECRET') }}"
+checkmk_agent_add_host: 'false'
+checkmk_agent_discover: 'false'
 checkmk_agent_update: 'false'
 checkmk_agent_tls: 'false'
 checkmk_agent_configure_firewall: 'true'
 checkmk_agent_prep_legacy: 'false'
-checkmk_agent_add_host: 'false'
-checkmk_agent_discover: 'false'
 checkmk_agent_delegate_api_calls: localhost
 checkmk_agent_host_name: "{{ inventory_hostname }}"
 

roles/agent/tasks/main.yml

@@ -39,7 +39,7 @@
 - name: "Register Agent for automatic Upates."
   become: true
   ansible.builtin.shell: |
-    cmk-update-agent register -H {{ inventory_hostname }} \
+    cmk-update-agent register -H {{ checkmk_agent_host_name }} \
     -s {{ checkmk_agent_server }} -i {{ checkmk_agent_site }} -p {{ checkmk_agent_protocol }} \
     -U {{ checkmk_agent_user }} -S {{ checkmk_agent_pass }}
   register: checkmk_agent_update_state
@@ -48,7 +48,7 @@
 - name: "Register Agent for TLS."
   become: true
   ansible.builtin.shell: |
-    cmk-agent-ctl register -H {{ inventory_hostname }} \
+    cmk-agent-ctl register -H {{ checkmk_agent_host_name }} \
     -s {{ checkmk_agent_server }} -i {{ checkmk_agent_site }} \
     -U {{ checkmk_agent_user }} -P {{ checkmk_agent_pass }} --trust-cert
   register: checkmk_agent_tls_state