[ntp] Add role documentation in sphinx

This patch adds the documentation directly in the sphinx role
documentation index. All variables have been commented with a proper
description to be included automatically in the sphinx build.

This patch also disable the facts gathering because this validation
doesn't need them and only uses service_facts in the ntp role.

Change-Id: I3a19eb0a93f6dfaaf7a4361b46b2dc904aeb7ae6
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
Gael Chamoulaud (Strider) 2021-06-24 08:53:17 +02:00
parent e5be8fb969
commit 38c4e68150
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
2 changed files with 41 additions and 0 deletions
doc/source/roles
validations_common/playbooks

@ -2,5 +2,45 @@
ntp
===
--------------
About The Role
--------------
An Ansible role to check if the host(s) have their clock synchronized.
Requirements
============
No requirements.
Dependencies
============
No dependencies.
Example Playbook
================
.. code-block:: yaml
- hosts: localhost
gather_facts: false
roles:
- ntp
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:DF Squad:VF**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: validations_common/roles/ntp

@ -1,5 +1,6 @@
---
- hosts: localhost
gather_facts: false
vars:
metadata:
name: Verify all deployed servers have their clock synchronised