Merge pull request #212 from tribe29/devel

Bump Checkmk versions and update documentation

CHANGELOG.rst

@@ -8,6 +8,11 @@ tribe29.checkmk Release Notes
 v0.14.0
 =======
 
+Deprecated Features
+-------------------
+
+- host_group module - The module was released with the module options `host_group_name` and `host_groups`. These have ben renamed to `name` and `groups` to align with our standards. The old names will be removed in a future release.
+
 v0.13.0
 =======
 

CONTRIBUTING.md

@@ -70,7 +70,19 @@ in the existing modules when creating additional modules.
 * 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.
+In general, stick to Ansible coding best practices and look out for test gotchas.
+
+**Module Options**
+
+There are different approaches to the module options, depending on the nature of the module:
+
+**Approach 1**: The module only interacts with one class of objects. For example the `host_group` module only ever interacts with host groups. Hence the module options should stay as simple as possible, e.g. `name` instead of `host_group_name` for the name of the host group.
+
+**Approach 2**: The module interacts with more than one class of objects. For example the `downtime` module can interact both with hosts and with services. Hence the module options need to be more precise than in *Approach 1*. For example `host_name` and `service_description` instead of just `name`, as that would not make clear with which class ob objects we are interacting.
+
+**Aliases**
+
+It is possible to implement an alias for a module option. This should be used rather carefully to not clutter the options. However, they can be an option, if one is uncertain how to name an option, or to deprecate an option, before actually removing it. If in doubt, feel free to ask for review in your PR.
 
 ### Roles
 The following are guidelines to keep in mind, when changing roles.

README.md

@@ -145,7 +145,7 @@ if you list the `tribe29.checkmk` collection in the playbook's [`collections`](h
 
 ## Contributing to this collection
 
-See [CONTRIBUTING](CONTRIBUTING).
+See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Release notes
 <!--Add a link to a changelog.rst file or an external docsite to cover this information. -->
@@ -162,10 +162,7 @@ Please do **not** consider a concrete planning document!
   - Setup
     - Agents
     - BI
-    - Contact Groups
-    - Host Groups
     - Passwords
-    - Service Groups
     - Time Periods
 - Lookup Plugins
   - Version

SECURITY.md

@@ -3,6 +3,7 @@
 ## Disambiguation
 This policy solely applies to the Checkmk Ansible Collection, not Checkmk itself!
 For Checkmk itself, please refer to [this Vulnerability disclosure policy](https://checkmk.com/responsible-disclosure-policy)
+
 ## Supported Versions
 
 Please always use the latest available version!  

SUPPORT.md

@@ -16,3 +16,4 @@ Collection Version | Checkmk Versions | Remarks
 0.12.0 | 2.1.0p11, 2.0.0p28 | None
 0.13.0 | 2.1.0p17, 2.0.0p31 | None
 0.14.0 | 2.1.0p17, 2.0.0p31 | None
+0.15.0 | 2.1.0p18, 2.0.0p32 | None

changelogs/archive/0.14.0/host_group.yml

@@ -0,0 +1,45 @@
+# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
+
+deprecated_features:
+  - host_group module - The module was released with the module options `host_group_name` and `host_groups`.
+    These have ben renamed to `name` and `groups` to align with our standards. The old names will be removed in a future release.
+
+## Line Format
+
+# When writing a changelog entry, use the following format:
+
+# - scope - description starting with a uppercase letter and ending with a period at the very end. Multiple sentences are allowed.
+
+# 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.
+
+
+## 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/changelog.yaml

@@ -122,6 +122,13 @@ releases:
     - service_group_module.yml
     release_date: '2022-12-02'
   0.14.0:
+    changes:
+      deprecated_features:
+      - host_group module - The module was released with the module options `host_group_name`
+        and `host_groups`. These have ben renamed to `name` and `groups` to align
+        with our standards. The old names will be removed in a future release.
+    fragments:
+    - host_group.yml
     release_date: '2022-12-09'
   0.2.0:
     changes:

roles/server/molecule/2.0.0/group_vars/all.yml

@@ -1,6 +1,6 @@
 ---
 # General
-checkmk_version: "2.0.0p31"
+checkmk_version: "2.0.0p32"
 checkmk_edition: "cre"
 checkmk_site: "stable"
 server_url: "http://127.0.0.1/"

roles/server/molecule/2.1.0/group_vars/all.yml

@@ -1,6 +1,6 @@
 ---
 # General
-checkmk_version: "2.1.0p17"
+checkmk_version: "2.1.0p18"
 checkmk_edition: "cre"
 checkmk_site: "stable"
 server_url: "http://127.0.0.1/"

tests/integration/targets/activation/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/contact_group/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/discovery/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/downtime/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/folder/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/host/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/host_group/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/rule/vars/main.yml

@@ -1,6 +1,6 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 site: "test"

tests/integration/targets/service_group/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"

tests/integration/targets/tag_group/vars/main.yml

@@ -1,8 +1,8 @@
 ---
 checkmk_versions:
-  - version: "2.1.0p17"
+  - version: "2.1.0p18"
     site: "stable"
-  - version: "2.0.0p31"
+  - version: "2.0.0p32"
     site: "oldstable"
 download_url: "https://download.checkmk.com/checkmk/{{ item.version }}/check-mk-raw-{{ item.version }}_0.{{ ansible_distribution_release }}_amd64.deb"
 server_url: "http://127.0.0.1/"