README.md

Checkmk Ansible Collection

Checkmk already provides the needed APIs to automate and configure your monitoring. With this project we want to augment the experience and provide easy to use modules and roles for Ansible to both simplify your first steps with automating Checkmk and keep your daily operations smooth and efficient.

Here be dragons!

This collection is provided AS IS and we cannot guarantee proper functionality.

Additionally, there is no commercial support whatsoever!

This is an open source endeavour, on which we want to collaborate with the community.

Dependencies

• ansible.posix
• ansible.utils
• community.general

Although the Ansible project notes, that collections should have no or very little dependencies, we want to make sure the collection works for you out-of-the-box. Currently we only depend on very basic collections, which are most likely already installed in your environment. For version constraints, see galaxy.yml.

Getting help

For documentation on the included modules, head over to the Galaxy, or run the following command substituting the $MODULE_NAME:

ansible-doc checkmk.general.$MODULE_NAME

For any form of support queries or requests refer to SUPPORT.md.

Included content

You can find playbooks, demonstrating the content of this collection in the folder playbooks/demo/.

Inventory plugins

Name	Description	Tests
checkmk.general.checkmk	Dynamic Inventory Source for Checkmk

Lookup plugins

Click on the lookup plugin name below, to get detailed documentation about it. For more in-depth documentation, see this README.

Name	Description	Tests
checkmk.general.bakery	Look up the status pf the Checkmk agent bakery.
checkmk.general.folder	Look up folder attributes.
checkmk.general.folders	Look up all folders.
checkmk.general.host	Look up host attributes.
checkmk.general.hosts	Look up all hosts.
checkmk.general.rule	Look up rule attributes.
checkmk.general.rules	Look up all rules.
checkmk.general.ruleset	Look up ruleset attributes.
checkmk.general.rulesets	Look up all rulesets.
checkmk.general.site	Look up site attributes.
checkmk.general.sites	Look up all sites.
checkmk.general.version	Look up version and edition information.

Modules

Click on the module name below, to get detailed documentation about it.

Name	Description	Tests
checkmk.general.activation	Activate changes.
checkmk.general.bakery	Bake and sign agents.
checkmk.general.contact_group	Manage contact groups.
checkmk.general.discovery	Discover services on hosts.
checkmk.general.downtime	Manage downtimes.
checkmk.general.folder	Manage folders.
checkmk.general.host_group	Manage host groups.
checkmk.general.host	Manage hosts.
checkmk.general.rule	Manage rules.
checkmk.general.service_group	Manage service groups.
checkmk.general.site	Manage sites.
checkmk.general.tag_group	Manage tag groups.
checkmk.general.user	Manage users.

Roles

Click on the role name below, to get documentation about the role.

Name	Description	Tests
checkmk.general.agent	Installs Checkmk agents.
checkmk.general.server	Installs Checkmk servers and manages Checkmk sites.

Additional content

We love to see the community build things on top of this collection. Check out COMMUNITY.md for a listing of interesting projects that build upon this collection in some way.

Installing this collection

Please refer to the official Ansible documentation on how to install this collection. The most basic way is this:

ansible-galaxy collection install checkmk.general

Using this collection

We encourage you - in accordance with Ansible Best Practices - to always use FQCNs (Fully Qualified Collection Names) as seen below. This ensures, that you always know, which module is at play.

---
- hosts: all

  tasks:
    - name: "Run activation."
      checkmk.general.activation:
        server_url: "http://myserver/"
        site: "mysite"
        automation_user: "myuser"
        automation_secret: "mysecret"
        force_foreign_changes: 'true'
        sites:
          - "mysite"

Getting Involved

See CONTRIBUTING.

Release notes

See CHANGELOG.rst.

Versioning

This collection uses Semantic Versioning for releases. From the official homepage:

Given a version number MAJOR.MINOR.PATCH, increment the:

  MAJOR version when you make incompatible API changes
  MINOR version when you add functionality in a backward compatible manner
  PATCH version when you make backward compatible bug fixes

Roadmap

This is merely a collection of possible additions to the collection. Please do not consider it a concrete planning document!

• Modules
  • Monitoring
    • Acknowledgement
    • Business Intelligence
    • Event Console
  • Setup
    • Agents
    • Business Intelligence
    • Dynamic host management (DCD)
    • Event Console
    • Notification Rules
• OMD Module

More information about Ansible

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

More information about Checkmk

• Checkmk Website
• Checkmk Documentation
• Checkmk Community

Licensing

See LICENSE.