validations-common/doc/source/roles/role-check_ram.rst
Gael Chamoulaud (Strider) 4e87d74227
[check_ram] Remove README.md file
This patch removes the README.md file and 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.

Change-Id: I36c9a86eabb9a297f75c9a4ca2bde8aaa0a1fcd3
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
2021-06-29 10:55:10 +02:00

49 lines
631 B
ReStructuredText

=========
check_ram
=========
--------------
About The Role
--------------
An Ansible role to check if the Host(s) fit(s) the RAM requirements.
Requirements
============
No requirements.
Dependencies
============
No dependencies.
Example Playbook
================
.. code-block:: yaml
- hosts: localhost
gather_facts: false
vars:
minimal_ram_gb: 42
roles:
- check_ram
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:DF Squad:VF**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: validations_common/roles/check_ram