From 42934b9a09e53b562f6c66b69e235ddaeb64f8a9 Mon Sep 17 00:00:00 2001
From: Gael Chamoulaud <gchamoul@redhat.com>
Date: Fri, 17 Jan 2020 12:49:13 +0100
Subject: [PATCH] Make groups documentation part dynamic

The groups.yaml file is now the source of information concerning the
validations groups. The groups information part is now created
dynamically by reading the groups.yaml file.

This patch also fixes the basepython conflict for the tox py37 testenv.

Change-Id: Id199fc250afa0646b1e851581e3a92290f7bcb00
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>
---
 doc/requirements.txt                          |  1 +
 doc/source/_exts/generate_validations_doc.py  | 57 +++++++++++++--
 doc/source/index.rst                          |  3 +-
 doc/source/readme.rst                         | 73 +++----------------
 ... => role-advanced_format_512e_support.rst} |  4 +-
 ...db-size.rst => role-ceilometerdb_size.rst} |  4 +-
 ...=> role-check_latest_packages_version.rst} |  4 +-
 ...ace.rst => role-check_network_gateway.rst} |  4 +-
 ...e-collect_flavors_and_verify_profiles.rst} |  4 +-
 ...-selinux.rst => role-container_status.rst} |  4 +-
 ... role-containerized_undercloud_docker.rst} |  4 +-
 ...er-token.rst => role-controller_token.rst} |  4 +-
 ...-count.rst => role-controller_ulimits.rst} |  4 +-
 ...p-range.rst => role-ctlplane_ip_range.rst} |  4 +-
 ...limits.rst => role-default_node_count.rst} |  4 +-
 ...idations.rst => role-dhcp_validations.rst} |  4 +-
 ...st => role-healthcheck_service_status.rst} |  4 +-
 ...e-nova-status.rst => role-image_serve.rst} |  4 +-
 ...rst => role-ironic_boot_configuration.rst} |  4 +-
 ...it.rst => role-mysql_open_files_limit.rst} |  4 +-
 ...nment.rst => role-network_environment.rst} |  4 +-
 ...heck.rst => role-neutron_sanity_check.rst} |  4 +-
 .../roles/{role-no-op.rst => role-no_op.rst}  |  4 +-
 ...st => role-no_op_firewall_nova_driver.rst} |  3 +-
 ...ole-node-disks.rst => role-node_disks.rst} |  4 +-
 ...e-node-health.rst => role-node_health.rst} |  4 +-
 ...lback.rst => role-nova_event_callback.rst} |  4 +-
 ...e-image-serve.rst => role-nova_status.rst} |  4 +-
 ...ck.rst => role-openshift_on_openstack.rst} |  4 +-
 ...oints.rst => role-openstack_endpoints.rst} |  4 +-
 ...ovs-dpdk-pmd.rst => role-ovs_dpdk_pmd.rst} |  4 +-
 ...ud-debug.rst => role-pacemaker_status.rst} |  4 +-
 ...mq-limits.rst => role-rabbitmq_limits.rst} |  4 +-
 ...ice-status.rst => role-service_status.rst} |  4 +-
 ...stack-health.rst => role-stack_health.rst} |  4 +-
 ...ith-exists.rst => role-stonith_exists.rst} |  4 +-
 ...switch-vlans.rst => role-switch_vlans.rst} |  4 +-
 ...everywhere.rst => role-tls_everywhere.rst} |  4 +-
 doc/source/roles/role-undercloud-ram.rst      |  7 --
 ...rcloud-cpu.rst => role-undercloud_cpu.rst} |  4 +-
 ...r-status.rst => role-undercloud_debug.rst} |  4 +-
 ...ush.rst => role-undercloud_disk_space.rst} |  4 +-
 ...=> role-undercloud_heat_purge_deleted.rst} |  4 +-
 ....rst => role-undercloud_process_count.rst} |  4 +-
 doc/source/roles/role-undercloud_ram.rst      |  7 ++
 ...e.rst => role-undercloud_selinux_mode.rst} |  4 +-
 ...rst => role-undercloud_service_status.rst} |  4 +-
 ...way.rst => role-undercloud_tokenflush.rst} |  5 +-
 ...r-status.rst => role-validate_selinux.rst} |  4 +-
 ...eck-ftype.rst => role-xfs_check_ftype.rst} |  4 +-
 tox.ini                                       |  1 -
 51 files changed, 156 insertions(+), 169 deletions(-)
 rename doc/source/roles/{role-advanced-format-512e-support.rst => role-advanced_format_512e_support.rst} (52%)
 rename doc/source/roles/{role-ceilometerdb-size.rst => role-ceilometerdb_size.rst} (53%)
 rename doc/source/roles/{role-check-latest-packages-version.rst => role-check_latest_packages_version.rst} (52%)
 rename doc/source/roles/{role-undercloud-disk-space.rst => role-check_network_gateway.rst} (53%)
 rename doc/source/roles/{role-collect-flavors-and-verify-profiles.rst => role-collect_flavors_and_verify_profiles.rst} (52%)
 rename doc/source/roles/{role-validate-selinux.rst => role-container_status.rst} (53%)
 rename doc/source/roles/{role-containerized-undercloud-docker.rst => role-containerized_undercloud_docker.rst} (52%)
 rename doc/source/roles/{role-controller-token.rst => role-controller_token.rst} (54%)
 rename doc/source/roles/{role-default-node-count.rst => role-controller_ulimits.rst} (53%)
 rename doc/source/roles/{role-ctlplane-ip-range.rst => role-ctlplane_ip_range.rst} (53%)
 rename doc/source/roles/{role-controller-ulimits.rst => role-default_node_count.rst} (53%)
 rename doc/source/roles/{role-dhcp-validations.rst => role-dhcp_validations.rst} (54%)
 rename doc/source/roles/{role-healthcheck-service-status.rst => role-healthcheck_service_status.rst} (52%)
 rename doc/source/roles/{role-nova-status.rst => role-image_serve.rst} (55%)
 rename doc/source/roles/{role-ironic-boot-configuration.rst => role-ironic_boot_configuration.rst} (53%)
 rename doc/source/roles/{role-mysql-open-files-limit.rst => role-mysql_open_files_limit.rst} (53%)
 rename doc/source/roles/{role-network-environment.rst => role-network_environment.rst} (53%)
 rename doc/source/roles/{role-neutron-sanity-check.rst => role-neutron_sanity_check.rst} (53%)
 rename doc/source/roles/{role-no-op.rst => role-no_op.rst} (56%)
 rename doc/source/roles/{role-no-op-firewall-nova-driver.rst => role-no_op_firewall_nova_driver.rst} (70%)
 rename doc/source/roles/{role-node-disks.rst => role-node_disks.rst} (55%)
 rename doc/source/roles/{role-node-health.rst => role-node_health.rst} (55%)
 rename doc/source/roles/{role-nova-event-callback.rst => role-nova_event_callback.rst} (53%)
 rename doc/source/roles/{role-image-serve.rst => role-nova_status.rst} (55%)
 rename doc/source/roles/{role-openshift-on-openstack.rst => role-openshift_on_openstack.rst} (53%)
 rename doc/source/roles/{role-openstack-endpoints.rst => role-openstack_endpoints.rst} (53%)
 rename doc/source/roles/{role-ovs-dpdk-pmd.rst => role-ovs_dpdk_pmd.rst} (54%)
 rename doc/source/roles/{role-undercloud-debug.rst => role-pacemaker_status.rst} (54%)
 rename doc/source/roles/{role-rabbitmq-limits.rst => role-rabbitmq_limits.rst} (54%)
 rename doc/source/roles/{role-service-status.rst => role-service_status.rst} (54%)
 rename doc/source/roles/{role-stack-health.rst => role-stack_health.rst} (54%)
 rename doc/source/roles/{role-stonith-exists.rst => role-stonith_exists.rst} (54%)
 rename doc/source/roles/{role-switch-vlans.rst => role-switch_vlans.rst} (54%)
 rename doc/source/roles/{role-tls-everywhere.rst => role-tls_everywhere.rst} (54%)
 delete mode 100644 doc/source/roles/role-undercloud-ram.rst
 rename doc/source/roles/{role-undercloud-cpu.rst => role-undercloud_cpu.rst} (54%)
 rename doc/source/roles/{role-pacemaker-status.rst => role-undercloud_debug.rst} (54%)
 rename doc/source/roles/{role-undercloud-tokenflush.rst => role-undercloud_disk_space.rst} (53%)
 rename doc/source/roles/{role-undercloud-heat-purge-deleted.rst => role-undercloud_heat_purge_deleted.rst} (52%)
 rename doc/source/roles/{role-undercloud-process-count.rst => role-undercloud_process_count.rst} (53%)
 create mode 100644 doc/source/roles/role-undercloud_ram.rst
 rename doc/source/roles/{role-undercloud-selinux-mode.rst => role-undercloud_selinux_mode.rst} (53%)
 rename doc/source/roles/{role-undercloud-service-status.rst => role-undercloud_service_status.rst} (53%)
 rename doc/source/roles/{role-check-network-gateway.rst => role-undercloud_tokenflush.rst} (52%)
 rename doc/source/roles/{role-container-status.rst => role-validate_selinux.rst} (53%)
 rename doc/source/roles/{role-xfs-check-ftype.rst => role-xfs_check_ftype.rst} (54%)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index d78a8099f..e00f9097a 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -5,3 +5,4 @@ openstackdocstheme>=1.29.2 # Apache-2.0
 reno>=2.11.3 # Apache-2.0
 doc8>=0.8.0 # Apache-2.0
 bashate>=0.6.0 # Apache-2.0
