Merge pull request Checkmk#561 from Checkmk/devel

CHANGELOG.rst

@@ -4,6 +4,33 @@ checkmk.general Release Notes
 
 .. contents:: Topics
 
+v4.3.0
+======
+
+Release Summary
+---------------
+
+Reworking the CI, enhancing code quality and improving modules.
+
+Minor Changes
+-------------
+
+- Folder module - Extend attribute management. Please refer to the module documentation for more details.
+- Lookup modules - Enable usage of ini files, environment and inventory variables to configure basic settings for the lookup plugins, like e.g., the server_url or site alongside the authentication options. Refer to the module documentation for details.
+- Rule module - Introduce rule_id to uniquely identify rules. This ID can be retrieved e.g., using the lookup plugin. Refer to the module documentation for further details.
+
+Bugfixes
+--------
+
+- Folder module - Fix idempotency when using "attributes" parameter for creating a folder.
+- Folder module - Parents will be parsed properly now. This means, that parents given as a string will now be parsed as a list of one.
+- Host module - Parents will be parsed properly now. This means, that parents given as a string will now be parsed as a list of one.
+- User module - Fix bug, where an absent user was created, if 'reset_password' was used.
+
+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.
 
 v4.2.0
 ======
@@ -604,7 +631,6 @@ Major Changes
 Minor Changes
 -------------
 
-
 v0.12.0
 =======
 

changelogs/.plugin-cache.yaml

@@ -31,15 +31,15 @@ plugins:
       name: hosts
       version_added: 3.3.0
     rule:
-      description: Show rule
+      description: Show a rule
       name: rule
       version_added: 3.5.0
     rules:
-      description: List rules
+      description: Get a list rules
       name: rules
       version_added: 3.5.0
     ruleset:
-      description: Show ruleset
+      description: Show a ruleset
       name: ruleset
       version_added: 3.5.0
     rulesets:
@@ -126,4 +126,4 @@ plugins:
   strategy: {}
   test: {}
   vars: {}
-version: 4.2.0
+version: 4.3.0

changelogs/changelog.yaml

@@ -823,3 +823,38 @@ releases:
     - tag_group.yml
     - user.yml
     release_date: '2024-01-23'
+  4.3.0:
+    changes:
+      bugfixes:
+      - Folder module - Fix idempotency when using "attributes" parameter for creating
+        a folder.
+      - Folder module - Parents will be parsed properly now. This means, that parents
+        given as a string will now be parsed as a list of one.
+      - Host module - Parents will be parsed properly now. This means, that parents
+        given as a string will now be parsed as a list of one.
+      - User module - Fix bug, where an absent user was created, if 'reset_password'
+        was used.
+      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.
+      minor_changes:
+      - Folder module - Extend attribute management. Please refer to the module documentation
+        for more details.
+      - Lookup modules - Enable usage of ini files, environment and inventory variables
+        to configure basic settings for the lookup plugins, like e.g., the server_url
+        or site alongside the authentication options. Refer to the module documentation
+        for details.
+      - Rule module - Introduce rule_id to uniquely identify rules. This ID can be
+        retrieved e.g., using the lookup plugin. Refer to the module documentation
+        for further details.
+      release_summary: Reworking the CI, enhancing code quality and improving modules.
+    fragments:
+    - fix_folder_module_idempotency.yml
+    - folder.yml
+    - lookups.yml
+    - parents.yml
+    - release_summary.yml
+    - rule.yml
+    - user.yml
+    release_date: '2024-02-16'

docs/activation_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.6.1
+  :antsibull-docs: 2.7.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.2.0).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -259,7 +259,7 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      The base url of your Checkmk server.
+      The base url of your Checkmk server including the protocol.
 
 
       .. raw:: html

docs/bakery_lookup.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.6.1
+  :antsibull-docs: 2.7.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.2.0).
+    This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -112,7 +112,24 @@ examples: ``lookup('checkmk.general.bakery', key1=value1, key2=value2, ...)`` an
 
         <div class="ansible-option-cell">
 
-      automation secret for the REST API access
+      Automation secret for the REST API access.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-configuration:`Configuration:`
+
+      - INI entry:
+
+        .. code-block::
+
+          [checkmk_lookup]
+          automation_secret = VALUE
+
+
+      - Environment variable: :envvar:`ANSIBLE\_LOOKUP\_CHECKMK\_AUTOMATION\_SECRET`
+
+      - Variable: ansible\_lookup\_checkmk\_automation\_secret
 
 
       .. raw:: html
