Merge pull request #118 from tribe29/devel

Prepare Release 0.7.0

.github/workflows/ansible-integration-tests.yaml

@@ -43,32 +43,24 @@ jobs:
       fail-fast: false
       matrix:
         ansible:
-          # - stable-2.9 # Only if your collection supports Ansible 2.9
-          # - stable-2.10
-          # - stable-2.11
           - stable-2.12
-          # - devel
+          - stable-2.13
+          - devel
         python:
-          # - '2.6'
           - '2.7'
           - '3.5'
           - '3.6'
           - '3.7'
           - '3.8'
           - '3.9'
           - '3.10'
+          - '3.11'
         exclude:
-          # Because ansible-test doesn't support Python 3.9 for Ansible 2.9
-          # and Python 3.10 is supported in 2.12 or later.
-          - ansible: stable-2.9
-            python: '3.9'
-          - ansible: stable-2.9
-            python: '3.10'
-          - ansible: stable-2.10
-            python: '3.10'
-          - ansible: stable-2.11
-            python: '3.10'
-
+          # Exclude unsupported sets.
+          - ansible: stable-2.12
+            python: '3.11'
+          - ansible: stable-2.13
+            python: '3.11'
 
     steps:
       - name: Check out code

.github/workflows/ansible-sanity-tests.yaml

@@ -41,12 +41,9 @@ jobs:
     strategy:
       matrix:
         ansible:
-          # It's important that Sanity is tested against all stable-X.Y branches
-          # Testing against `devel` may fail as new tests are added.
-          # - stable-2.9 # Only if your collection supports Ansible 2.9
-          # - stable-2.10
           - stable-2.11
           - stable-2.12
+          - stable-2.13
           - devel
     runs-on: ubuntu-latest
     steps:

CHANGELOG.rst

@@ -5,6 +5,25 @@ tribe29.checkmk Release Notes
 .. contents:: Topics
 
 
+v0.6.0
+======
+
+Release Summary
+---------------
+
+Introducing upgrade management for Checkmk sites!
+
+Major Changes
+-------------
+
+- Server role - Add support for automatically updating Checkmk. Read the role's README for important information!
+
+Bugfixes
+--------
+
+- Agent role - Fix SELinux handling on RedHat.
+- Agent role - Fix firewall handling on RedHat.
+
 v0.5.2
 ======
 

CONTRIBUTING.md

@@ -16,21 +16,7 @@ the time available is limited. We will try to be as transparent as possible
 about what we will include but please do not feel discouraged, if an idea
 or proposal gets rejected. Instead go on and create something yourself,
 if you think your approach is viable! There is already a lot of great content
