[check_cpu] 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: Icc9581821b5ba9c2bef7c0608d989e7044017ae6 Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
parent
fb29b03c1f
commit
d3fc18bab1
@ -2,5 +2,47 @@
|
|||||||
check_cpu
|
check_cpu
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
--------------
|
||||||
|
About The Role
|
||||||
|
--------------
|
||||||
|
|
||||||
|
An Ansible role to check if the Host(s) fit(s) the CPU core requirements
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
============
|
||||||
|
|
||||||
|
No requirements.
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
============
|
||||||
|
|
||||||
|
No dependencies.
|
||||||
|
|
||||||
|
Example Playbook
|
||||||
|
================
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
- hosts: localhost
|
||||||
|
gather_facts: false
|
||||||
|
vars:
|
||||||
|
minimal_cpu_count: 42
|
||||||
|
roles:
|
||||||
|
- check_cpu
|
||||||
|
|
||||||
|
License
|
||||||
|
=======
|
||||||
|
|
||||||
|
Apache
|
||||||
|
|
||||||
|
Author Information
|
||||||
|
==================
|
||||||
|
|
||||||
|
**Red Hat TripleO DFG:DF Squad:VF**
|
||||||
|
|
||||||
|
----------------
|
||||||
|
Full Description
|
||||||
|
----------------
|
||||||
|
|
||||||
.. ansibleautoplugin::
|
.. ansibleautoplugin::
|
||||||
:role: validations_common/roles/check_cpu
|
:role: validations_common/roles/check_cpu
|
||||||
|
@ -1,36 +0,0 @@
|
|||||||
Undercloud-cpu
|
|
||||||
==============
|
|
||||||
|
|
||||||
An Ansible role to check if the Undercloud fits the CPU core requirements
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
|
|
||||||
This role could be used before or/and after the Undercloud installation.
|
|
||||||
|
|
||||||
Role Variables
|
|
||||||
--------------
|
|
||||||
|
|
||||||
- min_undercloud_cpu_count: <8> -- Minimal number of CPU core
|
|
||||||
|
|
||||||
Dependencies
|
|
||||||
------------
|
|
||||||
|
|
||||||
No dependencies.
|
|
||||||
|
|
||||||
Example Playbook
|
|
||||||
----------------
|
|
||||||
|
|
||||||
- hosts: undercloud
|
|
||||||
roles:
|
|
||||||
- { role: undercloud-cpu, min_undercloud_cpu_count: 42 }
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
Apache 2.0
|
|
||||||
|
|
||||||
Author Information
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Red Hat TripleO Validations Team
|
|
@ -1,2 +1,3 @@
|
|||||||
---
|
---
|
||||||
|
# Minimal number of CPU core
|
||||||
minimal_cpu_count: 8
|
minimal_cpu_count: 8
|
||||||
|
Loading…
x
Reference in New Issue
Block a user