Release 4.1.0

.github/labels-issues.yml

@@ -68,5 +68,17 @@ lookup:host:
 lookup:hosts:
   - 'Component Name: lookup_hosts'
 
+lookup:rule:
+  - 'Component Name: lookup_rule'
+
+lookup:rules:
+  - 'Component Name: lookup_rules'
+
+lookup:ruleset:
+  - 'Component Name: lookup_ruleset'
+
+lookup:rulesets:
+  - 'Component Name: lookup_rulesets'
+
 lookup:bakery:
   - 'Component Name: lookup_bakery'

.github/labels-prs.yml

@@ -109,6 +109,26 @@ lookup:hosts:
       - changed-files:
           - any-glob-to-any-file: 'plugins/modules/lookup/hosts.py'
 
+lookup:rule:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: 'plugins/modules/lookup/rule.py'
+
+lookup:rules:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: 'plugins/modules/lookup/rules.py'
+
+lookup:ruleset:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: 'plugins/modules/lookup/ruleset.py'
+
+lookup:rulesets:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: 'plugins/modules/lookup/rulesets.py'
+
 lookup:bakery:
   - any:
       - changed-files:

.github/workflows/ans-int-test-lkp-rules.yaml

@@ -0,0 +1,72 @@
+# README:
+# - When changing the module name, it needs to be changed in 'env:MODULE_NAME' and in 'on:pull_requests:path'!
+#
+# Resources:
+# - Template for this file: https://github.com/ansible-collections/collection_template/blob/main/.github/workflows/ansible-test.yml
+# - About Ansible integration tests: https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html
+
+env:
+  NAMESPACE: checkmk
+  COLLECTION_NAME: general
+  MODULE_NAME: lookup_rules
+
+name: Ansible Integration Tests for Rule Lookup Modules
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+      - devel
+    paths:
+      - 'plugins/lookup/rule.py'
+      - 'plugins/lookup/rules.py'
+
+jobs:
+
+  integration:
+    runs-on: ubuntu-latest
+    name: Ⓐ${{ matrix.ansible }}+py${{ matrix.python }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ansible:
+          - stable-2.14
+          - stable-2.15
+          - stable-2.16
+          - devel
+        python:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
+        exclude:
+          # Exclude unsupported sets.
+          - ansible: stable-2.14
+            python: '3.12'
+          - ansible: stable-2.15
+            python: '3.12'
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install ansible-base (${{ matrix.ansible }})
+        run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+
+      - name: Provide secrets file
+        run: echo "${{ secrets.CHECKMK_DOWNLOAD_PW }}" > ./tests/integration/files/.dl-secret
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+        env:
+          CHECKMK_DOWNLOAD_PW: ${{ secrets.CHECKMK_DOWNLOAD_PW }}
+
+      - name: Run integration test
+        run: ansible-test integration ${{env.MODULE_NAME}} -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --docker
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}

.github/workflows/ans-int-test-lkp-rulesets.yaml

@@ -0,0 +1,72 @@
+# README:
+# - When changing the module name, it needs to be changed in 'env:MODULE_NAME' and in 'on:pull_requests:path'!
+#
+# Resources:
+# - Template for this file: https://github.com/ansible-collections/collection_template/blob/main/.github/workflows/ansible-test.yml
+# - About Ansible integration tests: https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html
+
+env:
+  NAMESPACE: checkmk
+  COLLECTION_NAME: general
+  MODULE_NAME: lookup_rulesets
+
+name: Ansible Integration Tests for Ruleset Lookup Modules
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+      - devel
+    paths:
+      - 'plugins/lookup/ruleset.py'
+      - 'plugins/lookup/rulesets.py'
+
+jobs:
+
+  integration:
+    runs-on: ubuntu-latest
+    name: Ⓐ${{ matrix.ansible }}+py${{ matrix.python }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ansible:
+          - stable-2.14
+          - stable-2.15
+          - stable-2.16
+          - devel
+        python:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
+        exclude:
+          # Exclude unsupported sets.
+          - ansible: stable-2.14
+            python: '3.12'
+          - ansible: stable-2.15
+            python: '3.12'
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install ansible-base (${{ matrix.ansible }})
+        run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+
+      - name: Provide secrets file
+        run: echo "${{ secrets.CHECKMK_DOWNLOAD_PW }}" > ./tests/integration/files/.dl-secret
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+        env:
+          CHECKMK_DOWNLOAD_PW: ${{ secrets.CHECKMK_DOWNLOAD_PW }}
+
+      - name: Run integration test
+        run: ansible-test integration ${{env.MODULE_NAME}} -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --docker
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}

.gitignore

@@ -9,3 +9,5 @@ build/
 tests/output
 playbooks/vars/config.yml
 playbooks/test*.yml
+Vagrantfile
+Vagrantfile.bak

Makefile

