Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelogs and docs upon release #711

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Update changelogs and docs upon release #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73a4c23
Update Docs and Changelogs upon Release
robin-checkmk Jan 14, 2025
a2b253a
Merge pull request #710 from Checkmk/changelogs-docs-update-5.4.0
robin-checkmk Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ checkmk.general Release Notes

.. contents:: Topics

v5.4.0
======

Release Summary
---------------

Enabling proxy registration for the agent role.

Minor Changes
-------------

- Agent role - Add option to perform a proxy registration. Refer to the README for details.

v5.3.2
======

Expand Down
2 changes: 1 addition & 1 deletion changelogs/.plugin-cache.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,4 @@ plugins:
strategy: {}
test: {}
vars: {}
version: 5.3.2
version: 5.4.0
0 changelogs/fragments/agent.yml → changelogs/archive/5.4.0/agent.yml
View file
Open in desktop
File renamed without changes.
0 changelogs/fragments/release_summary.yml → changelogs/archive/5.4.0/release_summary.yml
View file
Open in desktop
File renamed without changes.
10 changes: 10 additions & 0 deletions changelogs/changelog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1062,3 +1062,13 @@ releases:
fragments:
- release.yml
release_date: '2024-12-24'
5.4.0:
changes:
minor_changes:
- Agent role - Add option to perform a proxy registration. Refer to the README
for details.
release_summary: Enabling proxy registration for the agent role.
fragments:
- agent.yml
- release_summary.yml
release_date: '2025-01-14'
8 changes: 4 additions & 4 deletions docs/activation_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -258,7 +258,7 @@ Parameters

<div class="ansible-option-cell">

The base url of your Checkmk server including the protocol.
The base url of your Checkmk server including the protocol but excluding the site.


.. raw:: html
Expand Down Expand Up @@ -292,7 +292,7 @@ Parameters

<div class="ansible-option-cell">

The site you want to connect to.
The site you want to connect to. This will be appended to the server\_url as part of the API request url.


.. raw:: html
Expand Down
24 changes: 8 additions & 16 deletions docs/agent_role.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -20,7 +20,7 @@ checkmk.general.agent role -- Install Checkmk agents
.. Collection note

.. note::
This role is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.3.2).
This role is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -785,12 +785,8 @@ Parameters

<div class="ansible-option-cell">

Refer to the README for details.

Refer to the README for details. This is mutually exclusive with 'checkmk\_agent\_secret'.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ checkmk\_var\_automation\_secret }}"`

.. raw:: html

Expand Down Expand Up @@ -917,7 +913,7 @@ Parameters

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ checkmk\_agent\_server }}"`
:ansible-option-default-bold:`Default:` :ansible-option-default:`"localhost"`

.. raw:: html

Expand Down Expand Up @@ -958,7 +954,7 @@ Parameters

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ checkmk\_agent\_server\_protocol }}"`
:ansible-option-default-bold:`Default:` :ansible-option-default:`"http"`

.. raw:: html

Expand Down Expand Up @@ -999,7 +995,7 @@ Parameters

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ checkmk\_agent\_site }}"`
:ansible-option-default-bold:`Default:` :ansible-option-default:`"mysite"`

.. raw:: html

Expand Down Expand Up @@ -1035,12 +1031,8 @@ Parameters

<div class="ansible-option-cell">

Refer to the README for details.


.. rst-class:: ansible-option-line
Refer to the README for details. This is mutually exclusive with 'checkmk\_agent\_pass'.

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ checkmk\_var\_automation\_secret }}"`

.. raw:: html

Expand Down Expand Up @@ -1409,7 +1401,7 @@ Parameters

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ automation\_user | default('automation') }}"`
:ansible-option-default-bold:`Default:` :ansible-option-default:`"automation"`

.. raw:: html

Expand Down
4 changes: 2 additions & 2 deletions docs/bakery_lookup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down
8 changes: 4 additions & 4 deletions docs/bakery_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -173,7 +173,7 @@ Parameters

<div class="ansible-option-cell">

The base url of your Checkmk server including the protocol.
The base url of your Checkmk server including the protocol but excluding the site.


.. raw:: html
Expand Down Expand Up @@ -275,7 +275,7 @@ Parameters

<div class="ansible-option-cell">

The site you want to connect to.
The site you want to connect to. This will be appended to the server\_url as part of the API request url.


.. raw:: html
Expand Down
8 changes: 4 additions & 4 deletions docs/checkmk_inventory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,7 @@ checkmk.general.checkmk inventory -- Dynamic Inventory Source or Checkmk
.. Collection note

.. note::
This inventory plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.3.2).
This inventory plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -263,7 +263,7 @@ Parameters

<div class="ansible-option-cell">

The base url of your Checkmk server including the protocol.
The base url of your Checkmk server including the protocol but excluding the site.


.. raw:: html
Expand Down Expand Up @@ -300,7 +300,7 @@ Parameters

<div class="ansible-option-cell">

The site you want to connect to.
The site you want to connect to. This will be appended to the server\_url as part of the API request url.


.. raw:: html
Expand Down
8 changes: 4 additions & 4 deletions docs/contact_group_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -279,7 +279,7 @@ Parameters

<div class="ansible-option-cell">

The base url of your Checkmk server including the protocol.
The base url of your Checkmk server including the protocol but excluding the site.


.. raw:: html
Expand Down Expand Up @@ -313,7 +313,7 @@ Parameters

<div class="ansible-option-cell">

The site you want to connect to.
The site you want to connect to. This will be appended to the server\_url as part of the API request url.


.. raw:: html
Expand Down
8 changes: 4 additions & 4 deletions docs/discovery_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -367,7 +367,7 @@ Parameters

<div class="ansible-option-cell">

The base url of your Checkmk server including the protocol.
The base url of your Checkmk server including the protocol but excluding the site.


.. raw:: html
Expand Down Expand Up @@ -401,7 +401,7 @@ Parameters

<div class="ansible-option-cell">

The site you want to connect to.
The site you want to connect to. This will be appended to the server\_url as part of the API request url.


.. raw:: html
Expand Down
8 changes: 4 additions & 4 deletions docs/downtime_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down Expand Up @@ -401,7 +401,7 @@ Parameters

<div class="ansible-option-cell">

The base url of your Checkmk server including the protocol.
The base url of your Checkmk server including the protocol but excluding the site.


.. raw:: html
Expand Down Expand Up @@ -473,7 +473,7 @@ Parameters

<div class="ansible-option-cell">

The site you want to connect to.
The site you want to connect to. This will be appended to the server\_url as part of the API request url.


.. raw:: html
Expand Down
2 changes: 1 addition & 1 deletion docs/environment_variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:orphan:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. _list_of_collection_env_vars:

Expand Down
4 changes: 2 additions & 2 deletions docs/folder_lookup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:trim:

.. meta::
:antsibull-docs: 2.16.1
:antsibull-docs: 2.16.2

.. Anchors

Expand All @@ -22,7 +22,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 5.3.2).
This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.4.0).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
Expand Down
Loading