Merge pull request #592 from Checkmk/devel

Update changelogs and docs upon release

CHANGELOG.rst

@@ -4,6 +4,33 @@ checkmk.general Release Notes
 
 .. contents:: Topics
 
+v4.4.0
+======
+
+Release Summary
+---------------
+
+Spring is here! With a rewritten host module including check mode and cluster support.
+
+Major Changes
+-------------
+
+- Host module - Add support for cluster hosts.
+- Host module - Enable check mode.
+- Host module - Update attribute management behavior. Refer to the documentation for details.
+
+Minor Changes
+-------------
+
+- Host module - Migrate module to the new collection API.
+
+Bugfixes
+--------
+
+- Bakery module - Fix failing integration test due to wrong key passphrase.
+- Folder module - Fix issue where the `name` (alias `title`) was entirely ignored.
+- Folder module - Fix issues with uppercase and lowercase names.
+
 v4.3.1
 ======
 
@@ -43,7 +70,7 @@ Bugfixes
 Known Issues
 ------------
 
-- Lookup modules - When using inventory variables to configure e.g., the server_url, it is not possible to assign other variables to these variables. This is a limitation of Ansble itself.
+- Lookup modules - When using inventory variables to configure e.g., the server_url, it is not possible to assign other variables to these variables. This is a limitation of Ansible itself.
 
 v4.2.0
 ======

changelogs/.plugin-cache.yaml

@@ -126,4 +126,4 @@ plugins:
   strategy: {}
   test: {}
   vars: {}
-version: 4.3.1
+version: 4.4.0

changelogs/changelog.yaml

@@ -867,3 +867,24 @@ releases:
     - fix_rule_conditions_missing.yml
     - release_summary.yml
     release_date: '2024-02-21'
+  4.4.0:
+    changes:
+      bugfixes:
+      - Bakery module - Fix failing integration test due to wrong key passphrase.
+      - Folder module - Fix issue where the `name` (alias `title`) was entirely ignored.
+      - Folder module - Fix issues with uppercase and lowercase names.
+      major_changes:
+      - Host module - Add support for cluster hosts.
+      - Host module - Enable check mode.
+      - Host module - Update attribute management behavior. Refer to the documentation
+        for details.
+      minor_changes:
+      - Host module - Migrate module to the new collection API.
+      release_summary: Spring is here! With a rewritten host module including check
+        mode and cluster support.
+    fragments:
+    - bakery.yml
+    - folder.yml
+    - host.yml
+    - release_summary.yml
+    release_date: '2024-04-17'

docs/activation_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.activation module -- Activate changes in Checkmk.
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/bakery_lookup.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.bakery lookup -- Get the bakery status of a Checkmk server
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -391,8 +391,8 @@ Examples
         msg: "Bakery status is {{ bakery }}"
       vars:
         bakery: "{{ lookup('checkmk.general.bakery',
-                       server_url=http://myserver,
-                       site=mysite,
+                       server_url=http://my_server,
+                       site=my_site,
                        validate_certs=False,
                        automation_user=automation_user,
                        automation_secret=automation_secret
@@ -402,10 +402,10 @@ Examples
       ansible.builtin.debug:
         msg: "Bakery status is {{ bakery }}"
       vars:
-        ansible_lookup_checkmk_server_url: "{{ checkmk_var_server_url }}"
-        ansible_lookup_checkmk_site: "{{ outer_item.site }}"
-        ansible_lookup_checkmk_automation_user: "{{ checkmk_var_automation_user }}"
-        ansible_lookup_checkmk_automation_secret: "{{ checkmk_var_automation_secret }}"
+        ansible_lookup_checkmk_server_url: "http://my_server/"
+        ansible_lookup_checkmk_site: "my_site"
+        ansible_lookup_checkmk_automation_user: "my_user"
+        ansible_lookup_checkmk_automation_secret: "my_secret"
         ansible_lookup_checkmk_validate_certs: false
         bakery: "{{ lookup('checkmk.general.bakery') }}"
 

docs/bakery_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.bakery module -- Trigger baking and signing in the agent bakery.
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -402,7 +402,7 @@ Examples
         automation_user: "my_user"
         automation_secret: "my_secret"
         signature_key_id: 1
