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

Changelog

Release 0.3.3

Bugfixes

• Remove puppetlabs/stdlib dependency which was causing type validation error in some environments

Release 0.3.2

Bugfixes

• Remove Stdlib::HTTPSUrl validation due to "unresolved type" errors

Release 0.3.1

Bugfixes

• Use Puppets HTTP Client (causing certificate validation issues)

Release 0.3.0

Refactor

• Move to using Puppet Providers instead of Functions.

Bugfixes

• Handle 404 errors and display a warning
• Add validation on site_name as this is being used to create a unix user

Release 0.2.1

Bugfixes

• Fixes and occasional issue where passwords were attempting to be set before the site is created.

Release 0.2.0

Features

• Add ability to set cmkadmin and automation admin account passwords. It is now a requirement for cmkadmin_user_password to be set when mode => 'server' is used.
• Add ability to only require version to be defined, a common URL will be used, but if download_url is given, this will be used instead.

Bugfixes

• Raise Puppet::Error instead of function_fail to correctly alert in the Puppet.

Known Issues

• --trust-cert option is being used during the CheckMK registration process, this isn't an issue where the CheckMK server is using HTTPS as this is skipped (werk #14715). This can be a potential security issue if the CheckMK server is only configured for HTTP connections.

Release 0.1.0

Initial release of the module!