Deprecate all the `validations` directory contents

All the validation includes a task which warns the operator that
everything in this directory is deprecated and points them to the latest
official documentation.

Change-Id: I2d5ec11b3c71312970f5ab5b352c9b6e776e8647
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>

releasenotes/notes/validations-directory-deprecation-6ff07dae6f456743.yaml

@@ -0,0 +1,10 @@
+---
+deprecations:
+  - |
+    All the validations in the `validations` directory have been migrated into
+    their own Ansible roles from Stein release and will be removed from Train.
+
+    You can now run the validations from the `playbooks` directory. For more
+    information, please see:
+
+    https://docs.openstack.org/tripleo-validations/latest/readme.html#directory-structure

validations/512e.yaml

@@ -10,6 +10,7 @@
         - prep
         - pre-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - name: List the available drives
     register: drive_list
     command: "ls /sys/class/block/"

validations/ceilometerdb-size.yaml

@@ -15,6 +15,8 @@
     event_ttl_check: "event_time_to_live"
     panko_config_file: "/var/lib/config-data/puppet-generated/panko/etc/panko/panko.conf"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     become: true
     hiera:

validations/ceph-ansible-installed.yaml

@@ -9,6 +9,7 @@
         - pre-deployment
     fail_without_ceph_ansible: false
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - name: Check if ceph-ansible is installed
     shell: rpm -q ceph-ansible || true
     args:

validations/ceph-health.yaml

@@ -10,6 +10,7 @@
       groups:
         - post-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - name: Check if ceph_mon is deployed
     become: true
     shell: hiera -c /etc/puppet/hiera.yaml enabled_services | egrep -sq ceph_mon

validations/check-ftype.yaml

@@ -9,6 +9,7 @@
       groups:
         - pre-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - name: Check if there are XFS volumes with ftype=0
     become: true
     shell: |

validations/check-latest-minor-version.yaml

@@ -11,6 +11,7 @@
     packages:
       - python-tripleoclient
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - name: Get available updates for packages
     check_package_update:
       package: "{{ item }}"

validations/check-network-gateway.yaml

@@ -9,6 +9,8 @@
       groups:
         - pre-introspection
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     become: true
     hiera:

validations/collect-flavors-and-verify-profiles.yaml

@@ -10,6 +10,8 @@
       - pre-deployment
       - pre-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Collect and check the flavors
     check_flavors:
       roles_info: "{{ lookup('roles_info', wantlist=True) }}"

validations/containerized-undercloud-docker.yaml

@@ -101,4 +101,5 @@
       - zaqar
       - zaqar_websocket
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - include_tasks: tasks/containerized_services.yaml

validations/controller-token.yaml

@@ -10,6 +10,8 @@
       - post-deployment
     keystone_conf_file: "/var/lib/config-data/puppet-generated/keystone/etc/keystone/keystone.conf"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Fetch token value
     become: true
     ini:

validations/controller-ulimits.yaml

@@ -11,6 +11,8 @@
     nproc_min: 2048
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get nofiles limit
     become: true
     # NOTE: `ulimit` is a shell builtin so we have to invoke it like this:

validations/ctlplane-ip-range.yaml

@@ -10,6 +10,8 @@
         - pre-introspection
     ctlplane_iprange_min_size: 25
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     become: true
     hiera:

validations/default-node-count.yaml

@@ -9,6 +9,8 @@
       groups:
       - pre-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Retrieve the hypervisor statistics
     set_fact:
       statistics: "{{ lookup('nova_hypervisor_statistics', wantlist=True) }}"
@@ -47,4 +49,3 @@
         {{ available_count }} requests. Check that enough nodes are
         in 'available' state with maintenance mode off.
     failed_when: statistics.count < available_count|int
-

validations/deployment-images.yaml

@@ -13,6 +13,8 @@
     deploy_kernel_name: "bm-deploy-kernel"
     deploy_ramdisk_name: "bm-deploy-ramdisk"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Fetch deploy kernel by name
     set_fact:
       deploy_kernel_id: "{{ lookup('glance_images', 'name', ['{{ deploy_kernel_name }}'], wantlist=True) | map(attribute='id') | list }}"

validations/dhcp-introspection.yaml

@@ -14,6 +14,8 @@
         - pre-introspection
       ironic_inspector_conf: "/var/lib/config-data/puppet-generated/ironic_inspector/etc/ironic-inspector/inspector.conf"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Look up the introspection interface
     become: True
     ini:

