Merge pull request #925 from Checkmk/devel

robin-checkmk · web-flow · commit 7eac8ff1ba02 · 2025-11-17T14:35:05.000+01:00
Release 6.3.1
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -77,3 +77,4 @@ Collection Version | Checkmk Versions | Ansible Versions | Remarks
 6.2.2 | 2.2.0p45, 2.3.0p36, 2.4.0p10 | 2.16, 2.17, 2.18 | None
 6.2.3 | 2.2.0p46, 2.3.0p38, 2.4.0p13 | 2.17, 2.18, 2.19 | None
 6.3.0 | 2.2.0p47, 2.3.0p40, 2.4.0p15 | 2.17, 2.18, 2.19 | None
+6.3.1 | 2.2.0p47, 2.3.0p40, 2.4.0p15 | 2.17, 2.18, 2.19 | None
diff --git a/changelogs/fragments/923-update-inventory-args.yml b/changelogs/fragments/923-update-inventory-args.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - Inventory plugin - Update CheckMKLookupAPI arguments in Inventory.
diff --git a/changelogs/fragments/bugfixes.yml b/changelogs/fragments/bugfixes.yml
@@ -0,0 +1,3 @@
+bugfixes:
+  - Downtime module - Bug fix documentation example, where the time stamps were not quoted correctly.
+  - All roles - Update edition name mapping to compensate future naming changes.
diff --git a/changelogs/fragments/release_summary.yml b/changelogs/fragments/release_summary.yml
@@ -0,0 +1 @@
+release_summary: "Bugfix release."
diff --git a/galaxy.yml b/galaxy.yml
@@ -10,7 +10,7 @@ name: general
 
 # The version of the collection. Must be compatible with semantic versioning
 
-version: 6.3.0
+version: 6.3.1
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md
@@ -62,7 +62,7 @@ homepage: https://github.com/Checkmk/ansible-collection-checkmk.general
 # The URL to the collection issue tracker
 issues: https://github.com/Checkmk/ansible-collection-checkmk.general/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
 
-# build_ignore:
-#   - '*cloud-config-aws.ini'
-#   - '*cloud-config-aws.yml'
-#   - 'changelogs/.plugin-cache.yaml'
+build_ignore:
+  - misc/
+  - scripts/
+  - tests/
diff --git a/plugins/inventory/checkmk.py b/plugins/inventory/checkmk.py
@@ -154,8 +154,8 @@ def parse(self, inventory, loader, path, cache=False):
 
         api = CheckMKLookupAPI(
             site_url=self.get_option("server_url") + "/" + self.get_option("site"),
-            user=self.get_option("automation_user"),
-            secret=self.get_option("automation_secret"),
+            automation_user=self.get_option("automation_user"),
+            automation_secret=self.get_option("automation_secret"),
             validate_certs=self.get_option("validate_certs"),
         )
 
diff --git a/plugins/modules/downtime.py b/plugins/modules/downtime.py
@@ -111,8 +111,8 @@
     automation_user: "{{ checkmk_var_automation_user }}"
     automation_secret: "{{ checkmk_var_automation_secret }}"
     host_name: my_host
