Skip to content

Latest commit

 

History

History
138 lines (93 loc) · 4.79 KB

README.md

File metadata and controls

138 lines (93 loc) · 4.79 KB
Raw

checkmate - declaratively configure Checkmk

Checkmate is an application that enables declarative configuration of Checkmk. With Checkmate, you can provide a YAML file that describes the folders, hosts, and rulesets, and then invoke Checkmate on that configuration, which will take care of pushing the necessary changes to the Checkmk site and activating them.

Installation

Checkmate is a Rust application, and can be installed using cargo. Checkmate is not yet available on crates.io, so you'll have to clone the repository and install it from there:

git clone https://github.com/takkt-ag/checkmate.git
cd checkmate
cargo install --path checkmate

Usage

checkmate:

Configure checkmk declaratively using checkmate by providing a configuration file

Usage: checkmate <COMMAND>

Commands:
  lint   Link the configuration file to the checkmk site
  apply  Apply the configuration to the checkmk site
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

checkmate lint:

Validate the configuration file

Usage: checkmate lint [OPTIONS]

Options:
      --config-file <CONFIG_FILE>  The configuration file to use [env: CHECKMATE_CONFIG_FILE=] [default: checkmate.yaml]
      --print-config               Print the internal repesentation of the configuration file after loading it
  -h, --help                       Print help

checkmate apply:

Apply the configuration to the checkmk site

Usage: checkmate apply [OPTIONS] --server-url <SERVER_URL> --site <SITE> --secret <SECRET>

Options:
      --server-url <SERVER_URL>
          URL to the checkmk server.

          If checkmk is not running at the root-path, please include the required prefix here.

          [env: CHECKMATE_CHECKMK_SERVER_URL=]

      --site <SITE>
          The checkmk site to configure

          [env: CHECKMATE_CHECKMK_SITE=]

      --username <USERNAME>
          The username to use for authentication

          [env: CHECKMATE_CHECKMK_USERNAME=]
          [default: automation]

      --secret <SECRET>
          The secret to use for authentication.

          You should preferably provide this through the environment variable `CHECKMATE_CHECKMK_SECRET`.

          [env: CHECKMATE_CHECKMK_SECRET=]

      --config-file <CONFIG_FILE>
          The configuration file to use

          [env: CHECKMATE_CONFIG_FILE=]
          [default: checkmate.yaml]

  -h, --help
          Print help (see a summary with '-h')

Missing features

  • Automatic removal of resources
    Issue #19
    • Hosts: hosts removed from configuration (i.e. orphaned hosts) are not automatically removed.
      • Workaround: manually remove the host through the Checkmk UI.
    • Folders: folders removed from configuration (i.e. orphaned folders) are not automatically removed.
      • Workaround: manually remove the folder through the Checkmk UI.
    • Rulesets: removal of an entire ruleset will not remove the rules from Checkmk.
      • Workaround: do not remove the entire ruleset from the YAML-file, but define an explicit empty list.

License

Checkmate is licensed under the Apache License, Version 2.0, (see LICENSE or https://www.apache.org/licenses/LICENSE-2.0).

Checkmate internally makes use of various open-source projects. You can find a full list of these projects and their licenses in THIRD_PARTY_LICENSES.md.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Checkmate by you, as defined in the Apache-2.0 license, shall be licensed under the Apache License, Version 2.0, without any additional terms or conditions.

We require code submitted to be formatted with Rust's default rustfmt formatter (CI will automatically verified if your code is formatted correctly). We are using unstable rustfmt formatting rules, which requires running the formatter with a nightly toolchain, which you can do as follows:

$ rustup toolchain install nightly
$ cargo +nightly fmt

(Building and running Checkmate itself can and should happen with the stable toolchain.)

Additionally we are also checking whether there are any clippy warnings in your code. You can run clippy locally with:

$ cargo clippy --workspace --lib --bins --tests --all-targets -- -Dwarnings

There can be occasions where newer versions of clippy warn about code you haven't touched. In such cases we'll try to get those warnings resolved before merging your changes, or work together with you to get them resolved in your merge request.

Affiliation

This project has no official affiliation with Checkmk GmbH, Checkmk.com, or any of their affiliates. "Checkmk", formerly "Check_MK", and the Checkmk logo are trademarks of Checkmk GmbH.