Use a Literal Block Scalar instead of Folding one for validation

Some validations have a long description and are displayed as it. Which
makes the Validator Show CLI output unreadable.

This patch replaces all the Folding Block Scalar by Literal ones in
order to get a better output.

Change-Id: Iea42706e07ea7bef598bdd26875050a47d95485d
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>

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).
 

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

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

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

playbooks/ceph-pg.yaml

@@ -3,17 +3,17 @@
   vars:
     metadata:
       name: Validate requested Ceph Placement Groups
-      description: >
+      description: |
-        In Ceph Lumionus and newer the Placement Group overdose protection
+        In Ceph Lumionus and newer the Placement Group overdose protection check
-        check (https://ceph.com/community/new-luminous-pg-overdose-protection)
+        (https://ceph.com/community/new-luminous-pg-overdose-protection) is
-        is executed by Ceph before a pool is created. If the check does not
+        executed by Ceph before a pool is created. If the check does not pass,
-        pass, then the pool is not created. When TripleO deploys Ceph it
+        then the pool is not created. When TripleO deploys Ceph it triggers
-        triggers ceph-ansible which creates the pools that OpenStack needs.
+        ceph-ansible which creates the pools that OpenStack needs.  This
-        This validation runs the same check that the overdose protection uses
+        validation runs the same check that the overdose protection uses to
-        to determine if the user should update their CephPools, PG count, or
+        determine if the user should update their CephPools, PG count, or number
-        number of OSD. Without this check a deployer may have to wait until
+        of OSD. Without this check a deployer may have to wait until after Ceph
-        after Ceph is running but before the pools are created to realize
+        is running but before the pools are created to realize the deployment
-        the deployment will fail.
+        will fail.
       groups:
         - pre-deployment
         - post-ceph

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:

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:

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:

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

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:

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

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:

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:

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.
 

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.
 

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

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

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

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

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.

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.
 

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

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:

playbooks/nova-event-callback.yaml

@@ -3,10 +3,11 @@
   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
@@ -15,6 +16,7 @@
           [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

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

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

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:

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

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

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:

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

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.

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:

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.

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

playbooks/system_encoding.yaml

@@ -3,7 +3,7 @@
   vars:
     metadata:
       name: System encoding
-      description: >-
+      description: |
         Ensure the local is unicode
       groups:
         - pre-deployment

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

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
 

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.
 

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.

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.
 

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

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

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.

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