cmk-dev-site
Easy Install Checkmk
Scripts to install bleeding edge Checkmk in development context.
If you are a regular Checkmk customer you probably don't want to use this, as this tools remove sites without warning.
Installation
sudo apt install pipx
pipx ensurepath
# check output of this command. you might have to open a fresh terminal!
pipx install cmk-dev-site
For updating you can use:
pipx upgrade cmk-dev-site
Usage
cmk-dev-install-site 2.5 # download package, install, create site for 2.5
# Download and install latest available daily build of 2.5.0
cmk-dev-install 2.5 && cmk-dev-site
# (will fall back to the daily builds of yesterday)
# Download daily build of today and
# setup distributed monitoring with one two sites:
cmk-dev-install 2.5.0-daily && cmk-dev-site -d 1
# Download and install raw edition package
cmk-dev-install --edition=cre 2.5.0-daily
# Install a local .deb file instead of downloading
cmk-dev-install -p ./check-mk-enterprise-2.4.0p9_0.noble_amd64.deb
cmk-dev-install-site
Is a shortcut for the more verbose cmk-dev-install and cmk-dev-site
commands. This way you lose some of the possibilities, but only have to
remember one command. Also prints out the commands that it will execute, so you
can c&p it.
This shortcut does not forward --omd-configs, so opting out of the MCP
server or of the usage-data forwarding (see cmk-dev-site below) requires
calling cmk-dev-site directly.
cmk-dev-install
Will download the requested package of Checkmk and install said package.
You might request a daily build (cmk-dev-install 2.5.0-daily),
the latest available daily build (handy if there are no daily builds of today) (cmk-dev-install 2.5),
or an officially release Checkmk version (cmk-dev-install 2.4.0p9).
Please check the built in help (cmk-dev-install --help) for all options!
cmk-dev-site
Will create a site, install the checkmk agent, and add a single host to the site.
cmk-dev-site uses omd
commands and the official
REST-API to create one or
multiple sites based on the current default omd version (or the version
specified on the command line).
You might use -d 1 to create a distributed monitoring with one distributed site.
Where the installed version ships the hooks (currently Checkmk 3.0.0+, every
edition except community), the site is created with the MCP server enabled at
http://localhost/<site>/check_mk/mcp, and with MCP_TRACE_FORWARD=on, which
forwards MCP usage data to Checkmk. Opt out with --omd-configs MCP_SERVER=off
or --omd-configs MCP_TRACE_FORWARD=off.
Please check the built in help (cmk-dev-site --help) for all options!
Cleanup
Currently there is no public available tool to completely cleanup sites and
packages create with the presented tools. If you are a Checkmk developer you
might make use of the internal tool omd-hauweg, otherwise you have to
manually remove the sites using omd rm.
For uninstall packages that are no longer in use you can use omd cleanup,
or you might fall back to use apt purge.
Contributing
If you'd like to make contributions to the tool, check out our development documentation. Here you'll see steps on how to setup your environment for local development.
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cmk_dev_site-1.19.0.tar.gz.
File metadata
- Download URL: cmk_dev_site-1.19.0.tar.gz
- Upload date:
- Size: 49.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54d32deafce0dc01f4f35355762a2237ed113fa513d080a2966fda36e7d5486c
|
|
| MD5 |
204ff2e584f09cb2efcc679e5c6703e5
|
|
| BLAKE2b-256 |
fd08c017abc743b6446226662d4a761a6a02c27c2a22ef00ddafd3a182f628f3
|
File details
Details for the file cmk_dev_site-1.19.0-py3-none-any.whl.
File metadata
- Download URL: cmk_dev_site-1.19.0-py3-none-any.whl
- Upload date:
- Size: 49.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0950ee56da16043f3b2ae9e337a29690eb5b1b152c2d84188dd15e0e036d75cf
|
|
| MD5 |
49c393dcfefc77c683a5c9c2e83da3e3
|
|
| BLAKE2b-256 |
163b2d6669c3dbecd629eafdb35e2897e0f5f9d0f38db1333c235189e750b948
|
