tribe29 Checkmk Collection

Checkmk already provides the needed APIs to automate and configure your monitoring. With this project we want to create and share 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 repository is provided as is and we cannot guarantee stability at this point. Additionally, there is no commercial support whatsoever! This is an open source endeavour, which we want to share and progress with the community.

This repository is a successor to ansible-checkmk in a way, that we take the idea of the initial repository and translate it into todays format. We will try to keep you posted as best as we can. Also, keep an eye on this Checkmk forum post for updates.

Dependencies

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, run the following command substituting the $MODULE_NAME:

ansible-doc tribe29.checkmk.$MODULE_NAME

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

Repository Structure

For information about the structure and organization of this repository have a look at STRUCTURE.md.

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

Included content

Modules

Name	Description	Tests
tribe29.checkmk.activation	Activate changes.
tribe29.checkmk.contact_group	Manage contact groups.
tribe29.checkmk.discovery	Discover services on hosts.
tribe29.checkmk.downtime	Schedule downtimes on hosts and services.
tribe29.checkmk.folder	Manage folders.
tribe29.checkmk.host_group	Manage host groups.
tribe29.checkmk.host	Manage hosts.
tribe29.checkmk.rule	Manage rules.
tribe29.checkmk.service_group	Manage service groups.
tribe29.checkmk.tag_group	Manage tag groups.
tribe29.checkmk.user	Manage tag groups.

Roles

Name	Description	Tests
tribe29.checkmk.agent	Installs Checkmk agents.	Tests currently unavailable.
tribe29.checkmk.server	Installs Checkmk servers.

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 tribe29.checkmk

Using this collection

You can either call modules by their Fully Qualified Collection Namespace (FQCN), such as tribe29.checkmk.activation, or you can call modules by their short name if you list the tribe29.checkmk collection in the playbook's collections keyword:

---
- hosts: all

  collections:
    - tribe29.checkmk

  tasks:
    - name: "Run activation."
      activation:
        server_url: "http://localhost/"
        site: "my_site"
        automation_user: "automation"
        automation_secret: "$SECRET"
        force_foreign_changes: 'true'
        sites:
          - "my_site"

More information about Checkmk

Getting Involved

See CONTRIBUTING.

Release notes

See CHANGELOG.rst.

Roadmap

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

Modules
- Monitoring
  - Acknowledgement
- Setup
  - Agents
  - BI
  - Passwords
  - Time Periods
Lookup Plugins
- Version

More information about Ansible

Licensing

See LICENSE.

macener / ansible-collection-tribe29.checkmk Goto Github PK

ansible-collection-tribe29.checkmk's Introduction