-    start_time: 2022-03-24T20:39:28Z
-    end_time: 2022-03-24T20:40:28Z
+    start_time: "2022-03-24T20:39:28Z"
+    end_time: "2022-03-24T20:40:28Z"
     state: "present"
     duration: 0
     service_descriptions:
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "checkmk_ansible_collection"
-version = "6.3.0"
+version = "6.3.1"
 requires-python = ">=3.11"
 dependencies = [
     "ansible-core==2.19.4",
diff --git a/roles/agent/molecule/2.2.0/molecule.yml b/roles/agent/molecule/2.2.0/molecule.yml
@@ -48,7 +48,7 @@ scenario:
     - destroy
     - syntax
     - create
-    - prepare
+    # - prepare
     - converge
     # - idempotence  # disable for now, as we have non-idempotent tasks
     # - side_effect
diff --git a/roles/agent/molecule/2.3.0/molecule.yml b/roles/agent/molecule/2.3.0/molecule.yml
@@ -48,7 +48,7 @@ scenario:
     - destroy
     - syntax
     - create
-    - prepare
+    # - prepare
     - converge
     # - idempotence  # disable for now, as we have non-idempotent tasks
     # - side_effect
diff --git a/roles/agent/molecule/2.4.0/molecule.yml b/roles/agent/molecule/2.4.0/molecule.yml
@@ -48,7 +48,7 @@ scenario:
     - destroy
     - syntax
     - create
-    - prepare
+    # - prepare
     - converge
     # - idempotence  # disable for now, as we have non-idempotent tasks
     # - side_effect
diff --git a/roles/agent/vars/main.yml b/roles/agent/vars/main.yml
@@ -5,13 +5,29 @@ __checkmk_agent_auth: |-
   {% if checkmk_agent_secret is defined and checkmk_agent_secret | length > 0 %}{{ checkmk_agent_secret }}{% else %}{{ checkmk_agent_pass }}{% endif %}
 
 # Due to inconsistent naming of editions, we normalize them here for convenience
-__checkmk_agent_edition_mapping:
+# Due to inconsistent naming of editions, we normalize them here for convenience.
+__checkmk_var_legacy_edition_mapping:
   cre: raw
   cfe: free
   cee: enterprise
   cce: cloud
   cme: managed
 
+# Due to renaming of editions starting with 2.5.0, we normalize them here for convenience. Again.
+__checkmk_var_modern_edition_mapping:
+  cre: community
+  cee: pro
+  cce: ultimate
+  cme: ultimatemt
+  cse: cloud
+
+# Bringing the above two mappings back together.
+__checkmk_agent_edition_mapping: >-
+  {{
+    ( (checkmk_server_version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+    | ternary(__checkmk_var_legacy_edition_mapping, __checkmk_var_modern_edition_mapping)
+  }}
+
 __checkmk_agent_files_mapping:
   Debian: linux_deb
   RedHat: linux_rpm
diff --git a/roles/server/molecule/2.2.0/molecule.yml b/roles/server/molecule/2.2.0/molecule.yml
@@ -48,7 +48,7 @@ scenario:
     - destroy
     - syntax
     - create
-    - prepare
+    # - prepare
     - converge
     # - idempotence  # disable for now, as we have non-idempotent tasks
     # - side_effect
diff --git a/roles/server/molecule/2.3.0/molecule.yml b/roles/server/molecule/2.3.0/molecule.yml
@@ -48,7 +48,7 @@ scenario:
     - destroy
     - syntax
     - create
-    - prepare
+    # - prepare
     - converge
     # - idempotence  # disable for now, as we have non-idempotent tasks
     # - side_effect
diff --git a/roles/server/molecule/2.4.0/molecule.yml b/roles/server/molecule/2.4.0/molecule.yml
@@ -48,7 +48,7 @@ scenario:
     - destroy
     - syntax
     - create
-    - prepare
+    # - prepare
     - converge
     # - idempotence  # disable for now, as we have non-idempotent tasks
     # - side_effect
diff --git a/roles/server/tasks/sites.yml b/roles/server/tasks/sites.yml
@@ -1,9 +1,15 @@
 ---
 - name: "Create Sites."
   become: true
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.edition, __checkmk_server_edition_mapping[item.edition])
+      }}
   ansible.builtin.shell: |
     set -o pipefail
-    omd -V {{ item.version }}.{{ item.edition | lower }} create {{ item.name }}
+    omd -V {{ item.version }}.{{ __checkmk_var_edition_id | lower }} create {{ item.name }}
   args:
     executable: /bin/bash
     creates: "/omd/sites/{{ item.name }}"
@@ -18,6 +24,12 @@
 
 - name: "Get Site Versions."
   become: true
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.edition, __checkmk_server_edition_mapping[item.edition])
+      }}
   ansible.builtin.shell: |
     set -o pipefail
     omd version {{ item.name }} | egrep -o '[^ ]+$'
@@ -27,7 +39,7 @@
   loop: "{{ checkmk_server_sites }}"
   loop_control:
     label: "{{ item | combine({'admin_pw': omit}) }}"
-  changed_when: "__checkmk_server_sites_versions.stdout != item.version + '.' + item.edition | lower"
+  changed_when: "__checkmk_server_sites_versions.stdout != item.version + '.' + __checkmk_var_edition_id | lower"
   when: item.state != "absent"
   register: __checkmk_server_sites_versions
   tags:
diff --git a/roles/server/tasks/update-site.yml b/roles/server/tasks/update-site.yml
@@ -8,9 +8,15 @@
     - update-sites
 
 - name: "{{ item.item.name }}: Check if desired version is installed."
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.item.edition, __checkmk_server_edition_mapping[item.item.edition])
+      }}
   ansible.builtin.shell: |
     set -o pipefail
-    omd versions | egrep -o '{{ item.item.version }}.{{ item.item.edition | lower }}'
+    omd versions | egrep -o '{{ item.item.version }}.{{ __checkmk_var_edition_id | lower }}'
   args:
     executable: /bin/bash
   register: __checkmk_server_sites_versions
