About Group¶
For now, the validations are grouped by the deployment stage they should be run on. A validation can belong to multiple groups.
Adding a new group¶
To add a new group, you will need to edit the groups.yaml
file located in
the root of the TripleO Validations directory:
...
pre-update:
- description: >-
Validations which try to validate your OpenStack deployment before you
update it.
...
And a new entry in the sphinx documentation index doc/source/index.rst
:
Existing validations
====================
.. toctree::
:maxdepth: 2
validations-no-op-details
validations-prep-details
validations-pre-introspection-details
validations-pre-deployment-details
validations-post-deployment-details
...
Group list¶
Here is a list of groups and their associated validations.
Backup-and-restore:
Validations which should be run to validate your OpenStack deployment before you backup it and after restore it.
ceph-health: Check the status of the ceph cluster
container-status: Ensure container status
healthcheck-service-status: Healthcheck systemd services Check
image-serve: Verify image-serve service is working and answering
neutron-sanity-check: Neutron Sanity Check
nova-status: Nova Status Upgrade Check
pacemaker-status: Check the status of the pacemaker cluster
undercloud-proxy-validation: Verify proxy variables are properly set
undercloud-service-status: Verify undercloud services state before running update or upgrade
No-op:
Validations which will run a no-op operation to verify that the workflow is working as it supposed to, it will run in both the Undercloud and Overcloud Nodes.
Openshift-on-openstack:
Validations which will check that the environment meets the requirements to be able to deploy OpenShift on OpenStack.
openshift-hw-requirements: Check resources for an OpenShift on OpenStack deployment
openshift-nw-requirements: Check network requirements for an OpenShift on OpenStack deployment
Post-ceph:
Validations to run on overcloud after deploying OpenStack with Ceph.
ceph-health: Check the status of the ceph cluster
Post-deployment:
Validations which should be executed after the Overcloud deployment has finished.
ceph-health: Check the status of the ceph cluster
check-kernel-version: Verify the kernel version contains el8 in its name
check-manila-policy-file: Verify that keystone admin token is disabled
container-status: Ensure container status
controller-token: Verify that keystone admin token is disabled
controller-ulimits: Check controller ulimits
fips-enabled: Confirm that undercloud has fips enabled
frr-status: FRR Daemons Status Check
healthcheck-service-status: Healthcheck systemd services Check
image-serve: Verify image-serve service is working and answering
mysql-open-files-limit: MySQL Open Files Limit
neutron-sanity-check: Neutron Sanity Check
nfv-ovsdpdk-zero-packet-loss-check: NFV OvS DPDK Zero Packet Loss Validations
nova-event-callback: Nova Event Callback Configuration Check
nova-svirt: Check nova sVirt support
openstack-endpoints: Check connectivity to various OpenStack services
oslo-config-validator: Openstack services configuration validation
overcloud-service-status: Verify overcloud services state after running a deployment or an update
ovs-dpdk-pmd-cpus-check: Validates OVS DPDK PMD cores from all NUMA nodes.
pacemaker-status: Check the status of the pacemaker cluster
rabbitmq-limits: Rabbitmq limits
stonith-exists: Validate stonith devices
tls-everywhere-post-deployment: Confirm that overcloud nodes are setup correctly
tripleo-haproxy: TripleO HAProxy configuration
Post-overcloud-converge:
Validations which verify that the overcloud is in a correct state after running overcloud upgrade converge command.
overcloud-service-status: Verify overcloud services state after running a deployment or an update
Post-overcloud-prepare:
Validations which verify that the overcloud is in a correct state after running overcloud upgrade prepare step.
Post-overcloud-upgrade:
Validations which verify that the overcloud is in a correct state before running overcloud upgrade run command.
overcloud-service-status: Verify overcloud services state after running a deployment or an update
Post-system-upgrade:
Validations which verify that the operating system upgrade went fine in the target node.
oslo-config-validator: Openstack services configuration validation
Post-undercloud-upgrade:
Validations which verify that the undercloud is in a correct state after upgrading.
Post-update:
Validations which should be run to validate your OpenStack deployment after you update it.
check-reboot: Verify if a reboot is necessary with yum-utils
openstack-endpoints: Check connectivity to various OpenStack services
oslo-config-validator: Openstack services configuration validation
undercloud-disabled-services: Verify undercloud services state before running update or upgrade
undercloud-proxy-validation: Verify proxy variables are properly set
undercloud-service-status: Verify undercloud services state before running update or upgrade
Post-upgrade:
Validations which try to validate your OpenStack deployment after you upgrade it.
check-reboot: Verify if a reboot is necessary with yum-utils
container-status: Ensure container status
image-serve: Verify image-serve service is working and answering
nova-svirt: Check nova sVirt support
openstack-endpoints: Check connectivity to various OpenStack services
oslo-config-validator: Openstack services configuration validation
overcloud-service-status: Verify overcloud services state after running a deployment or an update
stack-health: Stack Health Check
undercloud-disabled-services: Verify undercloud services state before running update or upgrade
undercloud-proxy-validation: Verify proxy variables are properly set
undercloud-service-status: Verify undercloud services state before running update or upgrade
Pre-ceph:
Validations to run on undercloud before deploying OpenStack with Ceph.
ceph-dependencies-installed: Check if Ceph dependencies are installed
package-version: package-version
Pre-deployment:
Validations which should be executed before **openstack overcloud deploy*.*
ceph-dependencies-installed: Check if Ceph dependencies are installed
check-ntp-reachability: Check if the NTP pool is reachable for the time synchronization
default-node-count: Verify hypervisor statistics
dhcp-provisioning: DHCP on the Provisioning Network
ironic-boot-configuration: Check Ironic boot configuration
network-environment: Validate the Heat environment file for network configuration
node-disks: Check node disk configuration
package-version: package-version
switch-vlans: Compare switch port VLANs to VLANs in nic config
system-encoding: System encoding
tls-everywhere-pre-deployment: Confirm undercloud is setup correctly prior to overcloud deploy
undercloud-debug: Undercloud Services Debug Check
undercloud-process-count: Check the number of OpenStack processes on undercloud
Pre-introspection:
Validations which should be run before the nodes introspection using Ironic Inspector.
check-network-gateway: Check network_gateway on the provisioning network
ctlplane-ip-range: Check the number of IP addresses available for the overcloud nodes
dhcp-introspection: DHCP on the Introspection Network
undercloud-disk-space: Verify undercloud fits the disk space requirements
undercloud-neutron-sanity-check: Undercloud Neutron Sanity Check
Pre-overcloud-converge:
Set of validations that check the right content for the templates passed to the overcloud upgrad converge step.
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
package-version: package-version
Pre-overcloud-prepare:
Set of validations that check the right content for the templates passed to the overcloud upgrade prepare step.
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
package-version: package-version
Pre-overcloud-upgrade:
Validations which verify that the overcloud is in a correct state before running overcloud upgrade run command.
check-rhsm-version: Verify that the RSHM version configured is the right one
check-uc-hostname: Check DockerInsecureRegistryAddress parameter points to correct UC hostname
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
package-version: package-version
Pre-system-upgrade:
Validations which verify that the operating system can be upgraded in the target node
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
package-version: package-version
Pre-undercloud-upgrade:
Validations which verify that the undercloud is in a correct state before upgrading.
check-rhsm-version: Verify that the RSHM version configured is the right one
check-undercloud-conf: Verify undercloud.conf correctness
package-version: package-version
Pre-update:
Validations which should be run to validate your OpenStack deployment before you update it.
check-for-dangling-images: Check for podman dangling images
check-reboot: Verify if a reboot is necessary with yum-utils
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
container-status: Ensure container status
openstack-endpoints: Check connectivity to various OpenStack services
package-version: package-version
repos: Check correctness of current repositories
system-encoding: System encoding
undercloud-disabled-services: Verify undercloud services state before running update or upgrade
undercloud-ipa-server-check: Verify that the IPA server has the right permissions and ACI
undercloud-proxy-validation: Verify proxy variables are properly set
undercloud-service-status: Verify undercloud services state before running update or upgrade
undercloud-sysctl: Verify undercloud sysctl option availability
validate-passwords-file: Check Undercloud passwords file
Pre-update-converge:
Validations which should be run to verfiy containers and services are ready for pre-deployment.
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
Pre-update-prepare:
Validations which should be run to verify undercloud updated correctly.
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
Pre-update-run:
Validations which should be run to verify image and registration of the overcloud nodes.
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
Pre-upgrade:
Validations which try to validate your OpenStack deployment before you upgrade it.
check-reboot: Verify if a reboot is necessary with yum-utils
collect-flavors-and-verify-profiles: Collect and verify role flavors
compute-tsx: RHEL8.x kernel flag for Compute nodes validation
container-status: Ensure container status
image-serve: Verify image-serve service is working and answering
ironic-boot-configuration: Check Ironic boot configuration
node-health: Node health check
nova-status: Nova Status Upgrade Check
openstack-endpoints: Check connectivity to various OpenStack services
package-version: package-version
repos: Check correctness of current repositories
stack-health: Stack Health Check
system-encoding: System encoding
tripleo-latest-packages-version: Check if latest version of TripleO packages is installed
undercloud-disabled-services: Verify undercloud services state before running update or upgrade
undercloud-disk-space-pre-upgrade: Verify undercloud fits the disk space requirements to perform an upgrade
undercloud-ipa-server-check: Verify that the IPA server has the right permissions and ACI
undercloud-proxy-validation: Verify proxy variables are properly set
undercloud-service-status: Verify undercloud services state before running update or upgrade
undercloud-sysctl: Verify undercloud sysctl option availability
validate-passwords-file: Check Undercloud passwords file
Prep:
Validations check the hardware configuration of the Undercloud node and should be run before **openstack undercloud install*.*
check-undercloud-conf: Verify undercloud.conf correctness
fips-enabled: Confirm that undercloud has fips enabled
package-version: package-version
tls-everywhere-prep: Confirm that undercloud is setup to register to IdM
undercloud-disk-space: Verify undercloud fits the disk space requirements
undercloud-sysctl: Verify undercloud sysctl option availability
validate-passwords-file: Check Undercloud passwords file