[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>
This commit is contained in:
parent
0607efaade
commit
4e87d74227
@ -2,5 +2,47 @@
|
||||
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
|
||||
|
@ -1,36 +0,0 @@
|
||||
Undercloud-ram
|
||||
==============
|
||||
|
||||
An Ansible role to check if the Undercloud fits the RAM requirements
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
This role could be used before or/and after the Undercloud installation
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
- min_undercloud_ram_gb: <24> -- Minimal amount of RAM in GB
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
No dependencies.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
- hosts: undercloud
|
||||
roles:
|
||||
- { role: undercloud-ram, min_undercloud_ram_gb: 24 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Apache
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
Red Hat TripleO Validations Team
|
@ -1,2 +1,3 @@
|
||||
---
|
||||
# Minimal amount of RAM (in GB)
|
||||
minimal_ram_gb: 24
|
||||
|
Loading…
x
Reference in New Issue
Block a user