@@ -0,0 +1,93 @@
+SHELL=/bin/bash
+
+VERSION := $$(grep 'version:' galaxy.yml | cut -d ' ' -f 2)
+
+help:
+	@echo "setup           - Run all setup target at once."
+	@echo ""
+	@echo "setup-python    - Prepare the system for development with Python."
+	@echo ""
+	@echo "setup-kvm       - Install and enable KVM and prepare Vagrant."
+	@echo ""
+	@echo "kvm             - Only copy the correct Vagrantfile for use with KVM."
+	@echo ""
+	@echo "setup-vbox      - Copy the correct Vagrantfile for use with VirtualBox."
+	@echo ""
+	@echo "vbox            - Copy the correct Vagrantfile for use with VirtualBox."
+	@echo ""
+	@echo "vm              - Create a virtual development environment."
+	@echo "molecule        - Create a virtual environment for molecule tests."
+	@echo ""
+	@echo "clean           - Clean up several things"
+	@echo "clean-vm        - Clean up virtual development environment."
+	@echo ""
+	@echo "version         - Update collection version"
+	@echo ""
+	@echo "Publishing:"
+	@echo ""
+	@echo "  release       - Build, upload, publish, announce and tag a release"
+	@echo "  announce      - Announce the release"
+	@echo "  publish       - Make files available, update git and announce"
+	@echo ""
+
+release:
+
+publish:
+
+announce:
+
+setup: setup-python setup-kvm
+
+setup-python:
+	@sudo apt-get -y update --quiet
+	@sudo apt-get -y install -y \
+		python3-pip \
+		ca-certificates \
+		curl \
+		gnupg \
+		lsb-release
+	@python3 -m pip install pip --upgrade
+	@python3 -m pip install -r requirements.txt
+
+kvm:
+	if [ -f Vagrantfile ] ; then cp Vagrantfile Vagrantfile.bak ; fi
+	cp Vagrantfile.kvm Vagrantfile
+
+setup-kvm: kvm
+	@sudo apt update -y
+	@sudo apt install -y \
+		virt-manager \
+		qemu-kvm \
+		libvirt-clients \
+		libvirt-daemon-system \
+		bridge-utils \
+		virtinst \
+		libguestfs-tools \
+		libvirt-daemon\
+		libvirt-dev \
+		libxslt-dev \
+		libxml2-dev \
+		zlib1g-dev
+	@sudo systemctl enable --now libvirtd
+	@vagrant plugin install vagrant-libvirt
+
+vbox:
+	if [ -f Vagrantfile ] ; then cp Vagrantfile Vagrantfile.bak ; fi
+	cp Vagrantfile.vbox Vagrantfile
+
+setup-vbox: vbox
+
+version:
+	@newversion=$$(dialog --stdout --inputbox "New Version:" 0 0 "$(VERSION)") ; \
+	if [ -n "$$newversion" ] ; then ./scripts/release.sh -s "$(VERSION)" -t $$newversion ; fi
+
+clean: clean-vm
+
+clean-vm:
+	@vagrant destroy --force
+
+molecule:
+	@vagrant up molecule
+
+vm:
+	@vagrant up collection

README.md

@@ -50,6 +50,10 @@ Name | Description | Tests
 [checkmk.general.folders](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/folders.py)|Look up all folders.|[![Integration Tests for Folders Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-folders.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-folders.yaml)
 [checkmk.general.host](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/host.py)|Look up host attributes.|[![Integration Tests for Host Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-host.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-host.yaml)
 [checkmk.general.hosts](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/hosts.py)|Look up all hosts.|[![Integration Tests for Hosts Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-hosts.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-hosts.yaml)
+[checkmk.general.rule](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/rule.py)|Look up rule attributes.|[![Integration Tests for Rule Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rules.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rules.yaml)
+[checkmk.general.rules](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/rules.py)|Look up all rules.|[![Integration Tests for Rules Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rules.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rules.yaml)
+[checkmk.general.ruleset](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/ruleset.py)|Look up ruleset attributes.|[![Integration Tests for Ruleset Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rulesets.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rulesets.yaml)
+[checkmk.general.rulesets](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/rulesets.py)|Look up all rulesets.|[![Integration Tests for Rulesets Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rulesets.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-rulesets.yaml)
 [checkmk.general.version](https://github.com/Checkmk/ansible-collection-checkmk.general/blob/main/plugins/lookup/version.py)|Look up version and edition information.|[![Integration Tests for Version Lookup Module](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-version.yaml/badge.svg)](https://github.com/Checkmk/ansible-collection-checkmk.general/actions/workflows/ans-int-test-lkp-version.yaml)
 
 ### Modules
@@ -79,7 +83,7 @@ Name | Description | Tests
 
 ## Additional content
 
-We love to see the community build things on top of this collection.  
+We love to see the community build things on top of this collection.
 Check out [COMMUNITY.md](COMMUNITY.md) for a listing of interesting projects that build upon this collection in some way.
 
 ## Installing this collection
@@ -128,8 +132,8 @@ See [CHANGELOG.rst](CHANGELOG.rst).
 
 ## Roadmap
 <!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. -->
-This is merely a collection of possible additions to the role.
-Please do **not** consider a concrete planning document!
+This is merely a collection of possible additions to the collection.
+Please do **not** consider it a concrete planning document!
 
 - Modules
   - Monitoring
@@ -140,6 +144,7 @@ Please do **not** consider a concrete planning document!
     - Distributed Monitoring
     - Notification Rules
 - Dynamic Inventory
+- OMD Module
 
 ## More information about Ansible
 

SUPPORT.md

@@ -47,3 +47,4 @@ Collection Version | Checkmk Versions | Ansible Versions | Remarks
 3.4.0 | 2.0.0p39, 2.1.0p36, 2.2.0p14 | 2.13, 2.14, 2.15 | None
 4.0.0 | 2.0.0p39, 2.1.0p36, 2.2.0p16 | 2.14, 2.15, 2.16 | Breaking changes to the following roles: `agent`, `server`.
 4.0.1 | 2.0.0p39, 2.1.0p36, 2.2.0p16 | 2.14, 2.15, 2.16 | None
+4.1.0 | 2.0.0p39, 2.1.0p37, 2.2.0p17 | 2.14, 2.15, 2.16 | None