@@ -30,10 +36,16 @@
     - update-sites
 
 - name: "{{ item.item.name }}: Short pause for patch update."
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.item.edition, __checkmk_server_edition_mapping[item.item.edition])
+      }}
   ansible.builtin.pause:
     seconds: 5
     prompt: |
-      Proceeding with updating site {{ item.item.name }} from version {{ item.stdout }} to version {{ item.item.version }}.{{ item.item.edition | lower }}.
+      Proceeding with updating site {{ item.item.name }} from version {{ item.stdout }} to version {{ item.item.version }}.{{ __checkmk_var_edition_id | lower }}.
       This is a minor patch update.{% if checkmk_server_backup_on_update %} A backup will be created in {{ checkmk_server_backup_dir }}. {% endif %}
       This can take a while! The site will be down during the update
   when: |
@@ -42,11 +54,17 @@
     - update-pause
 
 - name: "{{ item.item.name }}: Long pause for major update."
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.item.edition, __checkmk_server_edition_mapping[item.item.edition])
+      }}
   ansible.builtin.pause:
     seconds: 60
     prompt: >
       Proceeding with updating site {{ item.item.name }}
-      from version {{ item.stdout }} to version {{ item.item.version }}.{{ item.item.edition | lower }}.\n
+      from version {{ item.stdout }} to version {{ item.item.version }}.{{ __checkmk_var_edition_id | lower }}.\n
       This is a major update. This can carry risks.
       {% if checkmk_server_backup_on_update %} A backup will be created in {{ checkmk_server_backup_dir }}. {% endif %}\n
       This can take a while! The site will be down during the update
@@ -57,8 +75,14 @@
 
 - name: "{{ item.item.name }}: Create Site Backup."  # noqa no-changed-when
   become: true
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.item.edition, __checkmk_server_edition_mapping[item.item.edition])
+      }}
   ansible.builtin.shell: |
-    omd backup {{ checkmk_server_backup_opts }} {{ item.item.name }} {{ checkmk_server_backup_dir }}/{{ item.item.name }}-{{ item.item.version }}.{{ item.item.edition | lower }}-backup-$(date +%Y%m%d-%H%M%S).tar.gz
+    omd backup {{ checkmk_server_backup_opts }} {{ item.item.name }} {{ checkmk_server_backup_dir }}/{{ item.item.name }}-{{ item.item.version }}.{{ __checkmk_var_edition_id | lower }}-backup-$(date +%Y%m%d-%H%M%S).tar.gz
   args:
     executable: /bin/bash
   when: checkmk_server_backup_on_update
@@ -67,9 +91,15 @@
 
 - name: "{{ item.item.name }}: Update Site."
   become: true
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.item.edition, __checkmk_server_edition_mapping[item.item.edition])
+      }}
   ansible.builtin.shell: |
     omd stop {{ item.item.name }}
-    omd -f -V {{ item.item.version }}.{{ item.item.edition | lower }} update --conflict {{ item.item.update_conflict_resolution }} {{ item.item.name }}
+    omd -f -V {{ item.item.version }}.{{ __checkmk_var_edition_id | lower }} update --conflict {{ item.item.update_conflict_resolution }} {{ item.item.name }}
   args:
     executable: /bin/bash
   register: __checkmk_server_sites_updated
diff --git a/roles/server/vars/RedHat.yml b/roles/server/vars/RedHat.yml
@@ -1,5 +1,4 @@
 ---
-
 __checkmk_server_setup_file: |-
   check-mk-{{ __checkmk_server_edition_mapping[checkmk_server_edition | lower] }}-{{ checkmk_server_version }}-el{{ ansible_distribution_major_version }}-38.x86_64.rpm
 
diff --git a/roles/server/vars/main.yml b/roles/server/vars/main.yml
@@ -3,12 +3,27 @@ __checkmk_server_base_url: "https://download.checkmk.com/checkmk"
 checkmk_server_download_url: "{{ __checkmk_server_base_url }}/{{ checkmk_server_version }}/{{ __checkmk_server_setup_file }}"
 checkmk_server_gpg_download_url: "{{ __checkmk_server_base_url }}/Check_MK-pubkey.gpg"
 
-# Due to inconsistent naming of editions, we normalize them here for convenience
-__checkmk_server_edition_mapping:
+# Due to inconsistent naming of editions, we normalize them here for convenience.
+__checkmk_var_legacy_edition_mapping:
   cre: raw
   cfe: free
   cee: enterprise
   cce: cloud
   cme: managed
 
