From 42fc17e563ae451b4496dc4da58682739ae801ef Mon Sep 17 00:00:00 2001 From: "Gael Chamoulaud (Strider)" Date: Fri, 25 Jun 2021 10:53:50 +0200 Subject: [PATCH] [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) --- .../role-advanced_format_512e_support.rst | 40 +++++++++++++++++++ validations_common/playbooks/512e.yaml | 1 + 2 files changed, 41 insertions(+) diff --git a/doc/source/roles/role-advanced_format_512e_support.rst b/doc/source/roles/role-advanced_format_512e_support.rst index 6c3ed66..bb89b60 100644 --- a/doc/source/roles/role-advanced_format_512e_support.rst +++ b/doc/source/roles/role-advanced_format_512e_support.rst @@ -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 diff --git a/validations_common/playbooks/512e.yaml b/validations_common/playbooks/512e.yaml index 548400b..e48e5b7 100644 --- a/validations_common/playbooks/512e.yaml +++ b/validations_common/playbooks/512e.yaml @@ -1,5 +1,6 @@ --- - hosts: localhost + gather_facts: false vars: metadata: name: Advanced Format 512e Support