[advanced_format_512e_support] 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 this validation doesn't
need them.

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

View File

@ -2,5 +2,45 @@
advanced_format_512e_support
============================
--------------
About The Role
--------------
An Ansible role to detect whether the node disks use Advanced Format.
Requirements
============
No requirements.
Dependencies
============
No dependencies.
Example Playbook
================
.. code-block:: yaml
- hosts: localhost
gather_facts: false
roles:
- advanced_format_512e_support
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:DF Squad:VF**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: validations_common/roles/advanced_format_512e_support

View File

@ -1,5 +1,6 @@
---
- hosts: localhost
gather_facts: false
vars:
metadata:
name: Advanced Format 512e Support