+# Due to renaming of editions starting with 2.5.0, we normalize them here for convenience. Again.
+__checkmk_var_modern_edition_mapping:
+  cre: community
+  cee: pro
+  cce: ultimate
+  cme: ultimatemt
+  cse: cloud
+
+# Bringing the above two mappings back together.
+__checkmk_server_edition_mapping: >-
+  {{
+    ( (checkmk_server_version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+    | ternary(__checkmk_var_legacy_edition_mapping, __checkmk_var_modern_edition_mapping)
+  }}
+
 __checkmk_server_tmp_dir: "/tmp"
diff --git a/tests/integration/files/includes/tasks/prep.yml b/tests/integration/files/includes/tasks/prep.yml
@@ -27,7 +27,13 @@
     not 'check-mk-' + __checkmk_server_edition_mapping[item.edition] + '-' +item.version in ansible_facts.packages
 
 - name: "Create Sites."
-  ansible.builtin.command: "omd -V {{ item.version }}.{{ item.edition }} create --no-tmpfs --admin-password {{ checkmk_var_automation_secret }} {{ item.site }}"
+  vars:
+    __checkmk_var_edition_id: >-  # This can be reverted, once 2.5.0 is the oldest supported version
+      {{
+        ( (item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+        | ternary(item.edition, __checkmk_server_edition_mapping[item.edition])
+      }}
+  ansible.builtin.command: "omd -V {{ item.version }}.{{ __checkmk_var_edition_id }} create --no-tmpfs --admin-password {{ checkmk_var_automation_secret }} {{ item.site }}"
   args:
     creates: "/omd/sites/{{ item.site }}"
   loop: "{{ checkmk_var_test_sites }}"
diff --git a/tests/integration/files/includes/vars/global.yml b/tests/integration/files/includes/vars/global.yml
@@ -8,13 +8,28 @@ checkmk_var_automation_secret: "Sup3rSec4et!"
 # Generate download URL and provide credentials to download Checkmk setups
 checkmk_var_download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-{{ __checkmk_server_edition_mapping[item.edition] }}-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"  # noqa yaml[line-length]
 
-# Due to inconsistent naming of editions, we normalize them here for convenience
-__checkmk_server_edition_mapping:
+# Due to inconsistent naming of editions, we normalize them here for convenience.
+__checkmk_var_legacy_edition_mapping:
   cre: raw
+  cfe: free
   cee: enterprise
   cce: cloud
   cme: managed
 
+# Due to renaming of editions starting with 2.5.0, we normalize them here for convenience. Again.
+__checkmk_var_modern_edition_mapping:
+  cre: community
+  cee: pro
+  cce: ultimate
+  cme: ultimatemt
+  cse: cloud
+
+# Bringing the above two mappings back together.
+__checkmk_server_edition_mapping: >-
+  {{
+    ( (item.version | regex_replace('p.*', '')) is version('2.5.0', '<') )
+    | ternary(__checkmk_var_legacy_edition_mapping, __checkmk_var_modern_edition_mapping)
+  }}
 
 # This is a very hacky workaround, as it is not possible to assign variables
 # to other variables when using them in lookup modules.
diff --git a/tests/integration/targets/downtime/tasks/test.yml b/tests/integration/targets/downtime/tasks/test.yml
diff --git a/tests/unit/plugins/inventory/test_checkmk.py b/tests/unit/plugins/inventory/test_checkmk.py
diff --git a/tests/unit/plugins/module_utils/lookup_api.py b/tests/unit/plugins/module_utils/lookup_api.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+bugfixes:`
	`2`	`+ - Inventory plugin - Update CheckMKLookupAPI arguments in Inventory.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+bugfixes:`
	`2`	`+ - Downtime module - Bug fix documentation example, where the time stamps were not quoted correctly.`
	`3`	`+ - All roles - Update edition name mapping to compensate future naming changes.`
Original file line number	Diff line number	Diff line change
`@@ -154,8 +154,8 @@ def parse(self, inventory, loader, path, cache=False):`
`154`	`154`
`155`	`155`	`api = CheckMKLookupAPI(`
`156`	`156`	`site_url=self.get_option("server_url") + "/" + self.get_option("site"),`
`157`		`- user=self.get_option("automation_user"),`
`158`		`- secret=self.get_option("automation_secret"),`
	`157`	`+ automation_user=self.get_option("automation_user"),`
	`158`	`+ automation_secret=self.get_option("automation_secret"),`
`159`	`159`	`validate_certs=self.get_option("validate_certs"),`
`160`	`160`	`)`
`161`	`161`