+six>=1.11.0 # MIT
diff --git a/doc/source/_exts/generate_validations_doc.py b/doc/source/_exts/generate_validations_doc.py
index 43273bc19..321675176 100644
--- a/doc/source/_exts/generate_validations_doc.py
+++ b/doc/source/_exts/generate_validations_doc.py
@@ -14,7 +14,7 @@
 
 from glob import glob
 import os
-
+import six
 import yaml
 
 DEFAULT_METADATA = {
@@ -113,18 +113,59 @@ Role documentation
         f.write("\n".join(entries))
 
 
+def build_groups_detail(groups):
+    entries = [
+        """
+{group}
+{adornment}
+
+{desc}
+
+.. include:: {link}
+
+"""
+        .format(group=grp.capitalize(),
+                adornment=(len(grp) * '~'),
+                link="validations-{}.rst".format(grp),
+                desc=desc[0].get('description', None),
+                )
+        for grp, desc in sorted(groups.items())]
+    with open('doc/source/validations-groups.rst', 'w') as f:
+        f.write("\n".join(entries))
+
+
+def parse_groups_file():
+    contents = {}
+    groups_file_path = os.path.abspath('groups.yaml')
+
+    if os.path.exists(groups_file_path):
+        with open(groups_file_path, "r") as grps:
+            contents = yaml.safe_load(grps)
+
+    return contents
+
+
+def get_groups():
+    # Seed it with the known groups from groups.yaml file.
+    groups = set()
+    contents = parse_groups_file()
+
+    for group_name in six.iterkeys(contents):
+        groups.add(group_name)
+
+    return groups, contents
+
+
 def setup(app):
-    # Seed it with the known groups:
-    groups = set(('no-op', 'prep', 'pre-introspection',
-                  'pre-deployment', 'post-deployment',
-                  'pre-update', 'pre-upgrade',
-                  'post-upgrade', 'openshift-on-openstack'))
+    group_name, group_info = get_groups()
+    build_groups_detail(group_info)
+
     validations = []
     for validation_path in sorted(glob('playbooks/*.yaml')):
         with open(validation_path) as f:
             loaded_validation = yaml.safe_load(f.read())[0]
             for group in get_validation_metadata(loaded_validation, 'groups'):
-                groups.add(group)
+                group_name.add(group)
             validations.append({
                 'hosts': loaded_validation['hosts'],
                 'parameters': get_validation_parameters(loaded_validation),
@@ -138,7 +179,7 @@ def setup(app):
                 'roles': get_include_role(loaded_validation)
             })
 
-    for group in groups:
+    for group in group_name:
         validations_in_group = [validation for validation
                                 in validations
                                 if group in validation['groups']]
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 18aad0c27..437f78e23 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -28,9 +28,10 @@ Existing validations:
    validations-pre-deployment-details
    validations-post-deployment-details
    validations-openshift-on-openstack-details
-   validations-pre-update-details
    validations-pre-upgrade-details
    validations-post-upgrade-details
+   validations-pre-ceph-details
+   validations-post-ceph-details
 
 Indices and tables
 ==================
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
index da4cd296a..551fca818 100644
--- a/doc/source/readme.rst
+++ b/doc/source/readme.rst
@@ -43,71 +43,18 @@ the deployment stage they're should be run on.
 
 Validations can belong to multiple groups.
 
-No op
-~~~~~
+.. include:: validations-groups.rst
 
-A validation doing nothing for testing the framework
-
-.. include:: validations-no-op.rst
-
-Prep
-~~~~
-
-Validations that are run on a fresh machine *before* the undercloud is
-installed.
-
-.. include:: validations-prep.rst
-
-Pre Introspection
-~~~~~~~~~~~~~~~~~
-
-Validations that are run when the undercloud is ready to perform hardware
-introspection.
-
-.. include:: validations-pre-introspection.rst
-
-Pre Deployment
-~~~~~~~~~~~~~~
-
-Validations that are run right before deploying the overcloud.
-
-.. include:: validations-pre-deployment.rst
-
-Post Deployment
-~~~~~~~~~~~~~~~
-
-Validations that are run after the overcloud deployment finished.
-
-.. include:: validations-post-deployment.rst
-
-Pre Update
-~~~~~~~~~~
-
-Validations that are run right before a minor update of the undercloud or overcloud.
-
-.. include:: validations-pre-update.rst
-
-Pre Upgrade
-~~~~~~~~~~~
-
-Validations that are run right before a major upgrade of the undercloud or overcloud.
-
-.. include:: validations-pre-upgrade.rst
-
-Post Upgrade
-~~~~~~~~~~~~
-
-Validations that are run right after a major upgrade of the undercloud or overcloud.
-
-.. include:: validations-post-upgrade.rst
-
-OpenShift On OpenStack
-~~~~~~~~~~~~~~~~~~~~~~
-
-Validations that are run right after the undercloud is installed.
-
-.. include:: validations-openshift-on-openstack.rst
+To add a new group, you will need to edit the ``groups.yaml`` file located in
+the root of the TripleO Validations directory::
 
+    $ [vim|emacs] groups.yaml
+    ...
+    pre-update:
+      - description: >-
+          Validations which try to validate your OpenStack deployment before you
+          update it.
+    ...
 
 Writing Validations
 -------------------
diff --git a/doc/source/roles/role-advanced-format-512e-support.rst b/doc/source/roles/role-advanced_format_512e_support.rst
similarity index 52%
rename from doc/source/roles/role-advanced-format-512e-support.rst
rename to doc/source/roles/role-advanced_format_512e_support.rst
index 65a878b47..a67dfb249 100644
--- a/doc/source/roles/role-advanced-format-512e-support.rst
+++ b/doc/source/roles/role-advanced_format_512e_support.rst
@@ -1,7 +1,7 @@
 ============================
-advanced-format-512e-support
+advanced_format_512e_support
 ============================
 
 .. ansibleautoplugin::
-   :role: roles/advanced-format-512e-support
+   :role: roles/advanced_format_512e_support
 
diff --git a/doc/source/roles/role-ceilometerdb-size.rst b/doc/source/roles/role-ceilometerdb_size.rst
similarity index 53%
rename from doc/source/roles/role-ceilometerdb-size.rst
rename to doc/source/roles/role-ceilometerdb_size.rst
index 80884c2e6..9ea910838 100644
--- a/doc/source/roles/role-ceilometerdb-size.rst
+++ b/doc/source/roles/role-ceilometerdb_size.rst
@@ -1,7 +1,7 @@
 =================
-ceilometerdb-size
+ceilometerdb_size
 =================
 
 .. ansibleautoplugin::
-   :role: roles/ceilometerdb-size
+   :role: roles/ceilometerdb_size
 
diff --git a/doc/source/roles/role-check-latest-packages-version.rst b/doc/source/roles/role-check_latest_packages_version.rst
similarity index 52%
rename from doc/source/roles/role-check-latest-packages-version.rst
rename to doc/source/roles/role-check_latest_packages_version.rst
index 4dcf7f8d9..ab8d5d91b 100644
--- a/doc/source/roles/role-check-latest-packages-version.rst
+++ b/doc/source/roles/role-check_latest_packages_version.rst
@@ -1,6 +1,6 @@
 =============================
-check-latest-packages-version
+check_latest_packages_version
 =============================
 
 .. ansibleautoplugin::
-   :role: roles/check-latest-packages-version
+   :role: roles/check_latest_packages_version
diff --git a/doc/source/roles/role-undercloud-disk-space.rst b/doc/source/roles/role-check_network_gateway.rst
similarity index 53%
rename from doc/source/roles/role-undercloud-disk-space.rst
rename to doc/source/roles/role-check_network_gateway.rst
index aa60ac675..976e10460 100644
--- a/doc/source/roles/role-undercloud-disk-space.rst
+++ b/doc/source/roles/role-check_network_gateway.rst
@@ -1,7 +1,7 @@
 =====================
-undercloud-disk-space
+check_network_gateway
 =====================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-disk-space
+   :role: roles/check_network_gateway
 
diff --git a/doc/source/roles/role-collect-flavors-and-verify-profiles.rst b/doc/source/roles/role-collect_flavors_and_verify_profiles.rst
similarity index 52%
rename from doc/source/roles/role-collect-flavors-and-verify-profiles.rst
rename to doc/source/roles/role-collect_flavors_and_verify_profiles.rst
index 0c9b6b30e..20985e2aa 100644
--- a/doc/source/roles/role-collect-flavors-and-verify-profiles.rst
+++ b/doc/source/roles/role-collect_flavors_and_verify_profiles.rst
@@ -1,7 +1,7 @@
 ===================================
-collect-flavors-and-verify-profiles
+collect_flavors_and_verify_profiles
 ===================================
 
 .. ansibleautoplugin::
-   :role: roles/collect-flavors-and-verify-profiles
+   :role: roles/collect_flavors_and_verify_profiles
 
diff --git a/doc/source/roles/role-validate-selinux.rst b/doc/source/roles/role-container_status.rst
similarity index 53%
rename from doc/source/roles/role-validate-selinux.rst
rename to doc/source/roles/role-container_status.rst
index a6b31271d..01ba5d78a 100644
--- a/doc/source/roles/role-validate-selinux.rst
+++ b/doc/source/roles/role-container_status.rst
@@ -1,6 +1,6 @@
 ================
-validate-selinux
+container_status
 ================
 
 .. ansibleautoplugin::
-   :role: roles/validate-selinux
+   :role: roles/container_status
diff --git a/doc/source/roles/role-containerized-undercloud-docker.rst b/doc/source/roles/role-containerized_undercloud_docker.rst
similarity index 52%
rename from doc/source/roles/role-containerized-undercloud-docker.rst
rename to doc/source/roles/role-containerized_undercloud_docker.rst
index b2efe2997..a15054202 100644
--- a/doc/source/roles/role-containerized-undercloud-docker.rst
+++ b/doc/source/roles/role-containerized_undercloud_docker.rst
@@ -1,7 +1,7 @@
 ===============================
-containerized-undercloud-docker
+containerized_undercloud_docker
 ===============================
 
 .. ansibleautoplugin::
-   :role: roles/containerized-undercloud-docker
+   :role: roles/containerized_undercloud_docker
 
diff --git a/doc/source/roles/role-controller-token.rst b/doc/source/roles/role-controller_token.rst
similarity index 54%
rename from doc/source/roles/role-controller-token.rst
rename to doc/source/roles/role-controller_token.rst
index 6c0eb04a3..29ce31e6b 100644
--- a/doc/source/roles/role-controller-token.rst
+++ b/doc/source/roles/role-controller_token.rst
@@ -1,7 +1,7 @@
 ================
-controller-token
+controller_token
 ================
 
 .. ansibleautoplugin::
-   :role: roles/controller-token
+   :role: roles/controller_token
 
diff --git a/doc/source/roles/role-default-node-count.rst b/doc/source/roles/role-controller_ulimits.rst
similarity index 53%
rename from doc/source/roles/role-default-node-count.rst
rename to doc/source/roles/role-controller_ulimits.rst
index eb8b66559..22c45aa8f 100644
--- a/doc/source/roles/role-default-node-count.rst
+++ b/doc/source/roles/role-controller_ulimits.rst
@@ -1,7 +1,7 @@
 ==================
-default-node-count
+controller_ulimits
 ==================
 
 .. ansibleautoplugin::
-   :role: roles/default-node-count
+   :role: roles/controller_ulimits
 
diff --git a/doc/source/roles/role-ctlplane-ip-range.rst b/doc/source/roles/role-ctlplane_ip_range.rst
similarity index 53%
rename from doc/source/roles/role-ctlplane-ip-range.rst
rename to doc/source/roles/role-ctlplane_ip_range.rst
index d25c34ff9..591918379 100644
--- a/doc/source/roles/role-ctlplane-ip-range.rst
+++ b/doc/source/roles/role-ctlplane_ip_range.rst
@@ -1,7 +1,7 @@
 =================
-ctlplane-ip-range
+ctlplane_ip_range
 =================
 
 .. ansibleautoplugin::
-   :role: roles/ctlplane-ip-range
+   :role: roles/ctlplane_ip_range
 
diff --git a/doc/source/roles/role-controller-ulimits.rst b/doc/source/roles/role-default_node_count.rst
similarity index 53%
rename from doc/source/roles/role-controller-ulimits.rst
rename to doc/source/roles/role-default_node_count.rst
index 17f42bac8..70090dff3 100644
--- a/doc/source/roles/role-controller-ulimits.rst
+++ b/doc/source/roles/role-default_node_count.rst
@@ -1,7 +1,7 @@
 ==================
-controller-ulimits
+default_node_count
 ==================
 
 .. ansibleautoplugin::
-   :role: roles/controller-ulimits
+   :role: roles/default_node_count
 
diff --git a/doc/source/roles/role-dhcp-validations.rst b/doc/source/roles/role-dhcp_validations.rst
similarity index 54%
rename from doc/source/roles/role-dhcp-validations.rst
rename to doc/source/roles/role-dhcp_validations.rst
index 51e3f78e0..01548f90e 100644
--- a/doc/source/roles/role-dhcp-validations.rst
+++ b/doc/source/roles/role-dhcp_validations.rst
@@ -1,7 +1,7 @@
 ================
-dhcp-validations
+dhcp_validations
 ================
 
 .. ansibleautoplugin::
-   :role: roles/dhcp-validations
+   :role: roles/dhcp_validations
 
diff --git a/doc/source/roles/role-healthcheck-service-status.rst b/doc/source/roles/role-healthcheck_service_status.rst
similarity index 52%
rename from doc/source/roles/role-healthcheck-service-status.rst
rename to doc/source/roles/role-healthcheck_service_status.rst
index 7b8b569f0..2ac903964 100644
--- a/doc/source/roles/role-healthcheck-service-status.rst
+++ b/doc/source/roles/role-healthcheck_service_status.rst
@@ -1,6 +1,6 @@
 ==========================
-healthcheck-service-status
+healthcheck_service_status
 ==========================
 
 .. ansibleautoplugin::
-   :role: roles/healthcheck-service-status
+   :role: roles/healthcheck_service_status
diff --git a/doc/source/roles/role-nova-status.rst b/doc/source/roles/role-image_serve.rst
similarity index 55%
rename from doc/source/roles/role-nova-status.rst
rename to doc/source/roles/role-image_serve.rst
index dfe91bec7..630ed4258 100644
--- a/doc/source/roles/role-nova-status.rst
+++ b/doc/source/roles/role-image_serve.rst
@@ -1,7 +1,7 @@
 ===========
-nova-status
+image_serve
 ===========
 
 .. ansibleautoplugin::
-   :role: roles/nova-status
+   :role: roles/image_serve
 
diff --git a/doc/source/roles/role-ironic-boot-configuration.rst b/doc/source/roles/role-ironic_boot_configuration.rst
similarity index 53%
rename from doc/source/roles/role-ironic-boot-configuration.rst
rename to doc/source/roles/role-ironic_boot_configuration.rst
index 05aa7070b..d5e31852e 100644
--- a/doc/source/roles/role-ironic-boot-configuration.rst
+++ b/doc/source/roles/role-ironic_boot_configuration.rst
@@ -1,7 +1,7 @@
 =========================
-ironic-boot-configuration
+ironic_boot_configuration
 =========================
 
 .. ansibleautoplugin::
-   :role: roles/ironic-boot-configuration
+   :role: roles/ironic_boot_configuration
 
diff --git a/doc/source/roles/role-mysql-open-files-limit.rst b/doc/source/roles/role-mysql_open_files_limit.rst
similarity index 53%
rename from doc/source/roles/role-mysql-open-files-limit.rst
rename to doc/source/roles/role-mysql_open_files_limit.rst
index 3fb2d4e78..5a33a7157 100644
--- a/doc/source/roles/role-mysql-open-files-limit.rst
+++ b/doc/source/roles/role-mysql_open_files_limit.rst
@@ -1,7 +1,7 @@
 ======================
-mysql-open-files-limit
+mysql_open_files_limit
 ======================
 
 .. ansibleautoplugin::
-   :role: roles/mysql-open-files-limit
+   :role: roles/mysql_open_files_limit
 
diff --git a/doc/source/roles/role-network-environment.rst b/doc/source/roles/role-network_environment.rst
similarity index 53%
rename from doc/source/roles/role-network-environment.rst
rename to doc/source/roles/role-network_environment.rst
index b71a73e6d..3a3bde6c6 100644
--- a/doc/source/roles/role-network-environment.rst
+++ b/doc/source/roles/role-network_environment.rst
@@ -1,7 +1,7 @@
 ===================
-network-environment
+network_environment
 ===================
 
 .. ansibleautoplugin::
-   :role: roles/network-environment
+   :role: roles/network_environment
 
diff --git a/doc/source/roles/role-neutron-sanity-check.rst b/doc/source/roles/role-neutron_sanity_check.rst
similarity index 53%
rename from doc/source/roles/role-neutron-sanity-check.rst
rename to doc/source/roles/role-neutron_sanity_check.rst
index 2553b4d60..62faf0db4 100644
--- a/doc/source/roles/role-neutron-sanity-check.rst
+++ b/doc/source/roles/role-neutron_sanity_check.rst
@@ -1,7 +1,7 @@
 ====================
-neutron-sanity-check
+neutron_sanity_check
 ====================
 
 .. ansibleautoplugin::
-   :role: roles/neutron-sanity-check
+   :role: roles/neutron_sanity_check
 
diff --git a/doc/source/roles/role-no-op.rst b/doc/source/roles/role-no_op.rst
similarity index 56%
rename from doc/source/roles/role-no-op.rst
rename to doc/source/roles/role-no_op.rst
index a1eeea66c..5e5be517e 100644
--- a/doc/source/roles/role-no-op.rst
+++ b/doc/source/roles/role-no_op.rst
@@ -1,7 +1,7 @@
 =====
-no-op
+no_op
 =====
 
 .. ansibleautoplugin::
-   :role: roles/no-op
+   :role: roles/no_op
 
diff --git a/doc/source/roles/role-no-op-firewall-nova-driver.rst b/doc/source/roles/role-no_op_firewall_nova_driver.rst
similarity index 70%
rename from doc/source/roles/role-no-op-firewall-nova-driver.rst
rename to doc/source/roles/role-no_op_firewall_nova_driver.rst
index f16006200..29a25ef45 100644
--- a/doc/source/roles/role-no-op-firewall-nova-driver.rst
+++ b/doc/source/roles/role-no_op_firewall_nova_driver.rst
@@ -3,5 +3,4 @@ no-op-firewall-nova-driver
 ==========================
 
 .. ansibleautoplugin::
-   :role: roles/no-op-firewall-nova-driver
-
+   :role: roles/no_op_firewall_nova_driver
diff --git a/doc/source/roles/role-node-disks.rst b/doc/source/roles/role-node_disks.rst
similarity index 55%
rename from doc/source/roles/role-node-disks.rst
rename to doc/source/roles/role-node_disks.rst
index 0edca3058..87001f888 100644
--- a/doc/source/roles/role-node-disks.rst
+++ b/doc/source/roles/role-node_disks.rst
@@ -1,7 +1,7 @@
 ==========
-node-disks
+node_disks
 ==========
 
 .. ansibleautoplugin::
-   :role: roles/node-disks
+   :role: roles/node_disks
 
diff --git a/doc/source/roles/role-node-health.rst b/doc/source/roles/role-node_health.rst
similarity index 55%
rename from doc/source/roles/role-node-health.rst
rename to doc/source/roles/role-node_health.rst
index 3e77a9737..3520d59df 100644
--- a/doc/source/roles/role-node-health.rst
+++ b/doc/source/roles/role-node_health.rst
@@ -1,7 +1,7 @@
 ===========
-node-health
+node_health
 ===========
 
 .. ansibleautoplugin::
-   :role: roles/node-health
+   :role: roles/node_health
 
diff --git a/doc/source/roles/role-nova-event-callback.rst b/doc/source/roles/role-nova_event_callback.rst
similarity index 53%
rename from doc/source/roles/role-nova-event-callback.rst
rename to doc/source/roles/role-nova_event_callback.rst
index f25454675..6883c97ab 100644
--- a/doc/source/roles/role-nova-event-callback.rst
+++ b/doc/source/roles/role-nova_event_callback.rst
@@ -1,7 +1,7 @@
 ===================
-nova-event-callback
+nova_event_callback
 ===================
 
 .. ansibleautoplugin::
-   :role: roles/nova-event-callback
+   :role: roles/nova_event_callback
 
diff --git a/doc/source/roles/role-image-serve.rst b/doc/source/roles/role-nova_status.rst
similarity index 55%
rename from doc/source/roles/role-image-serve.rst
rename to doc/source/roles/role-nova_status.rst
index 4b5d5e013..01c18b410 100644
--- a/doc/source/roles/role-image-serve.rst
+++ b/doc/source/roles/role-nova_status.rst
@@ -1,7 +1,7 @@
 ===========
-image-serve
+nova_status
 ===========
 
 .. ansibleautoplugin::
-   :role: roles/image-serve
+   :role: roles/nova_status
 
diff --git a/doc/source/roles/role-openshift-on-openstack.rst b/doc/source/roles/role-openshift_on_openstack.rst
similarity index 53%
rename from doc/source/roles/role-openshift-on-openstack.rst
rename to doc/source/roles/role-openshift_on_openstack.rst
index 3f3e9a4fe..9ba9c7a9e 100644
--- a/doc/source/roles/role-openshift-on-openstack.rst
+++ b/doc/source/roles/role-openshift_on_openstack.rst
@@ -1,7 +1,7 @@
 ======================
-openshift-on-openstack
+openshift_on_openstack
 ======================
 
 .. ansibleautoplugin::
-   :role: roles/openshift-on-openstack
+   :role: roles/openshift_on_openstack
 
diff --git a/doc/source/roles/role-openstack-endpoints.rst b/doc/source/roles/role-openstack_endpoints.rst
similarity index 53%
rename from doc/source/roles/role-openstack-endpoints.rst
rename to doc/source/roles/role-openstack_endpoints.rst
index cf833521a..400eebc74 100644
--- a/doc/source/roles/role-openstack-endpoints.rst
+++ b/doc/source/roles/role-openstack_endpoints.rst
@@ -1,7 +1,7 @@
 ===================
-openstack-endpoints
+openstack_endpoints
 ===================
 
 .. ansibleautoplugin::
-   :role: roles/openstack-endpoints
+   :role: roles/openstack_endpoints
 
diff --git a/doc/source/roles/role-ovs-dpdk-pmd.rst b/doc/source/roles/role-ovs_dpdk_pmd.rst
similarity index 54%
rename from doc/source/roles/role-ovs-dpdk-pmd.rst
rename to doc/source/roles/role-ovs_dpdk_pmd.rst
index dd5086a7e..af61937c5 100644
--- a/doc/source/roles/role-ovs-dpdk-pmd.rst
+++ b/doc/source/roles/role-ovs_dpdk_pmd.rst
@@ -1,7 +1,7 @@
 ============
-ovs-dpdk-pmd
+ovs_dpdk_pmd
 ============
 
 .. ansibleautoplugin::
-   :role: roles/ovs-dpdk-pmd
+   :role: roles/ovs_dpdk_pmd
 
diff --git a/doc/source/roles/role-undercloud-debug.rst b/doc/source/roles/role-pacemaker_status.rst
similarity index 54%
rename from doc/source/roles/role-undercloud-debug.rst
rename to doc/source/roles/role-pacemaker_status.rst
index e576a4e2b..90b6e3ecb 100644
--- a/doc/source/roles/role-undercloud-debug.rst
+++ b/doc/source/roles/role-pacemaker_status.rst
@@ -1,7 +1,7 @@
 ================
-undercloud-debug
+pacemaker_status
 ================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-debug
+   :role: roles/pacemaker_status
 
diff --git a/doc/source/roles/role-rabbitmq-limits.rst b/doc/source/roles/role-rabbitmq_limits.rst
similarity index 54%
rename from doc/source/roles/role-rabbitmq-limits.rst
rename to doc/source/roles/role-rabbitmq_limits.rst
index e9ade16f5..953279e23 100644
--- a/doc/source/roles/role-rabbitmq-limits.rst
+++ b/doc/source/roles/role-rabbitmq_limits.rst
@@ -1,7 +1,7 @@
 ===============
-rabbitmq-limits
+rabbitmq_limits
 ===============
 
 .. ansibleautoplugin::
-   :role: roles/rabbitmq-limits
+   :role: roles/rabbitmq_limits
 
diff --git a/doc/source/roles/role-service-status.rst b/doc/source/roles/role-service_status.rst
similarity index 54%
rename from doc/source/roles/role-service-status.rst
rename to doc/source/roles/role-service_status.rst
index f99e6c381..5e2bdf4e4 100644
--- a/doc/source/roles/role-service-status.rst
+++ b/doc/source/roles/role-service_status.rst
@@ -1,7 +1,7 @@
 ==============
-service-status
+service_status
 ==============
 
 .. ansibleautoplugin::
-   :role: roles/service-status
+   :role: roles/service_status
 
diff --git a/doc/source/roles/role-stack-health.rst b/doc/source/roles/role-stack_health.rst
similarity index 54%
rename from doc/source/roles/role-stack-health.rst
rename to doc/source/roles/role-stack_health.rst
index 432892f96..6845cc14c 100644
--- a/doc/source/roles/role-stack-health.rst
+++ b/doc/source/roles/role-stack_health.rst
@@ -1,7 +1,7 @@
 ============
-stack-health
+stack_health
 ============
 
 .. ansibleautoplugin::
-   :role: roles/stack-health
+   :role: roles/stack_health
 
diff --git a/doc/source/roles/role-stonith-exists.rst b/doc/source/roles/role-stonith_exists.rst
similarity index 54%
rename from doc/source/roles/role-stonith-exists.rst
rename to doc/source/roles/role-stonith_exists.rst
index 2c8129135..c2c19d7bb 100644
--- a/doc/source/roles/role-stonith-exists.rst
+++ b/doc/source/roles/role-stonith_exists.rst
@@ -1,7 +1,7 @@
 ==============
-stonith-exists
+stonith_exists
 ==============
 
 .. ansibleautoplugin::
-   :role: roles/stonith-exists
+   :role: roles/stonith_exists
 
diff --git a/doc/source/roles/role-switch-vlans.rst b/doc/source/roles/role-switch_vlans.rst
similarity index 54%
rename from doc/source/roles/role-switch-vlans.rst
rename to doc/source/roles/role-switch_vlans.rst
index 48806ef7c..619774cdc 100644
--- a/doc/source/roles/role-switch-vlans.rst
+++ b/doc/source/roles/role-switch_vlans.rst
@@ -1,7 +1,7 @@
 ============
-switch-vlans
+switch_vlans
 ============
 
 .. ansibleautoplugin::
-   :role: roles/switch-vlans
+   :role: roles/switch_vlans
 
diff --git a/doc/source/roles/role-tls-everywhere.rst b/doc/source/roles/role-tls_everywhere.rst
similarity index 54%
rename from doc/source/roles/role-tls-everywhere.rst
rename to doc/source/roles/role-tls_everywhere.rst
index 0944db6ba..f775e6767 100644
--- a/doc/source/roles/role-tls-everywhere.rst
+++ b/doc/source/roles/role-tls_everywhere.rst
@@ -1,7 +1,7 @@
 ==============
-tls-everywhere
+tls_everywhere
 ==============
 
 .. ansibleautoplugin::
-   :role: roles/tls-everywhere
+   :role: roles/tls_everywhere
 
diff --git a/doc/source/roles/role-undercloud-ram.rst b/doc/source/roles/role-undercloud-ram.rst
deleted file mode 100644
index 67caa9490..000000000
--- a/doc/source/roles/role-undercloud-ram.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-==============
-undercloud-ram
-==============
-
-.. ansibleautoplugin::
-   :role: roles/undercloud-ram
-
diff --git a/doc/source/roles/role-undercloud-cpu.rst b/doc/source/roles/role-undercloud_cpu.rst
similarity index 54%
rename from doc/source/roles/role-undercloud-cpu.rst
rename to doc/source/roles/role-undercloud_cpu.rst
index b335cb513..ec404226a 100644
--- a/doc/source/roles/role-undercloud-cpu.rst
+++ b/doc/source/roles/role-undercloud_cpu.rst
@@ -1,7 +1,7 @@
 ==============
-undercloud-cpu
+undercloud_cpu
 ==============
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-cpu
+   :role: roles/undercloud_cpu
 
diff --git a/doc/source/roles/role-pacemaker-status.rst b/doc/source/roles/role-undercloud_debug.rst
similarity index 54%
rename from doc/source/roles/role-pacemaker-status.rst
rename to doc/source/roles/role-undercloud_debug.rst
index 179f17912..028d7aa5b 100644
--- a/doc/source/roles/role-pacemaker-status.rst
+++ b/doc/source/roles/role-undercloud_debug.rst
@@ -1,7 +1,7 @@
 ================
-pacemaker-status
+undercloud_debug
 ================
 
 .. ansibleautoplugin::
-   :role: roles/pacemaker-status
+   :role: roles/undercloud_debug
 
diff --git a/doc/source/roles/role-undercloud-tokenflush.rst b/doc/source/roles/role-undercloud_disk_space.rst
similarity index 53%
rename from doc/source/roles/role-undercloud-tokenflush.rst
rename to doc/source/roles/role-undercloud_disk_space.rst
index f8f1f6f9f..82f0fa829 100644
--- a/doc/source/roles/role-undercloud-tokenflush.rst
+++ b/doc/source/roles/role-undercloud_disk_space.rst
@@ -1,7 +1,7 @@
 =====================
-undercloud-tokenflush
+undercloud_disk_space
 =====================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-tokenflush
+   :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
similarity index 52%
rename from doc/source/roles/role-undercloud-heat-purge-deleted.rst
rename to doc/source/roles/role-undercloud_heat_purge_deleted.rst
index 7c8084fa3..54eb53e21 100644
--- a/doc/source/roles/role-undercloud-heat-purge-deleted.rst
+++ b/doc/source/roles/role-undercloud_heat_purge_deleted.rst
@@ -1,7 +1,7 @@
 =============================
-undercloud-heat-purge-deleted
+undercloud_heat_purge_deleted
 =============================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-heat-purge-deleted
+   :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
similarity index 53%
rename from doc/source/roles/role-undercloud-process-count.rst
rename to doc/source/roles/role-undercloud_process_count.rst
index 94a61a982..914bfa695 100644
--- a/doc/source/roles/role-undercloud-process-count.rst
+++ b/doc/source/roles/role-undercloud_process_count.rst
@@ -1,7 +1,7 @@
 ========================
-undercloud-process-count
+undercloud_process_count
 ========================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-process-count
+   :role: roles/undercloud_process_count
 
diff --git a/doc/source/roles/role-undercloud_ram.rst b/doc/source/roles/role-undercloud_ram.rst
new file mode 100644
index 000000000..bf8ff89aa
--- /dev/null
+++ b/doc/source/roles/role-undercloud_ram.rst
@@ -0,0 +1,7 @@
+==============
+undercloud_ram
+==============
+
+.. ansibleautoplugin::
+   :role: roles/undercloud_ram
+
diff --git a/doc/source/roles/role-undercloud-selinux-mode.rst b/doc/source/roles/role-undercloud_selinux_mode.rst
similarity index 53%
rename from doc/source/roles/role-undercloud-selinux-mode.rst
rename to doc/source/roles/role-undercloud_selinux_mode.rst
index a42782c40..1d5a52163 100644
--- a/doc/source/roles/role-undercloud-selinux-mode.rst
+++ b/doc/source/roles/role-undercloud_selinux_mode.rst
@@ -1,7 +1,7 @@
 =======================
-undercloud-selinux-mode
+undercloud_selinux_mode
 =======================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-selinux-mode
+   :role: roles/undercloud_selinux_mode
 
diff --git a/doc/source/roles/role-undercloud-service-status.rst b/doc/source/roles/role-undercloud_service_status.rst
similarity index 53%
rename from doc/source/roles/role-undercloud-service-status.rst
rename to doc/source/roles/role-undercloud_service_status.rst
index a7f0b272f..626df2e1f 100644
--- a/doc/source/roles/role-undercloud-service-status.rst
+++ b/doc/source/roles/role-undercloud_service_status.rst
@@ -1,7 +1,7 @@
 =========================
-undercloud-service-status
+undercloud_service_status
 =========================
 
 .. ansibleautoplugin::
-   :role: roles/undercloud-service-status
+   :role: roles/undercloud_service_status
 
diff --git a/doc/source/roles/role-check-network-gateway.rst b/doc/source/roles/role-undercloud_tokenflush.rst
similarity index 52%
rename from doc/source/roles/role-check-network-gateway.rst
rename to doc/source/roles/role-undercloud_tokenflush.rst
index d9dbf86ee..c1142ed84 100644
--- a/doc/source/roles/role-check-network-gateway.rst
+++ b/doc/source/roles/role-undercloud_tokenflush.rst
@@ -1,7 +1,6 @@
 =====================
-check-network-gateway
+undercloud_tokenflush
 =====================
 
 .. ansibleautoplugin::
-   :role: roles/check-network-gateway
-
+   :role: roles/undercloud_tokenflush
diff --git a/doc/source/roles/role-container-status.rst b/doc/source/roles/role-validate_selinux.rst
similarity index 53%
rename from doc/source/roles/role-container-status.rst
rename to doc/source/roles/role-validate_selinux.rst
index 475c0ee55..6bc324250 100644
--- a/doc/source/roles/role-container-status.rst
+++ b/doc/source/roles/role-validate_selinux.rst
@@ -1,6 +1,6 @@
 ================
-container-status
+validate_selinux
 ================
 
 .. ansibleautoplugin::
-   :role: roles/container-status
+   :role: roles/validate_selinux
diff --git a/doc/source/roles/role-xfs-check-ftype.rst b/doc/source/roles/role-xfs_check_ftype.rst
similarity index 54%
rename from doc/source/roles/role-xfs-check-ftype.rst
rename to doc/source/roles/role-xfs_check_ftype.rst
index 212cf485c..841c0a8d4 100644
--- a/doc/source/roles/role-xfs-check-ftype.rst
+++ b/doc/source/roles/role-xfs_check_ftype.rst
@@ -1,8 +1,8 @@
 ===============
-xfs-check-ftype
+xfs_check_ftype
 ===============
 
 .. ansibleautoplugin::
-   :role: roles/xfs-check-ftype
+   :role: roles/xfs_check_ftype
 
 
diff --git a/tox.ini b/tox.ini
index b58516f3c..473e92be7 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,7 +5,6 @@ skipdist = True
 
 [testenv]
 usedevelop = True
-basepython = python3
 passenv = *
 setenv =
   ANSIBLE_CALLBACK_PLUGINS={toxinidir}/callback_plugins