Skip to content

Commit 044ffa1

Browse files
committed
Merge branch 'devel' of github.com:Checkmk/ansible-collection-checkmk.general into build/add-changelog-to-release
2 parents fb60b9f + 2c7ef35 commit 044ffa1

File tree

100 files changed

+1721
-1146
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+1721
-1146
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
tribe29-checkmk-*.tar.gz
66
checkmk-general-*.tar.gz
77
.vagrant/
8+
.tox/
89
build/
910
tests/output
1011
playbooks/vars/config.yml
1112
playbooks/test*.yml
1213
playbooks/hosts
1314
playbooks/hosts.bak
1415
Vagrantfile
15-
Vagrantfile.bak
16+
Vagrantfile.bak
17+
venv

CHANGELOG.rst

+34
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,40 @@ checkmk.general Release Notes
44

55
.. contents:: Topics
66

7+
v5.0.0
8+
======
9+
10+
Release Summary
11+
---------------
12+
13+
(Re)writing history with overhauled modules and updated Checkmk, Ansible, Distribution and Python support.
14+
15+
Major Changes
16+
-------------
17+
18+
- Discovery module - The module now fully supports Checkmk 2.3.0. Additionally, two new parameters were introduced, `update_service_labels` and `monitor_undecided_services`. Refer to the module documentation for further details.
19+
- Rule module - The complete module was rewritten to use the new module API. Additionally, a parameter "rule_id" was introduced to modify existing rules. Refer to the module documentation for further details.
20+
21+
Minor Changes
22+
-------------
23+
24+
- Agent role - Add support to open firewall for a list of IPs.
25+
- Agent role - Replace `ansible.builtin.yum` with the succeeding `ansible.builtin.dnf`.
26+
- Server role - Replace `ansible.builtin.yum` with the succeeding `ansible.builtin.dnf`.
27+
- Several modules - Remove unnecessary HTTP codes which get already imported via utils.py.
28+
- Testing - Add Ansible 2.17 to all tests. Be advised, that this Ansible release drops support for Python 2.7 and 3.6.
29+
- Testing - Add Ubuntu 24.04 to the Molecule tests.
30+
- Testing - All tests now cover Checkmk 2.3.0.
31+
- Testing - Remove Ansible 2.14 from all tests, as it is EOL.
32+
- Testing - Remove Checkmk 2.0.0 from all tests, as it is EOL.
33+
- Testing - The Molecule tests now run on Ubuntu 22.04.
34+
35+
Breaking Changes / Porting Guide
36+
--------------------------------
37+
38+
- Agent role - Not really a breaking change, but we removed the internal variable `checkmk_agent_server_ip`. If you set this variable in your inventory, please make sure to update your configuration accordingly!
39+
- Folder lookup module - Return the complete folder information, not only the extensions. To keep the current behavior in your playbooks, you want to use `{{ my_lookup_result.extensions }}` instead of `{{ my_lookup_result }}`.
40+
741
v4.4.1
842
======
943

SUPPORT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ Collection Version | Checkmk Versions | Ansible Versions | Remarks
5353
4.3.1 | 2.0.0p39, 2.1.0p39, 2.2.0p22 | 2.14, 2.15, 2.16 | None
5454
4.4.0 | 2.0.0p39, 2.1.0p41, 2.2.0p24 | 2.14, 2.15, 2.16 | None
5555
4.4.1 | 2.0.0p39, 2.1.0p41, 2.2.0p24 | 2.14, 2.15, 2.16 | None
56-
5.0.0 | 2.1.0p43, 2.2.0p26, 2.3.0p3 | 2.15, 2.16, 2.17 | Breaking changes to the following modules: `lookup_folder`, `rule`.
56+
5.0.0 | 2.1.0p44, 2.2.0p27, 2.3.0p5 | 2.15, 2.16, 2.17 | Breaking changes to the following modules: `lookup_folder`, `rule` and role: `agent`.

changelogs/.plugin-cache.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,4 @@ plugins:
126126
strategy: {}
127127
test: {}
128128
vars: {}
129-
version: 4.4.1
129+
version: 5.0.0

changelogs/archive/5.0.0/agent.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
minor_changes:
2+
- Agent role - Add support to open firewall for a list of IPs.
3+
4+
breaking_changes:
5+
- Agent role - Not really a breaking change, but we removed the internal variable `checkmk_agent_server_ip`.
6+
If you set this variable in your inventory, please make sure to update your configuration accordingly!

changelogs/fragments/build.yml renamed to changelogs/archive/5.0.0/build.yml

+2
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ minor_changes:
44
- Testing - The Molecule tests now run on Ubuntu 22.04.
55
- Testing - Add Ubuntu 24.04 to the Molecule tests.
66
- Testing - Remove Ansible 2.14 from all tests, as it is EOL.
7+
- Testing - Add Ansible 2.17 to all tests.
8+
Be advised, that this Ansible release drops support for Python 2.7 and 3.6.
+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
major_changes:
2+
- Discovery module - The module now fully supports Checkmk 2.3.0.
3+
Additionally, two new parameters were introduced, `update_service_labels` and `monitor_undecided_services`.
4+
Refer to the module documentation for further details.