@@ -149,7 +166,24 @@ examples: ``lookup('checkmk.general.bakery', key1=value1, key2=value2, ...)`` an
 
         <div class="ansible-option-cell">
 
-      automation user for the REST API access
+      Automation user for the REST API access.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-configuration:`Configuration:`
+
+      - INI entry:
+
+        .. code-block::
+
+          [checkmk_lookup]
+          automation_user = VALUE
+
+
+      - Environment variable: :envvar:`ANSIBLE\_LOOKUP\_CHECKMK\_AUTOMATION\_USER`
+
+      - Variable: ansible\_lookup\_checkmk\_automation\_user
 
 
       .. raw:: html
@@ -189,6 +223,23 @@ examples: ``lookup('checkmk.general.bakery', key1=value1, key2=value2, ...)`` an
       URL of the Checkmk server
 
 
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-configuration:`Configuration:`
+
+      - INI entry:
+
+        .. code-block::
+
+          [checkmk_lookup]
+          server_url = VALUE
+
+
+      - Environment variable: :envvar:`ANSIBLE\_LOOKUP\_CHECKMK\_SERVER\_URL`
+
+      - Variable: ansible\_lookup\_checkmk\_server\_url
+
+
       .. raw:: html
 
         </div>
@@ -223,7 +274,24 @@ examples: ``lookup('checkmk.general.bakery', key1=value1, key2=value2, ...)`` an
 
         <div class="ansible-option-cell">
 
-      site name
+      Site name.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-configuration:`Configuration:`
+
+      - INI entry:
+
+        .. code-block::
+
+          [checkmk_lookup]
+          site = VALUE
+
+
+      - Environment variable: :envvar:`ANSIBLE\_LOOKUP\_CHECKMK\_SITE`
+
+      - Variable: ansible\_lookup\_checkmk\_site
 
 
       .. raw:: html
@@ -260,7 +328,7 @@ examples: ``lookup('checkmk.general.bakery', key1=value1, key2=value2, ...)`` an
 
         <div class="ansible-option-cell">
 
-      Wether or not to validate TLS certificates
+      Whether or not to validate TLS certificates.
 
 
       .. rst-class:: ansible-option-line
@@ -271,6 +339,23 @@ examples: ``lookup('checkmk.general.bakery', key1=value1, key2=value2, ...)`` an
       - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
 
 
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-configuration:`Configuration:`
+
+      - INI entry:
+
+        .. code-block::
+
+          [checkmk_lookup]
+          validate_certs = true
+
+
+      - Environment variable: :envvar:`ANSIBLE\_LOOKUP\_CHECKMK\_VALIDATE\_CERTS`
+
+      - Variable: ansible\_lookup\_checkmk\_validate\_certs
+
+
       .. raw:: html
 
         </div>
@@ -288,6 +373,7 @@ Notes
    - Like all lookups, this runs on the Ansible controller and is unaffected by other keywords such as 'become'. If you need to use different permissions, you must change the command or run Ansible as another user.
    - Alternatively, you can use a shell/command task that runs against localhost and registers the result.
    - The directory of the play is used as the current working directory.
+   - It is \ :strong:`NOT`\  possible to assign other variables to the variables mentioned in the \ :literal:`vars`\  section! This is a limitation of Ansible itself.
 
 .. Seealso
 
@@ -301,7 +387,7 @@ Examples
 
 
     - name: "Show bakery status"
-      debug:
+      ansible.builtin.debug:
         msg: "Bakery status is {{ bakery }}"
       vars:
         bakery: "{{ lookup('checkmk.general.bakery',
@@ -312,6 +398,17 @@ Examples
                        automation_secret=automation_secret
                    )}}"
 
+    - name: "Use variables outside the module call."
+      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_validate_certs: false
+        bakery: "{{ lookup('checkmk.general.bakery') }}"
+
 
 
 

docs/bakery_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.6.1
+  :antsibull-docs: 2.7.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.2.0).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -174,7 +174,7 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      The base url of your Checkmk server.
+      The base url of your Checkmk server including the protocol.
 
 
       .. raw:: html

docs/contact_group_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.6.1
+  :antsibull-docs: 2.7.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.2.0).
+    This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.3.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -280,7 +280,7 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      The base url of your Checkmk server.
+      The base url of your Checkmk server including the protocol.
 
 
       .. raw:: html