[xfs_check_ftype] 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 as the validation doesn't
need them.

Change-Id: I90b48b8f1de6ef72f6c0695129ec990137a50219
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
Gael Chamoulaud (Strider) 2021-06-24 12:07:12 +02:00
parent f5d2363215
commit b61b033ad4
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
2 changed files with 42 additions and 0 deletions

View File

@ -2,5 +2,46 @@
xfs_check_ftype
===============
--------------
About The Role
--------------
An Ansible role to check if there is at least 1 XFS volume with ftype=0 in any
deployed server(s).
Requirements
============
No requirements.
Dependencies
============
No dependencies.
Example Playbook
================
.. code-block:: yaml
- hosts: localhost
gather_facts: false
roles:
- xfs_check_ftype
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:DF Squad:VF**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: validations_common/roles/xfs_check_ftype

View File

@ -1,5 +1,6 @@
---
- hosts: localhost
gather_facts: false
vars:
metadata:
name: XFS ftype check