changelogs/archive/5.0.0/http.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
minor_changes:
2+
- Several modules - Remove unnecessary HTTP codes which get already imported via utils.py.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
breaking_changes:
2+
- Folder lookup module - Return the complete folder information, not only the extensions.
3+
To keep the current behavior in your playbooks, you want to use `{{ my_lookup_result.extensions }}`
4+
instead of `{{ my_lookup_result }}`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
release_summary: "(Re)writing history with overhauled modules and updated Checkmk, Ansible, Distribution and Python support."

changelogs/archive/5.0.0/roles.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
minor_changes:
2+
- Agent role - Replace `ansible.builtin.yum` with the succeeding `ansible.builtin.dnf`.
3+
- Server role - Replace `ansible.builtin.yum` with the succeeding `ansible.builtin.dnf`.
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
minor_changes:
1+
major_changes:
22
- Rule module - The complete module was rewritten to use the new module API.
33
Additionally, a parameter "rule_id" was introduced to modify existing rules.
44
Refer to the module documentation for further details.

changelogs/changelog.yaml

+41
Original file line numberDiff line numberDiff line change
@@ -901,3 +901,44 @@ releases:
901901
- meta.yml
902902
- release_summary.yml
903903
release_date: '2024-05-01'
904+
5.0.0:
905+
changes:
906+
breaking_changes:
907+
- Agent role - Not really a breaking change, but we removed the internal variable
908+
`checkmk_agent_server_ip`. If you set this variable in your inventory, please
909+
make sure to update your configuration accordingly!
910+
- Folder lookup module - Return the complete folder information, not only the
911+
extensions. To keep the current behavior in your playbooks, you want to use
912+
`{{ my_lookup_result.extensions }}` instead of `{{ my_lookup_result }}`.
913+
major_changes:
914+
- Discovery module - The module now fully supports Checkmk 2.3.0. Additionally,
915+
two new parameters were introduced, `update_service_labels` and `monitor_undecided_services`.
916+
Refer to the module documentation for further details.
917+
- Rule module - The complete module was rewritten to use the new module API.
918+
Additionally, a parameter "rule_id" was introduced to modify existing rules.
919+
Refer to the module documentation for further details.
920+
minor_changes:
921+
- Agent role - Add support to open firewall for a list of IPs.
922+
- Agent role - Replace `ansible.builtin.yum` with the succeeding `ansible.builtin.dnf`.
923+
- Server role - Replace `ansible.builtin.yum` with the succeeding `ansible.builtin.dnf`.
924+
- Several modules - Remove unnecessary HTTP codes which get already imported
925+
via utils.py.
926+
- Testing - Add Ansible 2.17 to all tests. Be advised, that this Ansible release
927+
drops support for Python 2.7 and 3.6.
928+
- Testing - Add Ubuntu 24.04 to the Molecule tests.
929+
- Testing - All tests now cover Checkmk 2.3.0.
930+
- Testing - Remove Ansible 2.14 from all tests, as it is EOL.
931+
- Testing - Remove Checkmk 2.0.0 from all tests, as it is EOL.
932+
- Testing - The Molecule tests now run on Ubuntu 22.04.
933+
release_summary: (Re)writing history with overhauled modules and updated Checkmk,
934+
Ansible, Distribution and Python support.
935+
fragments:
936+
- agent.yml
937+
- build.yml
938+
- discovery.yml
939+
- http.yml
940+
- lookup_folder.yml
941+
- release_summary.yml
942+
- roles.yml
943+
- rule.yml
944+
release_date: '2024-06-07'

changelogs/fragments/lookup_folder.yml

-3
This file was deleted.

docs/activation_module.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:trim:
88

99
.. meta::
10-
:antsibull-docs: 2.10.0
10+
:antsibull-docs: 2.11.0
1111

1212
.. Anchors
1313
@@ -23,7 +23,7 @@ checkmk.general.activation module -- Activate changes in Checkmk.
2323
.. Collection note
2424
2525
.. note::
26-
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.1).
26+
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.0.0).
2727

2828
It is not included in ``ansible-core``.
2929
To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -400,35 +400,35 @@ Examples
400400

401401
- name: "Start activation on all sites."
402402
checkmk.general.activation:
403-
server_url: "http://my_server/"
404-
site: "my_site"
405-
automation_user: "my_user"
406-
automation_secret: "my_secret"
403+
server_url: "http://myserver/"
404+
site: "mysite"
405+
automation_user: "myuser"
406+
automation_secret: "mysecret"
407407
run_once: 'true'
408408

