From b61b033ad488c542a6832720655d4f9ad2a8d4e8 Mon Sep 17 00:00:00 2001 From: "Gael Chamoulaud (Strider)" Date: Thu, 24 Jun 2021 12:07:12 +0200 Subject: [PATCH] [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) --- doc/source/roles/role-xfs_check_ftype.rst | 41 +++++++++++++++++++ validations_common/playbooks/check-ftype.yaml | 1 + 2 files changed, 42 insertions(+) diff --git a/doc/source/roles/role-xfs_check_ftype.rst b/doc/source/roles/role-xfs_check_ftype.rst index 18093d7..f54abb2 100644 --- a/doc/source/roles/role-xfs_check_ftype.rst +++ b/doc/source/roles/role-xfs_check_ftype.rst @@ -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 diff --git a/validations_common/playbooks/check-ftype.yaml b/validations_common/playbooks/check-ftype.yaml index 1543b1d..b5c7554 100644 --- a/validations_common/playbooks/check-ftype.yaml +++ b/validations_common/playbooks/check-ftype.yaml @@ -1,5 +1,6 @@ --- - hosts: localhost + gather_facts: false vars: metadata: name: XFS ftype check