[service_status] 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 disables the facts gathering because this validation is
only using the package_facts.

Change-Id: I9ebed531fba6966a4122f0c55eac784cbb6954cc
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
Gael Chamoulaud (Strider) 2021-06-24 10:52:19 +02:00
parent 38c4e68150
commit 4a14df80af
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
3 changed files with 42 additions and 0 deletions

View File

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

View File

@ -1,5 +1,6 @@
---
- hosts: all
gather_facts: false
vars:
metadata:
name: Ensure services state

View File

@ -1,2 +1,3 @@
---
# Podman command options
service_status_podman_opt: ''