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 or --show-trial-mode-selection,
so opting out of the MCP server, of the usage-data forwarding or of the trial
mode preselection (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.
Every site is created with trial mode preselected, so Checkmk does not ask on
login whether the site is used as a trial or with an existing license. Pass
--show-trial-mode-selection to be asked instead.
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
Metadata
4 maintainers
Release files for cmk-dev-site 1.21.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cmk_dev_site-1.21.1.tar.gz | 51.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cmk_dev_site-1.21.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.0 kB
Release files / cmk_dev_site-1.21.1.tar.gz
| Download URL | cmk_dev_site-1.21.1.tar.gz |
|---|---|
| Size | 51.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3a659a6925ad7c6d7852dc529c98f7c455807421e73341e6a90f3dcf812a554a
|
|
BLAKE2b-256 checksum How to use checksums |
104a108789616439f0a887e59ba3777998f1134dc13ae725766f94cf97881a63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.13
|
Release files / cmk_dev_site-1.21.1-py3-none-any.whl
| Download URL | cmk_dev_site-1.21.1-py3-none-any.whl |
|---|---|
| Size | 50.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e4496170d425c01a0110cc6b6f764082519651b0e868b1ead0ab564073d39f74
|
|
BLAKE2b-256 checksum How to use checksums |
90f59966f088758ea25b7f20753a2c145c31d219354d4da18f4629c33a50d913
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.13
|
Security for cmk-dev-site 1.21.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
