jiuka / checkmk_template

Template for new Checkmk Extensions

Checkmk extension for ...

Description

This is a template to develop Checkmk Extensions

Development

For the best development experience use VSCode with the Remote Containers extension. This maps your workspace into a checkmk docker container giving you access to the python environment and libraries the installed extension has.

Directories

The following directories in this repo are getting mapped into the Checkmk site.

• agents, checkman, checks, doc, inventory, notifications, pnp-templates, web are mapped into local/share/check_mk/
• agent_based is mapped to local/lib/check_mk/base/plugins/agent_based
• nagios_plugins is mapped to local/lib/nagios/plugins

Continuous integration

Local

To build the package hit Crtl+Shift+B to execute the build task in VSCode.

pytest can be executed from the terminal or the test ui.

Github Workflow

The provided Github Workflows run pytest and flake8 in the same checkmk docker conatiner as vscode.