quasarfreak/puppet-checkmk

A module for managing checkmk server and agents

checkmk

Description

Provisions the CheckMK server and client.

Usage

To set up a CheckMK server:

class { '::checkmk':
  mode                     => 'server',
  version                  => '2.1.0p14',
  sha256_hash              => '8804c0291e897f6185b147613a5fc86d61c0bcf73eaac5b11d90afe58af10c9f', # SHA256 hash of requested version, this can be found at: https://checkmk.com/download
  cmkadmin_user_password   => 'changeme123', # Password for the `cmkadmin` user
  automation_user_password => 'changeme456', # Password for the `automation` user
}

This will provision a CheckMK server with default configuration. This can be accessed from: http://<server-ip>/default. To login, use the cmkadmin credentials.

To set up a CheckMK agent:

class { '::checkmk':
  mode                    => 'agent',
  agent_download_protocol => 'http', # The protocol that should be used when talking to the CheckMK server
  agent_download_host     => 'checkmk.example.com', # The hostname or IP address of the CheckMK server
}

All configurations can be set using Hiera.

---
checkmk::mode: 'server'
checkmk::download_url: 'https://download.checkmk.com/checkmk/2.1.0p14/check-mk-raw-2.1.0p14_0.jammy_amd64.deb'
checkmk::sha256_hash: '8804c0291e897f6185b147613a5fc86d61c0bcf73eaac5b11d90afe58af10c9f'
checkmk::cmkadmin_user_password: 'changeme123'
checkmk::automation_user_password: 'changeme456'

Limitations

Currently only tested and supported Debian based systems. Only the Raw version of CheckMK has been tested but this module may work with the paid server versions.

Development

To contribute to this module, please fork the repository and submit a pull request. All commits should be squashed into a single commit and the commit message should follow the Conventional Commits specification.

Testing

Run the following commands to test the module in your local environment:

bundle install
bundle exec rake spec
bundle exex rake beaker