RETIRED, A collection of python libraries for the Validation Framework
Go to file
Jiri Podivin 7d416acbe8 Default value of the constructor parameter
The default value of the validation_path parameter
is now handled properly, without unnecessary conditional.

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: I4cc16732ea9d98ec47c2dc616105944bdd6106f0
2021-10-08 14:18:19 +02:00
doc Add validation config file mechanism 2021-08-20 08:12:16 +00:00
dockerfiles/localvalidations Docker image refinement and preparation for future development. 2021-02-12 12:48:00 +01:00
playbooks fix var name in logging statement 2021-07-07 07:51:37 +02:00
releasenotes Moving doc structure closer to that in validations-commons. 2021-02-25 13:11:34 +01:00
validations_libs Default value of the constructor parameter 2021-10-08 14:18:19 +02:00
.coveragerc Make the measuring code coverage test working 2020-12-11 10:23:15 +01:00
.dockerignore Docker image refinement and preparation for future development. 2021-02-12 12:48:00 +01:00
.gitignore Make the measuring code coverage test working 2020-12-11 10:23:15 +01:00
.gitreview Improve the way we log on the file system 2020-03-11 17:07:56 +01:00
.pre-commit-config.yaml Bump pre-commit repositories 2021-05-05 15:56:39 +02:00
.reqcheck_override.yaml Reqcheck job for upstream validations-libs 2021-05-20 17:22:20 +02:00
.stestr.conf Make the measuring code coverage test working 2020-12-11 10:23:15 +01:00
.zuul.yaml Triggering the 'tripleo-ci-centos-8-undercloud-containers' 2021-07-30 13:40:58 +02:00
CONTRIBUTING.rst Moving doc structure closer to that in validations-commons. 2021-02-25 13:11:34 +01:00
Dockerfile Docker image refinement and preparation for future development. 2021-02-12 12:48:00 +01:00
LICENSE Initial commit 2020-02-28 10:42:18 +01:00
MANIFEST.in Adding the foundation files 2020-02-28 14:47:28 +01:00
README.rst Expose skip list mechanism via the CLI 2021-10-06 13:45:08 +00:00
Vagrantfile.centos improve vagrant functionality 2021-07-13 09:34:05 -04:00
Vagrantfile.ubuntu improve vagrant functionality 2021-07-13 09:34:05 -04:00
bindep.txt Add missing font for PDF generation 2021-07-26 23:08:29 +09:00
requirements.txt Filling license info for Ansible and Pyflakes 2021-06-15 11:56:54 +02:00
setup.cfg Add validation config file mechanism 2021-08-20 08:12:16 +00:00
setup.py Adding the foundation files 2020-02-28 14:47:28 +01:00
skiplist-example.yaml Expose skip list mechanism via the CLI 2021-10-06 13:45:08 +00:00
test-requirements.txt Filling license info for Ansible and Pyflakes 2021-06-15 11:56:54 +02:00
tox.ini Setting language for the python3.6 tox environment 2021-08-19 08:36:32 +00:00
validation.cfg Add validation config file mechanism 2021-08-20 08:12:16 +00:00

README.rst

validations-libs

image

A collection of python libraries for the Validation Framework

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.

Development Environment Setup

Vagrantfiles for CentOS and Ubuntu have been provided for convenience; simply copy one into your desired location and rename to Vagrantfile, then run:

vagrant up

Once complete you will have a clean development environment ready to go for working with Validation Framework.

podman Quickstart

A Dockerfile is provided at the root of the Validations Library project in order to quickly set and hack the Validation Framework, on a equivalent of a single machine. Build the container from the Dockerfile by running:

podman build -t "vf:dockerfile" .

From the validations-libs repo directory.

Note

More complex images are available in the dockerfiles directory and require explicit specification of both build context and the Dockerfile.

Since the podman build uses code sourced from the buildah project to build container images. It is also possible to build an image using:

buildah bud -t "vf:dockerfile" .

Then you can run the container and start to run some builtin Validations:

podman run -ti vf:dockerfile /bin/bash

Then run validations:

validation.py run --validation check-ftype,512e --inventory /etc/ansible/hosts

Skip list

You can provide a file with a list of Validations to skip via the run command:

validation.py run --validation check-ftype,512e --inventory /etc/ansible/hosts --skiplist my-skip-list.yaml

This file should be formed as:

validation-name:
  hosts: targeted_hostname
  reason: reason to ignore the file
  lp: bug number

The framework will skip the validation against the hosts key. In order to skip the validation on every hosts, you can set all value such as:

hosts: all

If no hosts key is provided for a given validation, it will be considered as hosts: all.

Note

The reason and lp key are for tracking and documentation purposes, the framework won't use those keys.