CWZ - CMK-Werk-Zeug

Tools for Checkmk development. Some solid, some rough, some experimental.

Tools

cmk-components - who owns what in check_mk, straight from Gerrit's code-owners plugin. TUI by default. list, info, owners PATH, me and friends for scripts.

update-gerrit-changes - a table of your local commits against their Gerrit changes: in sync, behind, diverged, not pushed. Read-only.

cmk-infect - hardlink the files you changed into an installed OMD version (or a site's local/ with --mkp), for 2.4, 2.5 and master checkouts. Zero-second deploy, no code generation, rough edges. --check-paths shows where each file would go.

cmk-up (alias cmk-setup) - build a Checkmk setup from a YAML playbook: versions (pinned, or the newest daily since a date), sites with remotes, hosts with faked or real services, users, roles, rules, BI, host relations. Reverts itself unless told otherwise. Playbooks combine: several on the command line, include: in the file, disabled: true to leave a part out, - for stdin. A window per site tails its logs, runs omd/cmk -R and deploys a checkout with cmk-dev-deploy; --verify reads everything back; --demo does it all visibly, the GUI clicked through in a browser; --complain (on by default) notes what Checkmk could offer to make a step easier, safer or faster to automate; the site line links to the login form, filled in; --rm wipes the machine. --init writes a starter, --enroll a playbook from an existing machine or a crash report. cmk-up 01-minimal runs a shipped example.

cmk-check-plugins - run check plugins against recorded SNMP walks and agent outputs. Needs a check_mk Python environment.

ci-build-metrics - fetch finished Jenkins builds, match failures against known issues, export to PostgreSQL. Sheriff tooling, built for one user.

worklog-from-fs (alias forgot-to-track-time-again) - guess your daily activity from file modification times.

gmine - a Textual TUI for your Gerrit changes: list, diff, comment, vote, submit (gated too), trigger CI, rebase, watches with desktop notifications, Jira ticket moves, out-of-office marks on reviewers, asks for the otter workflows (gogootter, arch-watch). gmine --configure sets it up; GMINE_FAKE=1 gmine runs it on sample data.

cmk-devboard (also devboard) is installed too: an experimental Gerrit/Jira dashboard TUI. Undocumented.

Gerrit and Jenkins credentials work the same for all tools: doc/credentials.md.

Install

Use without installation:

uvx --from cmk-werk-zeug <CMD>      # e.g. cmk-up, gmine, cmk-infect

Easy pipx based installation:

pipx install cmk-werk-zeug

Development setup:

git clone ssh://review.lan.tribe29.com:29418/cmk-werk-zeug
cd cmk-werk-zeug && uv sync
uv run <CMD>
uv tool install --editable .
ci/run-change-validation.sh   # what CI runs: lock check, pre-commit, unit and system tests

ci-build-metrics export needs a local PostgreSQL (sudo apt install postgresql). Setup in doc/ci-build-metrics.md.