Removing leftover README docs from roles

Several README files have been left in the roles after
our adoption automatic documentation.

Contents of these files were moved into role documentation
within doc/source directory where applicable.

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: Icbb4c2735c251166826a116f9ffa9c04b1487a05
(cherry picked from commit 8692b4bd71)
This commit is contained in:
Jiri Podivin 2022-02-02 13:55:41 +01:00
parent a5691dd5aa
commit b79d0e7f3b
13 changed files with 246 additions and 229 deletions

View File

@ -2,5 +2,46 @@
repos
=====
An Ansible role to check the correctness of current repositories.
Requirements
------------
This role could be used before/after an Undercloud or an Overcloud has been
deployed.
Role Variables
--------------
- None
Dependencies
------------
No dependencies.
Example Playbook
----------------
.. code-block:: yaml
- hosts: undercloud
roles:
- role: repos
- hosts: overcloud
roles:
- role: repos
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team
.. ansibleautoplugin::
:role: roles/repos

View File

@ -1,6 +1,46 @@
=====================
undercloud_disk_space
Undercloud-disk-space
=====================
An Ansible role to verify if the Undercloud fits the disk space requirements.
Requirements
------------
This role could be used before or/and after the Undercloud installation.
Role Variables
--------------
- Volumes: a dictionary of mount points and their minimum sizes
Dependencies
------------
No Dependencies
Example Playbook
----------------
.. code-block:: yaml
- hosts: servers
roles:
- { role: undercloud-disk-space}
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validation Team
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: roles/undercloud_disk_space

View File

@ -2,5 +2,46 @@
undercloud_heat_purge_deleted
=============================
An Ansible role to check if `heat-manage purge_deleted` is enabled in the
crontab
Requirements
------------
This role requires an installed and working Undercloud.
Role Variables
--------------
- cron_check: <'heat-manage purge_deleted'> -- String to check in the crontab
Dependencies
------------
No dependencies.
Example Playbook
----------------
.. code-block:: yaml
- hosts: undercloud
roles:
- { role: undercloud-heat-purge-deleted }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: roles/undercloud_heat_purge_deleted

View File

@ -2,5 +2,46 @@
undercloud_process_count
========================
An Ansible role to check the number of OpenStack processes on the Undercloud
Requirements
------------
This role requires an installed and working Undercloud
Role Variables
--------------
- max_process_count: <'8'> -- Maximum number of process
Dependencies
------------
No dependencies.
Example Playbook
----------------
.. code-block:: yaml
- hosts: servers
roles:
- { role: undercloud-process-count }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: roles/undercloud_process_count

View File

@ -2,5 +2,46 @@
undercloud_service_status
=========================
An Ansible role to verify the Undercloud services states before running an
Update or Upgrade.
Requirements
------------
This role needs to be run against an installed Undercloud.
Role Variables
--------------
- undercloud_service_list: A list of services actually coming from the tripleo-ansible-inventory
Dependencies
------------
No dependencies.
Example Playbook
----------------
.. code-block:: yaml
- hosts: undercloud
roles:
- { role: undercloud-service-status }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team.
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: roles/undercloud_service_status

View File

@ -2,5 +2,46 @@
undercloud_tokenflush
=====================
An Ansible role to check if `keystone-manage token_flush` is enabled for the keystone user.
Requirements
------------
This role requires an installed and working Undercloud.
Role Variables
--------------
- cron_check: <'keystone-manage token_flush'> -- the string to check in the crontab
Dependencies
------------
No dependencies.
Example Playbook
----------------
.. code-block:: yaml
- hosts: undercloud
roles:
- { role: undercloud-tokenflush }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: roles/undercloud_tokenflush

View File

@ -1 +0,0 @@
Shared resources used for molecule unit testing

View File

@ -1,41 +0,0 @@
Repos
==============
An Ansible role to check the correctness of current repositories.
Requirements
------------
This role could be used before/after an Undercloud or an Overcloud has been
deployed.
Role Variables
--------------
- None
Dependencies
------------
No dependencies.
Example Playbook
----------------
- hosts: undercloud
roles:
- role: repos
- hosts: overcloud
roles:
- role: repos
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team

View File

@ -1,36 +0,0 @@
Undercloud-disk-space
=====================
An Ansible role to verify if the Undercloud fits the disk space requirements.
Requirements
------------
This role could be used before or/and after the Undercloud installation.
Role Variables
--------------
- Volumes: a dictionary of mount points and their minimum sizes
Dependencies
------------
No Dependencies
Example Playbook
----------------
- hosts: servers
roles:
- { role: undercloud-disk-space}
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validation Team

View File

@ -1,38 +0,0 @@
Undercloud-heat-purge-deleted
=============================
An Ansible role to check if `heat-manage purge_deleted` is enabled in the
crontab
Requirements
------------
This role requires an installed and working Undercloud.
Role Variables
--------------
- cron_check: <'heat-manage purge_deleted'> -- String to check in the crontab
Dependencies
------------
No dependencies.
Example Playbook
----------------
- hosts: undercloud
roles:
- { role: undercloud-heat-purge-deleted }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team

View File

@ -1,37 +0,0 @@
Role Name
=========
An Ansible role to check the number of OpenStack processes on the Undercloud
Requirements
------------
This role requires an installed and working Undercloud
Role Variables
--------------
- max_process_count: <'8'> -- Maximum number of process
Dependencies
------------
No dependencies.
Example Playbook
----------------
- hosts: servers
roles:
- { role: undercloud-process-count }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team

View File

@ -1,38 +0,0 @@
Undercloud-service-status
=========================
An Ansible role to verify the Undercloud services states before running an
Update or Upgrade.
Requirements
------------
This role needs to be run against an installed Undercloud.
Role Variables
--------------
- undercloud_service_list: A list of services actually coming from the tripleo-ansible-inventory
Dependencies
------------
No dependencies.
Example Playbook
----------------
- hosts: undercloud
roles:
- { role: undercloud-service-status }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team.

View File

@ -1,37 +0,0 @@
Undercloud-tokenflush
=====================
An Ansible role to check if `keystone-manage token_flush` is enabled for the keystone user.
Requirements
------------
This role requires an installed and working Undercloud.
Role Variables
--------------
- cron_check: <'keystone-manage token_flush'> -- the string to check in the crontab
Dependencies
------------
No dependencies.
Example Playbook
----------------
- hosts: undercloud
roles:
- { role: undercloud-tokenflush }
License
-------
Apache
Author Information
------------------
Red Hat TripleO Validations Team