diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8f75b3b0b..457dd804e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,26 @@ tribe29.checkmk Release Notes .. contents:: Topics +v0.15.0 +======= + +Major Changes +------------- + +- The folder module now uses `name` instead of `title`. The latter is retained as an alias until further notice. +- The host module now uses `name` instead of `host_name`. The latter is retained as an alias but will be removed with a future release. + +Minor Changes +------------- + +- Agent role - Respect the variable `checkmk_agent_host_name` when downloading host specific agents. +- The playbooks shipped with the collection were cleaned up and update. Just for awareness. + +Breaking Changes / Porting Guide +-------------------------------- + +- Agent role - Remove host attribute `tag_agent` from the defaults. Should not be a breaking change, but be aware of it. + v0.14.0 ======= diff --git a/changelogs/.plugin-cache.yaml b/changelogs/.plugin-cache.yaml index a37ff2882..d8d1b6513 100644 --- a/changelogs/.plugin-cache.yaml +++ b/changelogs/.plugin-cache.yaml @@ -66,4 +66,4 @@ plugins: strategy: {} test: {} vars: {} -version: 0.14.0 +version: 0.15.0 diff --git a/changelogs/fragments/agent_role.yml b/changelogs/archive/0.15.0/agent_role.yml similarity index 100% rename from changelogs/fragments/agent_role.yml rename to changelogs/archive/0.15.0/agent_role.yml diff --git a/changelogs/fragments/module_options.yml b/changelogs/archive/0.15.0/module_options.yml similarity index 100% rename from changelogs/fragments/module_options.yml rename to changelogs/archive/0.15.0/module_options.yml diff --git a/changelogs/fragments/playbooks.yml b/changelogs/archive/0.15.0/playbooks.yml similarity index 100% rename from changelogs/fragments/playbooks.yml rename to changelogs/archive/0.15.0/playbooks.yml diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 604043385..d93b0f413 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -130,6 +130,26 @@ releases: fragments: - host_group.yml release_date: '2022-12-09' + 0.15.0: + changes: + breaking_changes: + - Agent role - Remove host attribute `tag_agent` from the defaults. Should not + be a breaking change, but be aware of it. + major_changes: + - The folder module now uses `name` instead of `title`. The latter is retained + as an alias until further notice. + - The host module now uses `name` instead of `host_name`. The latter is retained + as an alias but will be removed with a future release. + minor_changes: + - Agent role - Respect the variable `checkmk_agent_host_name` when downloading + host specific agents. + - The playbooks shipped with the collection were cleaned up and update. Just + for awareness. + fragments: + - agent_role.yml + - module_options.yml + - playbooks.yml + release_date: '2023-01-11' 0.2.0: changes: known_issues: diff --git a/docs/activation_module.rst b/docs/activation_module.rst index 76e19d055..50af3d51a 100644 --- a/docs/activation_module.rst +++ b/docs/activation_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.activation module -- Activate changes in Checkmk. .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. diff --git a/docs/contact_group_module.rst b/docs/contact_group_module.rst index 1f3b190cd..43b12bfd2 100644 --- a/docs/contact_group_module.rst +++ b/docs/contact_group_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.contact_group module -- Manage contact groups in Checkmk (bulk v .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. diff --git a/docs/discovery_module.rst b/docs/discovery_module.rst index 0dfa51588..6f5287fbc 100644 --- a/docs/discovery_module.rst +++ b/docs/discovery_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.discovery module -- Discover services in Checkmk. .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. diff --git a/docs/downtime_module.rst b/docs/downtime_module.rst index 257a55eb6..51a1e3b7f 100644 --- a/docs/downtime_module.rst +++ b/docs/downtime_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.downtime module -- Manage downtimes in Checkmk. .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. @@ -677,7 +677,7 @@ Examples - name: "Schedule host downtime." - downtime: + tribe29.checkmk.downtime: server_url: "{{ server_url }}" site: "{{ site }}" automation_user: "{{ automation_user }}" @@ -690,7 +690,7 @@ Examples hours: 5 - name: "Schedule service downtimes for two given services." - downtime: + tribe29.checkmk.downtime: server_url: "{{ server_url }}" site: "{{ site }}" automation_user: "{{ automation_user }}" diff --git a/docs/folder_module.rst b/docs/folder_module.rst index b65835e9a..35cfa1ac7 100644 --- a/docs/folder_module.rst +++ b/docs/folder_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.folder module -- Manage folders in Checkmk. .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. @@ -197,6 +197,46 @@ Parameters The automation user you want to use. It has to be an 'Automation' user, not a normal one. + .. raw:: html + + + + * - .. raw:: html + +
+
+
+ + .. _ansible_collections.tribe29.checkmk.folder_module__parameter-name: + .. _ansible_collections.tribe29.checkmk.folder_module__parameter-title: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-aliases:`aliases: title` + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of your folder. If omitted defaults to the folder name. + + .. raw:: html
@@ -341,40 +381,6 @@ Parameters - :ansible-option-choices-entry:`"absent"` - .. raw:: html - - - - * - .. raw:: html - -
-
- - .. _ansible_collections.tribe29.checkmk.folder_module__parameter-title: - - .. rst-class:: ansible-option-title - - **title** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - .. raw:: html - -
- - - .. raw:: html - -
- - The title of your folder. If omitted defaults to the folder name. - - .. raw:: html
@@ -447,7 +453,7 @@ Examples automation_user: "automation" automation_secret: "$SECRET" path: "/my_folder" - title: "My Folder" + name: "My Folder" state: "present" # Create a folder who's hosts should be hosted on a remote site. @@ -458,7 +464,7 @@ Examples automation_user: "automation" automation_secret: "$SECRET" path: "/my_remote_folder" - title: "My Remote Folder" + name: "My Remote Folder" attributes: site: "my_remote_site" state: "present" diff --git a/docs/host_group_module.rst b/docs/host_group_module.rst index 758112d50..594a079b6 100644 --- a/docs/host_group_module.rst +++ b/docs/host_group_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.host_group module -- Manage host groups in Checkmk (bulk version .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. diff --git a/docs/host_module.rst b/docs/host_module.rst index 2097d2f22..3f59bf74e 100644 --- a/docs/host_module.rst +++ b/docs/host_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.host module -- Manage hosts in Checkmk. .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. @@ -242,17 +242,23 @@ Parameters * - .. raw:: html
+
.. _ansible_collections.tribe29.checkmk.host_module__parameter-host_name: + .. _ansible_collections.tribe29.checkmk.host_module__parameter-name: .. rst-class:: ansible-option-title - **host_name** + **name** .. raw:: html - + + + .. rst-class:: ansible-option-type-line + + :ansible-option-aliases:`aliases: host_name` .. rst-class:: ansible-option-type-line @@ -450,7 +456,7 @@ Examples site: "my_site" automation_user: "automation" automation_secret: "$SECRET" - host_name: "my_host" + name: "my_host" folder: "/" state: "present" @@ -461,7 +467,7 @@ Examples site: "my_site" automation_user: "automation" automation_secret: "$SECRET" - host_name: "my_host" + name: "my_host" attributes: alias: "My Host" ipaddress: "127.0.0.1" @@ -475,7 +481,7 @@ Examples site: "my_site" automation_user: "automation" automation_secret: "$SECRET" - host_name: "my_host" + name: "my_host" attributes: site: "my_remote_site" folder: "/" diff --git a/docs/index.rst b/docs/index.rst index 32c8bef19..13c8cedee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Tribe29.Checkmk =============== -Collection version 0.14.0 +Collection version 0.15.0 .. contents:: :local: @@ -60,8 +60,6 @@ Modules * :ref:`service_group module ` -- Manage service groups in Checkmk (bulk version). * :ref:`tag_group module ` -- Manage tag\_group within Checkmk - - .. toctree:: :maxdepth: 1 :hidden: @@ -76,3 +74,5 @@ Modules rule_module service_group_module tag_group_module + + diff --git a/docs/rule_module.rst b/docs/rule_module.rst index d824659f6..ec898f25d 100644 --- a/docs/rule_module.rst +++ b/docs/rule_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.rule module -- Manage rules in Checkmk. .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. diff --git a/docs/service_group_module.rst b/docs/service_group_module.rst index 5d870c105..d67eec089 100644 --- a/docs/service_group_module.rst +++ b/docs/service_group_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.service_group module -- Manage service groups in Checkmk (bulk v .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`. diff --git a/docs/tag_group_module.rst b/docs/tag_group_module.rst index 9dd7ce5ce..037514b4e 100644 --- a/docs/tag_group_module.rst +++ b/docs/tag_group_module.rst @@ -42,7 +42,7 @@ tribe29.checkmk.tag_group module -- Manage tag\_group within Checkmk .. Collection note .. note:: - This module is part of the `tribe29.checkmk collection `_ (version 0.14.0). + This module is part of the `tribe29.checkmk collection `_ (version 0.15.0). To install it, use: :code:`ansible-galaxy collection install tribe29.checkmk`.