409409
- name: "Start activation on a specific site."
410410
checkmk.general.activation:
411-
server_url: "http://my_server/"
412-
site: "my_site"
413-
automation_user: "my_user"
414-
automation_secret: "my_secret"
411+
server_url: "http://myserver/"
412+
site: "mysite"
413+
automation_user: "myuser"
414+
automation_secret: "mysecret"
415415
sites:
416-
- "my_site"
416+
- "mysite"
417417
run_once: 'true'
418418

419419
- name: "Start activation including foreign changes."
420420
checkmk.general.activation:
421-
server_url: "http://my_server/"
422-
site: "my_site"
423-
automation_user: "my_user"
424-
automation_secret: "my_secret"
421+
server_url: "http://myserver/"
422+
site: "mysite"
423+
automation_user: "myuser"
424+
automation_secret: "mysecret"
425425
force_foreign_changes: 'true'
426426
run_once: 'true'
427427

428428
- name: "Activate changes including foreign changes and wait for completion."
429429
checkmk.general.activation:
430430
server_url: "http://localhost/"
431-
site: "my_site"
431+
site: "mysite"
432432
automation_user: "automation"
433433
automation_secret: "$SECRET"
434434
redirect: 'true'

docs/bakery_lookup.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:trim:
88

99
.. meta::
10-
:antsibull-docs: 2.10.0
10+
:antsibull-docs: 2.11.0
1111

1212
.. Anchors
1313
@@ -23,7 +23,7 @@ checkmk.general.bakery lookup -- Get the bakery status of a Checkmk server
2323
.. Collection note
2424
2525
.. note::
26-
This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.1).
26+
This lookup plugin is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.0.0).
2727

2828
It is not included in ``ansible-core``.
2929
To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -391,8 +391,8 @@ Examples
391391
msg: "Bakery status is {{ bakery }}"
392392
vars:
393393
bakery: "{{ lookup('checkmk.general.bakery',
394-
server_url=http://my_server,
395-
site=my_site,
394+
server_url=http://myserver,
395+
site=mysite,
396396
validate_certs=False,
397397
automation_user=automation_user,
398398
automation_secret=automation_secret
@@ -402,10 +402,10 @@ Examples
402402
ansible.builtin.debug:
403403
msg: "Bakery status is {{ bakery }}"
404404
vars:
405-
ansible_lookup_checkmk_server_url: "http://my_server/"
406-
ansible_lookup_checkmk_site: "my_site"
407-
ansible_lookup_checkmk_automation_user: "my_user"
408-
ansible_lookup_checkmk_automation_secret: "my_secret"
405+
ansible_lookup_checkmk_server_url: "http://myserver/"
406+
ansible_lookup_checkmk_site: "mysite"
407+
ansible_lookup_checkmk_automation_user: "myuser"
408+
ansible_lookup_checkmk_automation_secret: "mysecret"
409409
ansible_lookup_checkmk_validate_certs: false
410410
bakery: "{{ lookup('checkmk.general.bakery') }}"
411411

docs/bakery_module.rst

+14-14
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:trim:
88

99
.. meta::
10-
:antsibull-docs: 2.10.0
10+
:antsibull-docs: 2.11.0
1111

1212
.. Anchors
1313
@@ -23,7 +23,7 @@ checkmk.general.bakery module -- Trigger baking and signing in the agent bakery.
2323
.. Collection note
2424
2525
.. note::
26-
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 4.4.1).
26+
This module is part of the `checkmk.general collection <https://galaxy.ansible.com/ui/repo/published/checkmk/general/>`_ (version 5.0.0).
2727

2828
It is not included in ``ansible-core``.
2929
To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -389,28 +389,28 @@ Examples
389389
# Bake all agents without signing, as example in a fresh installation without a signature key.
390390
- name: "Bake all agents without signing."
391391
checkmk.general.bakery:
392-
server_url: "http://my_server/"
393-
site: "my_site"
394-
automation_user: "my_user"
395-
automation_secret: "my_secret"
392+
server_url: "http://myserver/"
393+
site: "mysite"
394+
automation_user: "myuser"
395+
automation_secret: "mysecret"
396396
state: "baked"
397397
# Sign all agents.
398398
- name: "Sign all agents."
399399
checkmk.general.bakery:
400-
server_url: "http://my_server/"
401-
site: "my_site"
402-
automation_user: "my_user"
403-
automation_secret: "my_secret"
400+
server_url: "http://myserver/"
401+
site: "mysite"
402+
automation_user: "myuser"
403+
automation_secret: "mysecret"
404404
signature_key_id: 1
405405
signature_key_passphrase: "my_key"
406406
state: "signed"
407407
# Bake and sign all agents.
408408
- name: "Bake and sign all agents."
409409
checkmk.general.bakery:
410-
server_url: "http://my_server/"
411-
site: "my_site"
412-
automation_user: "my_user"
413-
automation_secret: "my_secret"
410+
server_url: "http://myserver/"
411+
site: "mysite"
412+
automation_user: "myuser"
413+
automation_secret: "mysecret"
414414
signature_key_id: 1
415415
signature_key_passphrase: "my_key"
416416
state: "baked_signed"

0 commit comments

Comments
 (0)