validations/dhcp-provisioning.yaml

@@ -14,6 +14,8 @@
       groups:
         - pre-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     hiera: name="tripleo_undercloud_conf_file"
 

validations/dns.yaml

@@ -9,6 +9,8 @@
         - pre-deployment
     server_to_lookup: example.com
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Ensure DNS resolution works
     command: "getent hosts {{ server_to_lookup }}"
     changed_when: False

validations/haproxy.yaml

@@ -14,6 +14,8 @@
     defaults_timeout_server: '2m'
     defaults_timeout_check: '10s'
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Gather the HAProxy config
     become: true
     haproxy_conf:

validations/ironic-boot-configuration.yaml

@@ -11,6 +11,8 @@
     deploy_kernel_name: "bm-deploy-kernel"
     deploy_ramdisk_name: "bm-deploy-ramdisk"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get id for deploy kernel by name
     set_fact:
       deploy_kernel_id: "{{ lookup('glance_images', 'name', ['{{ deploy_kernel_name }}'], wantlist=True) | map(attribute='id') | join(', ') }}"

validations/mysql-open-files-limit.yaml

@@ -11,6 +11,8 @@
         - post-deployment
     min_open_files_limit: 16384
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Set container_cli fact from the inventory
     set_fact:
       container_cli: "{{ hostvars[inventory_hostname].container_cli }}"

validations/network-environment.yaml

@@ -18,6 +18,8 @@
     plan_env_path: plan-environment.yaml
     ip_pools_path: environments/ips-from-pool-all.yaml
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Validate the network environment files
     network_environment:
       netenv_path: "{{ network_environment_path }}"

validations/neutron-sanity-check.yaml

@@ -27,6 +27,8 @@
     - /etc/neutron/lbaas_agent.ini
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Run neutron-sanity-check
     command: "docker exec -u root neutron_ovs_agent /bin/bash -c 'neutron-sanity-check --config-file {{ item }}'"
     with_items: "{{ configs }}"

validations/no-op-firewall-nova-driver.yaml

@@ -9,6 +9,8 @@
       groups:
       - post-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Read the `firewall_driver` value
     become: true
     ini:

validations/node-disks.yaml

@@ -9,6 +9,8 @@
         - pre-deployment
       ironic_conf_file: "/var/lib/config-data/puppet-generated/ironic/etc/ironic/ironic.conf"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get Ironic Inspector swift auth_url
     become: true
     ini:

validations/node-health.yaml

@@ -9,6 +9,8 @@
       groups:
         - pre-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Collect IPs for overcloud nodes
     set_fact: ansible_host="{{ hostvars[item]['ansible_host'] }}"
     register: oc_ips

validations/nova-event-callback.yaml

@@ -26,6 +26,8 @@
     notify_nova_on_port_status_check: "notify_nova_on_port_status_changes"
     tenant_name_check: "tenant_name"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get VIF Plugging setting values from nova.conf
     become: True
     ini:

validations/ntpstat.yaml

@@ -11,6 +11,8 @@
       groups:
       - post-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Run ntpstat
     # ntpstat returns 0 if synchronised and non-zero otherwise:
     command: ntpstat

validations/openshift-hw-requirements.yaml

@@ -32,7 +32,7 @@
     resource_reqs_prod: False
 
   tasks:
-
+  - include_tasks: tasks/deprecation.yaml
   # Get auth token and service catalog from Keystone and extract service urls.
   - name: Get token and catalog from Keystone
     uri:

validations/openshift-nw-requirements.yaml

@@ -10,6 +10,8 @@
       - openshift-on-openstack
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Set fact to identify if the overcloud was deployed
     set_fact:
        overcloud_deployed: "{{ groups['overcloud'] is defined }}"

validations/openstack-endpoints.yaml

@@ -12,6 +12,8 @@
       - pre-upgrade
       - post-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Set fact to identify if the overcloud was deployed
     set_fact:
        overcloud_deployed: "{{ groups['overcloud'] is defined }}"

validations/ovs-dpdk-pmd-cpus-check.yaml

@@ -13,6 +13,8 @@
   become: true
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get OVS DPDK PMD cores mask value
     become_method: sudo
     register: pmd_cpu_mask

validations/pacemaker-status.yaml

@@ -12,6 +12,8 @@
       groups:
         - post-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Check pacemaker service is running
     become: True
     command: "/usr/bin/systemctl show pacemaker --property ActiveState"

validations/rabbitmq-limits.yaml

