diff --git a/CHANGES.rst b/CHANGES.rst index d5021c9..6e69fab 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,3 +1,5 @@ +.. _checkmk_agent__ref_changelog: + Changelog ========= @@ -30,6 +32,8 @@ Added - Automatically enable the ``smart`` Check_MK agent plugin on physical hosts to query Self-Monitoring, Analysis and Reporting data from disks. [ypid_] +- Add :ref:`checkmk_agent__ref_ansible_facts` documentation. [ypid_] + Changed ~~~~~~~ diff --git a/docs/facts.rst b/docs/facts.rst new file mode 100644 index 0000000..2d03fb0 --- /dev/null +++ b/docs/facts.rst @@ -0,0 +1,31 @@ +.. _checkmk_agent__ref_ansible_facts: + +Ansible facts +============= + +.. include:: includes/all.rst + +The role exposes part of it’s state by means of Ansible local facts for other +roles and playbooks to use. +The interface is considered public and changes to it happen in compliance with +`Semantic Versioning`_ of the role and will be mentioned in the :ref:`checkmk_agent__ref_changelog`. +Here you can find documentation and examples for them. + +Specification +------------- + +``checkmk_agent.plugins`` + List of all Check_MK Agent plugin names which are enabled (and configured if + necessary) by the role. Refer to :envvar:`checkmk_agent__plugins` and related + variables for details. + + Availability: Always, after ``debops-contrib.checkmk_agent/env`` has been run. + +Example +------- + +.. code-block:: json + + { + "plugins": ["nginx_status"] + } diff --git a/docs/index.rst b/docs/index.rst index 50093a3..5570671 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,7 @@ Ansible role: debops-contrib.checkmk_agent getting-started defaults defaults-detailed + facts copyright changelog