-out there and we love seeing you add to that plethora of content!
-
-## Submitting Issues
-
-If you encounter any bugs or have ideas for improvements feel free to open an [issue](https://github.com/tribe29/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) or even better a [pull request](#Pull-Requests).
-Dedicated requirements will be added here as suitable.
-
-## Pull Requests
-
-Please open a [pull request](https://github.com/tribe29/ansible-collection-tribe29.checkmk/pulls?q=is%3Apr+is%3Aopen)
-if you have something to contribute.
-On pull request creation, checks will run and tell you,
-if your changes work with the collection. If errors are detected, please try to
-fix them and update your pull request accordingly.
-If you need help, feel free to ask for it.
+out there and we love seeing you add to that plethora of it!
 
 ## How to contribute
 
@@ -44,6 +30,20 @@ We do test everything to the best of our abilities, but nothing beats real world
 scenarios. Also if you can provide a bugfix yourself or you have an addition to
 the functionality, [pull requests](#Pull-Requests) are appreciated.
 
+### Submitting Issues
+
+If you encounter any bugs or have ideas for improvements feel free to open an [issue](https://github.com/tribe29/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) or even better a [pull request](#Pull-Requests).
+Dedicated requirements will be added here as suitable.
+
+### Pull Requests
+
+Please open a [pull request](https://github.com/tribe29/ansible-collection-tribe29.checkmk/pulls?q=is%3Apr+is%3Aopen)
+if you have something to contribute.
+On pull request creation, checks will run and tell you,
+if your changes work with the collection. If errors are detected, please try to
+fix them and update your pull request accordingly.
+If you need help, do ask for it.
+
 ### Changelog
 
 When changing this collection, please make sure to write a log of what you did.
@@ -59,6 +59,26 @@ Module documentation is compiled during a release and stored as `docs/module.rst
 but this is not ideal yet. However, please use the inline documentation as seen
 in the existing modules when creating additional modules.
 
+## Style Guide
+
+### Commit messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* The first line is a short title (limit to 72 characters or less)
+* Write [good commit messages](https://chris.beams.io/posts/git-commit/)
+
+### Plugins
+Specifics to be done. Stick to general Ansible coding best practices and look out for sanity check gotchas.
+
+### Roles
+The following are guidelines to keep in mind, when changing roles.
+- Variables
+    - Use snake case (`snake_case_variable`)
+    - Do not prefix the variable with an underscore ( `_` )
+- Tags
+    - When tagging roles, separate single words with dashes (`my-custom-tag`)
+
 ## Releasing this collection
 Releasing this collection is automated using GitHub Actions.
 Before running the action `Release Collection` against the `main` branch, the

Vagrantfile

@@ -20,16 +20,16 @@ Vagrant.configure("2") do |config|
       $script = <<-SCRIPT
       apt-get update
       apt-get install -y python3-pip
-      pip install -r /vagrant/requirements.txt
-      ansible-galaxy collection install -f -r /vagrant/requirements.yml
-      wget "https://download.checkmk.com/checkmk/2.1.0p4/check-mk-raw-2.1.0p4_0.focal_amd64.deb" -O /tmp/checkmk-stable.deb
-      wget "https://download.checkmk.com/checkmk/2.1.0p4/check-mk-raw-2.1.0p4_0.focal_amd64.deb" -O /tmp/checkmk-beta.deb
+      wget "https://download.checkmk.com/checkmk/2.1.0p10/check-mk-raw-2.1.0p10_0.focal_amd64.deb" -O /tmp/checkmk-stable.deb
+      wget "https://download.checkmk.com/checkmk/2.1.0p10/check-mk-raw-2.1.0p10_0.focal_amd64.deb" -O /tmp/checkmk-beta.deb
       apt-get install -y /tmp/checkmk-stable.deb
       omd create --admin-password 'cmk' stable
       apt-get install -y /tmp/checkmk-beta.deb
       omd create --admin-password 'cmk' beta
       omd status -b stable || omd start stable
       omd status -b beta || omd start beta
+      pip install -r /vagrant/requirements.txt
+      sudo -u vagrant ansible-galaxy collection install -f -r /vagrant/requirements.yml
       SCRIPT
       srv.vm.provision "shell", inline: $script
     end

changelogs/.plugin-cache.yaml

@@ -39,4 +39,4 @@ plugins:
   shell: {}
   strategy: {}
   vars: {}
-version: 0.5.2
+version: 0.6.0

changelogs/archive/0.6.0/release_summary.yml

@@ -0,0 +1,4 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+# WARNING Found no release_summary section in the changelog for this release. While this is not required, we suggest to add one with basic information on the release.
+release_summary: "Introducing upgrade management for Checkmk sites!"

changelogs/changelog.yaml

@@ -166,3 +166,17 @@ releases:
     - bugfix_agent_role.yml
     - bugfix_discovery_http_timeout.yml
     release_date: '2022-08-04'
+  0.6.0:
+    changes:
+      bugfixes:
+      - Agent role - Fix SELinux handling on RedHat.
+      - Agent role - Fix firewall handling on RedHat.
+      major_changes:
+      - Server role - Add support for automatically updating Checkmk. Read the role's
+        README for important information!
+      release_summary: Introducing upgrade management for Checkmk sites!
+    fragments:
+    - bugfix_agent_role.yml
+    - release_summary.yml
+    - server_update_feature.yml
+    release_date: '2022-08-25'

changelogs/fragments/agent_role.yml

@@ -0,0 +1,54 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+minor_changes:
+  - Agent role - Host attributes can be fully customized now.
+  - Agent role - Check for agent updater and controller binaries. Skip registration if respective binary is missing.
+  - Agent role - Label role. This enables skipping or running tasks exclusively. See the README for a detailed list.
+
+bugfixes:
+  - Agent role - Support CFE properly.
+  - Agent role - Support both normal and automation users properly.
+
+# 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_activation_module.yml

@@ -0,0 +1,49 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+bugfixes:
+  - Activation module - Fix waiting for activation completion (#103).
+  - Activation module - Fix possible race condition. (#123).
+
+# 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/release_summary.yml

@@ -1,4 +1,3 @@
 # https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
 
-# WARNING Found no release_summary section in the changelog for this release. While this is not required, we suggest to add one with basic information on the release.
-release_summary: "Introducing upgrade management for Checkmk sites!"
+release_summary: "Lots of love for the agent role!"

changelogs/fragments/server_role.yml

@@ -0,0 +1,48 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+minor_changes:
+  - Server role - Label role. This enables skipping or running tasks exclusively. See the README for a detailed list.
+
+# 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.

docs/activation_module.rst

@@ -1,3 +1,4 @@
+
 .. Document meta
 
 :orphan:
@@ -42,11 +43,7 @@ tribe29.checkmk.activation module -- Activate changes in Checkmk.
 .. Collection note
 
 .. note::
-    This module is part of the `tribe29.checkmk collection <https://galaxy.ansible.com/tribe29/checkmk>`_ (version 0.5.1).
-
-    You might already have this collection installed if you are using the ``ansible`` package.
-    It is not included in ``ansible-core``.
-    To check whether it is installed, run :code:`ansible-galaxy collection list`.
+    This module is part of the `tribe29.checkmk collection <https://galaxy.ansible.com/tribe29/checkmk>`_ (version 0.6.0).
 
     To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`.
 
@@ -200,8 +197,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
-      - :ansible-option-choices-entry:`yes`
+      - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`true`
 
       .. raw:: html
 
@@ -417,7 +414,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
       .. rst-class:: ansible-option-line
       .. rst-class:: ansible-option-sample
 
-      :ansible-option-sample-bold:`Sample:` "200"
+      :ansible-option-sample-bold:`Sample:` 200
 
 
       .. raw:: html