@@ -9,6 +9,8 @@
         - post-deployment
     min_fd_limit: 16384
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Set container_cli fact from the inventory
     set_fact:
       container_cli: "{{ hostvars[inventory_hostname].container_cli }}"

validations/repos.yaml

@@ -12,6 +12,8 @@
       groups:
         - pre-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: List repositories
     command: 'yum repolist -v'
     args:

validations/stack-health.yaml

@@ -10,6 +10,8 @@
         - pre-upgrade
         - post-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Check stack resource statuses
     assert:
       that:

validations/stonith-exists.yaml

@@ -11,6 +11,8 @@
       groups:
         - post-deployment
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Check if we are in HA cluster environment
     become: True
     register: pcs_cluster_status

validations/switch-vlans.yaml

@@ -15,6 +15,8 @@
     network_environment_path: environments/network-environment.yaml
     ironic_inspector_conf_file: "/var/lib/config-data/puppet-generated/ironic_inspector/etc/ironic-inspector/inspector.conf"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get Ironic Inspector swift auth_url
     become: true
     ini:

validations/tasks/deprecation.yaml

@@ -0,0 +1,12 @@
+---
+- name: Display Deprecation Warning
+  warn:
+    msg: >
+      [DEPRECATION WARNING] All the validations in the `validations` directory
+      have been migrated into their own Ansible roles from the Stein release and
+      will be removed from Train.
+
+      You can now run the validations from the `playbooks` directory. For more
+      information, please consult the latest tripleo-validations documentation:
+
+      https://docs.openstack.org/tripleo-validations/latest/readme.html#directory-structure

validations/undercloud-cpu.yaml

@@ -12,6 +12,8 @@
         - pre-introspection
     min_undercloud_cpu_count: 8
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Verify the number of CPU cores
     fail:
       msg: >-

validations/undercloud-debug.yaml

@@ -18,6 +18,8 @@
       - /var/lib/config-data/puppet-generated/heat/etc/heat/heat.conf
       - /var/lib/config-data/puppet-generated/ironic/etc/ironic/ironic.conf
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Check the services for debug flag
     become: True
     ini:

validations/undercloud-disk-space-pre-upgrade.yaml

@@ -17,4 +17,5 @@
       - {mount: /,                    min_size: 20}
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - include_tasks: tasks/disk_space.yaml

validations/undercloud-disk-space.yaml

@@ -20,4 +20,5 @@
       - {mount: /,                    min_size: 25}
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
   - include_tasks: tasks/disk_space.yaml

validations/undercloud-heat-purge-deleted.yaml

@@ -12,6 +12,8 @@
       - pre-deployment
     cron_check: "heat-manage purge_deleted"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     become: true
     hiera: name="tripleo_undercloud_conf_file"

validations/undercloud-neutron-sanity-check.yaml

@@ -28,6 +28,8 @@
     - /etc/neutron/lbaas_agent.ini
 
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Run neutron-sanity-check
     command: "docker exec -u root neutron_ovs_agent /bin/bash -c 'neutron-sanity-check --config-file {{ item }}'"
     with_items: "{{ configs }}"

validations/undercloud-process-count.yaml

@@ -12,6 +12,8 @@
         - pre-deployment
     max_process_count: 8
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     become: true
     hiera:

validations/undercloud-ram.yaml

@@ -13,6 +13,8 @@
         - pre-upgrade
     min_undercloud_ram_gb: 24
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Verify the RAM requirements
     fail:
       msg: >-

validations/undercloud-selinux-mode.yaml

@@ -9,6 +9,8 @@
         - prep
         - pre-introspection
   tasks:
+    - include_tasks: tasks/deprecation.yaml
+
     - name:  Get current SELinux mode
       command: getenforce
       become: true
@@ -32,4 +34,3 @@
       when:
         - "sestatus.stdout != 'Enforcing'"
         - "ansible_distribution == 'CentOS'"
-

validations/undercloud-service-status.yaml

@@ -9,6 +9,8 @@
         - post-upgrade
         - pre-upgrade
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Check Services are running
     command: "/usr/bin/systemctl show {{ item }} --property ActiveState"
     become: true

validations/undercloud-tokenflush.yaml

@@ -11,6 +11,8 @@
       - pre-introspection
     cron_check: "keystone-manage token_flush"
   tasks:
+  - include_tasks: tasks/deprecation.yaml
+
   - name: Get the path of tripleo undercloud config file
     become: true
     hiera: name="tripleo_undercloud_conf_file"