https://github.com/jiuka/checkmk_template

Template for new Checkmk Extensions
https://github.com/jiuka/checkmk_template

checkmk checkmk-extension

Last synced: 2 months ago
JSON representation

Template for new Checkmk Extensions

• Host: GitHub
• URL: https://github.com/jiuka/checkmk_template
• Owner: jiuka
• Created: 2021-01-31T12:03:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-13T17:41:16.000Z (over 1 year ago)
• Last Synced: 2024-06-13T20:38:41.135Z (over 1 year ago)
• Topics: checkmk, checkmk-extension
• Language: Shell
• Homepage:
• Size: 20.5 KB
• Stars: 18
• Watchers: 4
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Checkmk extension for ...

![build](https://github.com/jiuka/checkmk_template/workflows/build/badge.svg)

![flake8](https://github.com/jiuka/checkmk_template/workflows/Lint/badge.svg)

![pytest](https://github.com/jiuka/checkmk_template/workflows/pytest/badge.svg)

## Description

This is a template to develop Checkmk Extensions

## Development

For the best development experience use [VSCode](https://code.visualstudio.com/) with the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.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.