-        signature_key_passphrase: "secretkey"
+        signature_key_passphrase: "my_key"
         state: "signed"
     # Bake and sign all agents.
     - name: "Bake and sign all agents."
@@ -412,7 +412,7 @@ Examples
         automation_user: "my_user"
         automation_secret: "my_secret"
         signature_key_id: 1
-        signature_key_passphrase: "secretkey"
+        signature_key_passphrase: "my_key"
         state: "baked_signed"
 
 

docs/contact_group_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.contact_group module -- Manage contact groups in Checkmk (bulk v
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/discovery_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.discovery module -- Discover services in Checkmk.
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/downtime_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.downtime module -- Manage downtimes in Checkmk.
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/environment_variables.rst

@@ -2,7 +2,7 @@
 :orphan:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. _list_of_collection_env_vars:
 

docs/folder_lookup.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.folder lookup -- Get folder attributes
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -462,10 +462,10 @@ Examples
       ansible.builtin.debug:
         msg: "Attributes of folder /network: {{ attributes }}"
       vars:
-        ansible_lookup_checkmk_server_url: "{{ checkmk_var_server_url }}"
-        ansible_lookup_checkmk_site: "{{ outer_item.site }}"
-        ansible_lookup_checkmk_automation_user: "{{ checkmk_var_automation_user }}"
-        ansible_lookup_checkmk_automation_secret: "{{ checkmk_var_automation_secret }}"
+        ansible_lookup_checkmk_server_url: "http://my_server/"
+        ansible_lookup_checkmk_site: "my_site"
+        ansible_lookup_checkmk_automation_user: "my_user"
+        ansible_lookup_checkmk_automation_secret: "my_secret"
         ansible_lookup_checkmk_validate_certs: false
         attributes: "{{ lookup('checkmk.general.folder', '~tests') }}"
 

docs/folder_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.folder module -- Manage folders in Checkmk.
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -254,7 +254,7 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      The name of your folder. If omitted defaults to the folder name.
+      The name (title) of your folder. If omitted defaults to the string after the last \ :literal:`/`\  in \ :emphasis:`path`\ .
 
 
       .. raw:: html

docs/folders_lookup.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.folders lookup -- Get various information about a folder
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -576,10 +576,10 @@ Examples
       ansible.builtin.debug:
         msg: "Folder tree: {{ item.id }}"
       vars:
-        ansible_lookup_checkmk_server_url: "{{ checkmk_var_server_url }}"
-        ansible_lookup_checkmk_site: "{{ outer_item.site }}"
-        ansible_lookup_checkmk_automation_user: "{{ checkmk_var_automation_user }}"
-        ansible_lookup_checkmk_automation_secret: "{{ checkmk_var_automation_secret }}"
+        ansible_lookup_checkmk_server_url: "http://my_server/"
+        ansible_lookup_checkmk_site: "my_site"
+        ansible_lookup_checkmk_automation_user: "my_user"
+        ansible_lookup_checkmk_automation_secret: "my_secret"
         ansible_lookup_checkmk_validate_certs: false
       loop: "{{
         lookup('checkmk.general.folders',

docs/host_group_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.host_group module -- Manage host groups in Checkmk (bulk version
 .. Collection note
 
 .. note::
-    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/host_lookup.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.7.0
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
@@ -23,7 +23,7 @@ checkmk.general.host lookup -- Get host attributes
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.1).
+    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -508,10 +508,10 @@ Examples
       ansible.builtin.debug:
         msg: "Attributes of host example: {{ attributes }}"
       vars:
-        ansible_lookup_checkmk_server_url: "{{ checkmk_var_server_url }}"
-        ansible_lookup_checkmk_site: "{{ outer_item.site }}"
-        ansible_lookup_checkmk_automation_user: "{{ checkmk_var_automation_user }}"
-        ansible_lookup_checkmk_automation_secret: "{{ checkmk_var_automation_secret }}"
+        ansible_lookup_checkmk_server_url: "http://my_server/"
+        ansible_lookup_checkmk_site: "my_site"
+        ansible_lookup_checkmk_automation_user: "my_user"
+        ansible_lookup_checkmk_automation_secret: "my_secret"
         ansible_lookup_checkmk_validate_certs: false
         attributes: "{{ lookup('checkmk.general.host', 'example.com', effective_attributes=True) }}"