Gael Chamoulaud (Strider) a92c1d2170 Add validation-common documentation structure

The doc structure from validations-libs was transposed
and slightly altered.

Future expansion of documentation is expected.

Change-Id: Ib1043cf1bef5d9b858da8f9a83fbba52bb570b99
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
Signed-off-by: Jiri Podivin <jpodivin@redhat.com>

2021-02-15 14:58:05 +01:00

2.4 KiB

Raw Blame History

Validations-common

A collection of Ansible roles and playbooks to detect and report potential issues during deployments.

The validations will help detect issues early in the deployment process and prevent field engineers from wasting time on misconfiguration or hardware issues in their environments.

Free software: Apache_license
Documentation: https://docs.openstack.org/validations-common/latest/
Release notes: https://docs.openstack.org/releasenotes/validations-commons/
Source: https://opendev.org/openstack/validations-common
Bugs - Upstream: https://bugs.launchpad.net/tripleo/+bugs?field.tag=validations
Bugs - Downstream: https://bugzilla.redhat.com/buglist.cgi?component=validations-common&product=Red%20Hat%20OpenStack

Installation

Recommended process

There are several different ways to install validations-common. However it is recommended to both install and use the package inside python virtual environment.

At the command line using pip.

$ pip install validations-common

Or, if you have virtualenvwrapper installed.

$ mkvirtualenv validations-common
$ pip install validations-common

Installation with package manager

Alternativelly it is possible to install validations-common using package manager.

Such as yum...

$ yum install validations-common

or the more modern dnf.

$ dnf install validations-common

Usage

Once the validations-common project has been installed, navigate to the chosen share path, usually /usr/share/ansible to access the installed roles, playbooks, and libraries.

While the validations-common can be run by itself, it nonetheless depends on Ansible and validations-libs. Therefore it isn't recommended to use only validations-common.

The validations included with validations-common are intended to be demonstrations, capable of running on most setups. But they are not meant for production environment.