diff --git a/playbooks/ceilometerdb-size.yaml b/playbooks/ceilometerdb-size.yaml index 465bccdf0..6cbd67857 100644 --- a/playbooks/ceilometerdb-size.yaml +++ b/playbooks/ceilometerdb-size.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Events Database Size Check (DEPRECATED) - description: > + description: | The undercloud's events database can grow to a substantial size if event_time_to_live is set to a negative value (infinite limit). diff --git a/playbooks/ceph-ansible-installed.yaml b/playbooks/ceph-ansible-installed.yaml index a3d4620d4..c89cf318f 100644 --- a/playbooks/ceph-ansible-installed.yaml +++ b/playbooks/ceph-ansible-installed.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check if ceph-ansible is installed on the undercloud - description: > + description: | Prints a message if ceph-ansible isn't installed groups: - pre-deployment diff --git a/playbooks/ceph-dependencies-installed.yaml b/playbooks/ceph-dependencies-installed.yaml index efed781c2..647ccef95 100644 --- a/playbooks/ceph-dependencies-installed.yaml +++ b/playbooks/ceph-dependencies-installed.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check if Ceph dependencies are installed - description: > + description: | Prints a message if a ceph dependency is missed groups: - pre-deployment diff --git a/playbooks/ceph-health.yaml b/playbooks/ceph-health.yaml index 607e7ff3b..91d2a51ce 100644 --- a/playbooks/ceph-health.yaml +++ b/playbooks/ceph-health.yaml @@ -3,10 +3,9 @@ vars: metadata: name: Check the status of the ceph cluster - description: > + description: | Uses `ceph health` to check if cluster is in HEALTH_WARN state and prints a debug message. - groups: - post-deployment - post-ceph diff --git a/playbooks/ceph-pg.yaml b/playbooks/ceph-pg.yaml index 5c51cafc3..00ceb6179 100644 --- a/playbooks/ceph-pg.yaml +++ b/playbooks/ceph-pg.yaml @@ -3,17 +3,17 @@ vars: metadata: name: Validate requested Ceph Placement Groups - description: > - In Ceph Lumionus and newer the Placement Group overdose protection - check (https://ceph.com/community/new-luminous-pg-overdose-protection) - is executed by Ceph before a pool is created. If the check does not - pass, then the pool is not created. When TripleO deploys Ceph it - triggers ceph-ansible which creates the pools that OpenStack needs. - This validation runs the same check that the overdose protection uses - to determine if the user should update their CephPools, PG count, or - number of OSD. Without this check a deployer may have to wait until - after Ceph is running but before the pools are created to realize - the deployment will fail. + description: | + In Ceph Lumionus and newer the Placement Group overdose protection check + (https://ceph.com/community/new-luminous-pg-overdose-protection) is + executed by Ceph before a pool is created. If the check does not pass, + then the pool is not created. When TripleO deploys Ceph it triggers + ceph-ansible which creates the pools that OpenStack needs. This + validation runs the same check that the overdose protection uses to + determine if the user should update their CephPools, PG count, or number + of OSD. Without this check a deployer may have to wait until after Ceph + is running but before the pools are created to realize the deployment + will fail. groups: - pre-deployment - post-ceph diff --git a/playbooks/check-kernel-version.yaml b/playbooks/check-kernel-version.yaml index 7b808be14..3a68780b9 100644 --- a/playbooks/check-kernel-version.yaml +++ b/playbooks/check-kernel-version.yaml @@ -4,7 +4,7 @@ vars: metadata: name: Verify the kernel version contains el8 in its name - description: > + description: | This validation checks the kernel has been upgaded by checking el8 is in kernel (uname -r) version string groups: diff --git a/playbooks/check-network-gateway.yaml b/playbooks/check-network-gateway.yaml index 7029cfffe..7d78691fa 100644 --- a/playbooks/check-network-gateway.yaml +++ b/playbooks/check-network-gateway.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check network_gateway on the provisioning network - description: > + description: | If `gateway` in `undercloud.conf` is different from `local_ip`, verify that the gateway exists and is reachable. groups: diff --git a/playbooks/collect-flavors-and-verify-profiles.yaml b/playbooks/collect-flavors-and-verify-profiles.yaml index ae33218b8..a466211d3 100644 --- a/playbooks/collect-flavors-and-verify-profiles.yaml +++ b/playbooks/collect-flavors-and-verify-profiles.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Collect and verify role flavors - description: > + description: | This validation checks the flavors assigned to roles exist and have the correct capabilities set. groups: diff --git a/playbooks/container-status.yaml b/playbooks/container-status.yaml index 7ae061020..bbd262104 100644 --- a/playbooks/container-status.yaml +++ b/playbooks/container-status.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Ensure container status - description: > + description: | Detect failed containers and raise an error. groups: - pre-upgrade diff --git a/playbooks/controller-token.yaml b/playbooks/controller-token.yaml index 25161ccac..02985af7a 100644 --- a/playbooks/controller-token.yaml +++ b/playbooks/controller-token.yaml @@ -5,7 +5,7 @@ vars: metadata: name: Verify that keystone admin token is disabled - description: > + description: | This validation checks that keystone admin token is disabled on both undercloud and overcloud controller after deployment. groups: diff --git a/playbooks/controller-ulimits.yaml b/playbooks/controller-ulimits.yaml index d1c592d1a..3a8f3f157 100644 --- a/playbooks/controller-ulimits.yaml +++ b/playbooks/controller-ulimits.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check controller ulimits - description: > + description: | This will check the ulimits of each controller. groups: - post-deployment diff --git a/playbooks/ctlplane-ip-range.yaml b/playbooks/ctlplane-ip-range.yaml index 7dbf6234f..e5beb540a 100644 --- a/playbooks/ctlplane-ip-range.yaml +++ b/playbooks/ctlplane-ip-range.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check the number of IP addresses available for the overcloud nodes - description: > + description: | Verify that the number of IP addresses defined in `dhcp_start` and `dhcp_end` fields in `undercloud.conf` is not too low. groups: diff --git a/playbooks/default-node-count.yaml b/playbooks/default-node-count.yaml index d7be62d17..49a9d5d18 100644 --- a/playbooks/default-node-count.yaml +++ b/playbooks/default-node-count.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify hypervisor statistics - description: > + description: | This validation checks that the nodes and hypervisor statistics add up. groups: diff --git a/playbooks/dhcp-introspection.yaml b/playbooks/dhcp-introspection.yaml index 2eb994370..b7a2f678c 100644 --- a/playbooks/dhcp-introspection.yaml +++ b/playbooks/dhcp-introspection.yaml @@ -4,7 +4,7 @@ vars: metadata: name: DHCP on the Introspection Network - description: > + description: | An unexpected DHCP server on the network used for node introspection can cause some nodes to not be inspected. diff --git a/playbooks/dhcp-provisioning.yaml b/playbooks/dhcp-provisioning.yaml index 8a381a9ed..d4e9f13c9 100644 --- a/playbooks/dhcp-provisioning.yaml +++ b/playbooks/dhcp-provisioning.yaml @@ -4,7 +4,7 @@ vars: metadata: name: DHCP on the Provisioning Network - description: > + description: | An unexpected DHCP server on the provisioning network can cause problems with deploying the Ironic nodes. diff --git a/playbooks/healthcheck-service-status.yaml b/playbooks/healthcheck-service-status.yaml index 4516547b1..31ddc7fa5 100644 --- a/playbooks/healthcheck-service-status.yaml +++ b/playbooks/healthcheck-service-status.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Healthcheck systemd services Check - description: > + description: | Check for failed healthcheck systemd services. groups: - post-deployment diff --git a/playbooks/image-serve.yaml b/playbooks/image-serve.yaml index 77ac3a71d..a9adba569 100644 --- a/playbooks/image-serve.yaml +++ b/playbooks/image-serve.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify image-serve service is working and answering - description: > + description: | Ensures image-serve vhost is configured and httpd is running. groups: - pre-upgrade diff --git a/playbooks/ironic-boot-configuration.yaml b/playbooks/ironic-boot-configuration.yaml index 7835d912f..85d473427 100644 --- a/playbooks/ironic-boot-configuration.yaml +++ b/playbooks/ironic-boot-configuration.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check Ironic boot configuration - description: > + description: | Check if baremetal boot configuration is correct. groups: - pre-deployment diff --git a/playbooks/mysql-open-files-limit.yaml b/playbooks/mysql-open-files-limit.yaml index a815624ed..1db7fd167 100644 --- a/playbooks/mysql-open-files-limit.yaml +++ b/playbooks/mysql-open-files-limit.yaml @@ -5,7 +5,7 @@ vars: metadata: name: MySQL Open Files Limit - description: > + description: | Verify the `open-files-limit` configuration is high enough https://access.redhat.com/solutions/1598733 diff --git a/playbooks/network-environment.yaml b/playbooks/network-environment.yaml index 3b79d5725..92b093093 100644 --- a/playbooks/network-environment.yaml +++ b/playbooks/network-environment.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Validate the Heat environment file for network configuration - description: > + description: | This validates the network environment and nic-config files that specify the overcloud network configuration and are stored in the current plan's Swift container. diff --git a/playbooks/neutron-sanity-check.yaml b/playbooks/neutron-sanity-check.yaml index 5fe311fb9..344120478 100644 --- a/playbooks/neutron-sanity-check.yaml +++ b/playbooks/neutron-sanity-check.yaml @@ -4,7 +4,7 @@ vars: metadata: name: Neutron Sanity Check - description: > + description: | Run `neutron-sanity-check` on the controller nodes to find out potential issues with Neutron's configuration. diff --git a/playbooks/node-disks.yaml b/playbooks/node-disks.yaml index 58249990c..5848ff3b0 100644 --- a/playbooks/node-disks.yaml +++ b/playbooks/node-disks.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check node disk configuration - description: > + description: | Check node disk numbers and sizes and whether root device hints are set. groups: - pre-deployment diff --git a/playbooks/node-health.yaml b/playbooks/node-health.yaml index 48acdbd6d..8737d4300 100644 --- a/playbooks/node-health.yaml +++ b/playbooks/node-health.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Node health check - description: > + description: | Check if all overcloud nodes can be connected to before starting a scale-up or an upgrade. groups: diff --git a/playbooks/nova-event-callback.yaml b/playbooks/nova-event-callback.yaml index e188beaf5..c6ff04b89 100644 --- a/playbooks/nova-event-callback.yaml +++ b/playbooks/nova-event-callback.yaml @@ -3,18 +3,20 @@ vars: metadata: name: Nova Event Callback Configuration Check - description: > + description: | This validations verifies that the Nova Event Callback feature is configured which is generally enabled by default. It checks the following files on the Overcloud Controller(s): - - /etc/nova/nova.conf: - [DEFAULT]/vif_plugging_is_fatal = True - [DEFAULT]/vif_plugging_timeout >= 300 - - /etc/neutron/neutron.conf: - [nova]/auth_url = 'http://nova_admin_auth_ip:5000' - [nova]/tenant_name = 'service' - [DEFAULT]/notify_nova_on_port_data_changes = True - [DEFAULT]/notify_nova_on_port_status_changes = True + + - /etc/nova/nova.conf: + [DEFAULT]/vif_plugging_is_fatal = True + [DEFAULT]/vif_plugging_timeout >= 300 + - /etc/neutron/neutron.conf: + [nova]/auth_url = 'http://nova_admin_auth_ip:5000' + [nova]/tenant_name = 'service' + [DEFAULT]/notify_nova_on_port_data_changes = True + [DEFAULT]/notify_nova_on_port_status_changes = True + groups: - post-deployment nova_config_file: /var/lib/config-data/puppet-generated/nova/etc/nova/nova.conf diff --git a/playbooks/nova-status.yaml b/playbooks/nova-status.yaml index 188d0442c..b16b37541 100644 --- a/playbooks/nova-status.yaml +++ b/playbooks/nova-status.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Nova Status Upgrade Check - description: > + description: | Performs a release-specific readiness check before restarting services with new code. This command expects to have complete configuration and access to databases and services within a cell. For example, this check may query the diff --git a/playbooks/nova-svirt.yaml b/playbooks/nova-svirt.yaml index 27f281911..ba860ca65 100644 --- a/playbooks/nova-svirt.yaml +++ b/playbooks/nova-svirt.yaml @@ -4,7 +4,7 @@ vars: metadata: name: Check nova sVirt support - description: >- + description: | Ensures all running VM are correctly protected with sVirt groups: - post-deployment diff --git a/playbooks/openstack-endpoints.yaml b/playbooks/openstack-endpoints.yaml index 148f7cf3b..a3280ab1d 100644 --- a/playbooks/openstack-endpoints.yaml +++ b/playbooks/openstack-endpoints.yaml @@ -4,7 +4,7 @@ metadata: name: Check connectivity to various OpenStack services # TODO: this could also check for undercloud endpoints - description: > + description: | This validation gets the PublicVip address from the deployment and tries to access Horizon and get a Keystone token. groups: diff --git a/playbooks/ovs-dpdk-pmd-cpus-check.yaml b/playbooks/ovs-dpdk-pmd-cpus-check.yaml index 770ac23bc..7dfedb1fc 100644 --- a/playbooks/ovs-dpdk-pmd-cpus-check.yaml +++ b/playbooks/ovs-dpdk-pmd-cpus-check.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Validates OVS DPDK PMD cores from all NUMA nodes. - description: > + description: | OVS DPDK PMD cpus must be provided from all NUMA nodes. A failed status post-deployment indicates PMD CPU list is not diff --git a/playbooks/pacemaker-status.yaml b/playbooks/pacemaker-status.yaml index b0e84efa6..8e83304b1 100644 --- a/playbooks/pacemaker-status.yaml +++ b/playbooks/pacemaker-status.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check the status of the pacemaker cluster - description: > + description: | This runs `pcs status` and checks for any failed actions. A failed status post-deployment indicates something is not configured diff --git a/playbooks/package-version.yaml b/playbooks/package-version.yaml index c6d8dfac8..d1f547c93 100644 --- a/playbooks/package-version.yaml +++ b/playbooks/package-version.yaml @@ -3,7 +3,7 @@ vars: metadata: name: package-version - description: >- + description: | Ensures we can access the wanted package version. Especially useful when you are switching repositories, for instance during an upgrade. groups: diff --git a/playbooks/rabbitmq-limits.yaml b/playbooks/rabbitmq-limits.yaml index 74b90d10b..49c617f2e 100644 --- a/playbooks/rabbitmq-limits.yaml +++ b/playbooks/rabbitmq-limits.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Rabbitmq limits - description: > + description: | Make sure the rabbitmq file descriptor limits are set to reasonable values. groups: - post-deployment diff --git a/playbooks/repos.yaml b/playbooks/repos.yaml index ecf34e722..5e413a4af 100644 --- a/playbooks/repos.yaml +++ b/playbooks/repos.yaml @@ -4,7 +4,7 @@ vars: metadata: name: Check correctness of current repositories - description: > + description: | Detect whether the repositories listed in `yum repolist` can be connected to and that there is at least one repo configured. diff --git a/playbooks/stack-health.yaml b/playbooks/stack-health.yaml index 4f393fff4..0796668af 100644 --- a/playbooks/stack-health.yaml +++ b/playbooks/stack-health.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Stack Health Check - description: > + description: | Check if all stack resources are in a 'COMPLETE' state before starting an upgrade. groups: diff --git a/playbooks/stonith-exists.yaml b/playbooks/stonith-exists.yaml index 7cd1278b4..436518ea8 100644 --- a/playbooks/stonith-exists.yaml +++ b/playbooks/stonith-exists.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Validate stonith devices - description: > + description: | Verify that stonith devices are configured for your OpenStack Platform HA cluster. We don't configure stonith device with TripleO Installer. Because the hardware configuration may be differ in each environment and requires different fence agents. diff --git a/playbooks/switch-vlans.yaml b/playbooks/switch-vlans.yaml index ff113d671..142fe0926 100644 --- a/playbooks/switch-vlans.yaml +++ b/playbooks/switch-vlans.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Compare switch port VLANs to VLANs in nic config - description: > + description: | LLDP data received during introspection contains the configured VLANs for each switch port attached to the nodes interfaces. Compare the VLAN IDs set on the switch port to those configured in nic config diff --git a/playbooks/system_encoding.yaml b/playbooks/system_encoding.yaml index e99cbd831..2770d2487 100644 --- a/playbooks/system_encoding.yaml +++ b/playbooks/system_encoding.yaml @@ -3,7 +3,7 @@ vars: metadata: name: System encoding - description: >- + description: | Ensure the local is unicode groups: - pre-deployment diff --git a/playbooks/undercloud-debug.yaml b/playbooks/undercloud-debug.yaml index 6325a18b8..7d500a18a 100644 --- a/playbooks/undercloud-debug.yaml +++ b/playbooks/undercloud-debug.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Undercloud Services Debug Check - description: > + description: | The undercloud's openstack services should _not_ have debug enabled. This will check if debug is enabled on undercloud services. If debug is enabled, the root filesystem can fill up quickly, and diff --git a/playbooks/undercloud-disk-space-pre-upgrade.yaml b/playbooks/undercloud-disk-space-pre-upgrade.yaml index aff6eb435..f7bc08b59 100644 --- a/playbooks/undercloud-disk-space-pre-upgrade.yaml +++ b/playbooks/undercloud-disk-space-pre-upgrade.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify undercloud fits the disk space requirements to perform an upgrade - description: > + description: | Make sure that the root partition on the undercloud node has enough free space before starting an upgrade diff --git a/playbooks/undercloud-disk-space.yaml b/playbooks/undercloud-disk-space.yaml index 092f9e18b..fba4640bb 100644 --- a/playbooks/undercloud-disk-space.yaml +++ b/playbooks/undercloud-disk-space.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify undercloud fits the disk space requirements - description: > + description: | Make sure that the root partition on the undercloud node has enough free space. diff --git a/playbooks/undercloud-heat-purge-deleted.yaml b/playbooks/undercloud-heat-purge-deleted.yaml index dddf7302c..fbad0f601 100644 --- a/playbooks/undercloud-heat-purge-deleted.yaml +++ b/playbooks/undercloud-heat-purge-deleted.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify heat-manage purge_deleted is enabled in crontab - description: > + description: | Without a purge_deleted crontab enabled, the heat database can grow very large. This validation checks that the purge_deleted crontab has been set up. diff --git a/playbooks/undercloud-neutron-sanity-check.yaml b/playbooks/undercloud-neutron-sanity-check.yaml index 01265073e..4a02c776b 100644 --- a/playbooks/undercloud-neutron-sanity-check.yaml +++ b/playbooks/undercloud-neutron-sanity-check.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Undercloud Neutron Sanity Check - description: > + description: | Run `neutron-sanity-check` on the undercloud node to find out potential issues with Neutron's configuration. diff --git a/playbooks/undercloud-process-count.yaml b/playbooks/undercloud-process-count.yaml index fb79b44ba..77f5227a6 100644 --- a/playbooks/undercloud-process-count.yaml +++ b/playbooks/undercloud-process-count.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Check the number of OpenStack processes on undercloud - description: > + description: | The default settings for OpenStack is to run one process (heat-engine, keystone, etc.) per CPU core. On a machine with a lot of cores this is both unnecessary and can consume a significant amount of RAM, leading diff --git a/playbooks/undercloud-service-status.yaml b/playbooks/undercloud-service-status.yaml index 227dd32a0..9920d2be0 100644 --- a/playbooks/undercloud-service-status.yaml +++ b/playbooks/undercloud-service-status.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify undercloud services state before running update or upgrade - description: > + description: | Check undercloud status before running a stack update - especially minor update and major upgrade. groups: - post-upgrade diff --git a/playbooks/undercloud-tokenflush.yaml b/playbooks/undercloud-tokenflush.yaml index 2490352d3..ecc4924d3 100644 --- a/playbooks/undercloud-tokenflush.yaml +++ b/playbooks/undercloud-tokenflush.yaml @@ -3,7 +3,7 @@ vars: metadata: name: Verify token_flush is enabled in keystone users crontab - description: > + description: | Without a token_flush crontab enabled for the keystone user, the keystone database can grow very large. This validation checks that the keystone token_flush crontab has been set up. diff --git a/role-addition.yml b/role-addition.yml index cad142f2a..fa18c18c4 100644 --- a/role-addition.yml +++ b/role-addition.yml @@ -107,7 +107,7 @@ vars: metadata: name: The Validation name goes here - description: >- + description: | Write a description of your validations groups: - no-op