kso512.checkmk_server
CheckMK Server
This is an Ansible Role for installing the CheckMK RAW edition and setting up an initial site.
Important Notes
- This role is a fresh version of the old install-check_mk-server role. Changes were made due to updates in CI/CD and naming standards in Ansible Galaxy and CheckMK.
- All tasks are marked with
checkmk-server
. - Caution: The default configuration is not safe for direct internet connections since it uses unencrypted HTTP.
Supported Distributions
The following operating systems have been tested:
- Debian 10 "Buster"
- Debian 11 "Bullseye"
- Debian 12 "Bookworm"
- Ubuntu 20.04 LTS "Focal Fossa"
- Ubuntu 22.04 LTS "Jammy Jellyfish"
- Ubuntu 24.04 LTS "Noble Numbat"
"OMD" refers to the Open Monitoring Distribution, which was the predecessor to CheckMK RAW edition.
Version Compatibility
CheckMK Version | Role Version |
---|---|
2.3.0p13 | 1.0.88 |
2.3.0p12 | 1.0.87 |
2.3.0p11 | 1.0.86 |
2.3.0p10 | 1.0.85 |
2.2.0p9 | 1.0.84 |
Requirements
If your server has a firewall, you may need to allow traffic on:
- TCP port 80 (web access)
- TCP port 514 (event console)
- UDP ports 162 & 514 (event console)
You might also need to address SELinux settings.
It's recommended to use an additional Ansible Role for these requirements.
Updates
This role installs the latest stable version but doesn’t upgrade existing installations to prevent issues. To upgrade a site named "test," follow these steps:
- Switch to the "test" user:
sudo omd su test
- Stop the site:
omd stop
- Update the site:
omd update
- Start the site:
omd start
For multiple upgrades, you can use this one-liner (adjust the site name as needed):
site=test ; sudo omd stop $site ; sudo omd update $site ; sudo omd start $site
You can also automate upgrades using Ansible.
Role Variables
These variables can be changed if needed:
Variable | Description | Default |
---|---|---|
checkmk_server_adminpw | Password for cmkadmin user |
undefined |
checkmk_server_base_url | Base URL for downloads | https://download.checkmk.com/checkmk |
checkmk_server_site | Name of the OMD site to create | test |
checkmk_server_version | Version of CheckMK to install | 2.3.0p13 |
Example Playbook
To set a specific password for the cmkadmin
user:
- hosts: monitoring-servers
roles:
- { role: kso512.checkmk_server, checkmk_server_adminpw: "wintermute" }
License
This project is licensed under the GNU General Public License version 2.
Contributing
Feel free to submit issues, suggestions, or pull requests.
Author Information
Created by kso512 with contributions from other GitHub users.
A role to install CheckMK RAW edition and set up an initial site.
ansible-galaxy install kso512.checkmk_server