diff --git a/doc/source/roles/role-repos.rst b/doc/source/roles/role-repos.rst index b266de412..300f13a3d 100644 --- a/doc/source/roles/role-repos.rst +++ b/doc/source/roles/role-repos.rst @@ -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 diff --git a/doc/source/roles/role-undercloud_disk_space.rst b/doc/source/roles/role-undercloud_disk_space.rst index 811f067fc..929c532c4 100644 --- a/doc/source/roles/role-undercloud_disk_space.rst +++ b/doc/source/roles/role-undercloud_disk_space.rst @@ -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 diff --git a/doc/source/roles/role-undercloud_heat_purge_deleted.rst b/doc/source/roles/role-undercloud_heat_purge_deleted.rst index 6007c8b6b..81f36d59b 100644 --- a/doc/source/roles/role-undercloud_heat_purge_deleted.rst +++ b/doc/source/roles/role-undercloud_heat_purge_deleted.rst @@ -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 diff --git a/doc/source/roles/role-undercloud_process_count.rst b/doc/source/roles/role-undercloud_process_count.rst index c1772a4d8..3e9c509f0 100644 --- a/doc/source/roles/role-undercloud_process_count.rst +++ b/doc/source/roles/role-undercloud_process_count.rst @@ -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 diff --git a/doc/source/roles/role-undercloud_service_status.rst b/doc/source/roles/role-undercloud_service_status.rst index 9e4e1b9a5..10b870ceb 100644 --- a/doc/source/roles/role-undercloud_service_status.rst +++ b/doc/source/roles/role-undercloud_service_status.rst @@ -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 diff --git a/doc/source/roles/role-undercloud_tokenflush.rst b/doc/source/roles/role-undercloud_tokenflush.rst index c1142ed84..9195ab673 100644 --- a/doc/source/roles/role-undercloud_tokenflush.rst +++ b/doc/source/roles/role-undercloud_tokenflush.rst @@ -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 diff --git a/roles/overcloud_service_status/resources/README.md b/roles/overcloud_service_status/resources/README.md deleted file mode 100644 index be369befc..000000000 --- a/roles/overcloud_service_status/resources/README.md +++ /dev/null @@ -1 +0,0 @@ -Shared resources used for molecule unit testing diff --git a/roles/repos/README.md b/roles/repos/README.md deleted file mode 100644 index 6a0d5d8a8..000000000 --- a/roles/repos/README.md +++ /dev/null @@ -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 diff --git a/roles/undercloud_disk_space/README.md b/roles/undercloud_disk_space/README.md deleted file mode 100644 index 73bf492b8..000000000 --- a/roles/undercloud_disk_space/README.md +++ /dev/null @@ -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 diff --git a/roles/undercloud_heat_purge_deleted/README.md b/roles/undercloud_heat_purge_deleted/README.md deleted file mode 100644 index c5df77f11..000000000 --- a/roles/undercloud_heat_purge_deleted/README.md +++ /dev/null @@ -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 diff --git a/roles/undercloud_process_count/README.md b/roles/undercloud_process_count/README.md deleted file mode 100644 index 77c379b2f..000000000 --- a/roles/undercloud_process_count/README.md +++ /dev/null @@ -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 diff --git a/roles/undercloud_service_status/README.md b/roles/undercloud_service_status/README.md deleted file mode 100644 index 946bfa0f7..000000000 --- a/roles/undercloud_service_status/README.md +++ /dev/null @@ -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. diff --git a/roles/undercloud_tokenflush/README.md b/roles/undercloud_tokenflush/README.md deleted file mode 100644 index ede64f9f7..000000000 --- a/roles/undercloud_tokenflush/README.md +++ /dev/null @@ -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