RETIRED, A collection of python libraries for the Validation Framework
Go to file
Gael Chamoulaud (Strider) 3928305329 Add Categories metadata key management
This patch adds the management of the new `categories` metadata key in
the validation playbooks. We can now filter the validations by their
groups and/or by their categories while listing or running them.

The `list` sub command has now a new --category argument. When filtering
by groups and by categories (see the example below), the `list` sub
command will return all the validation playbooks belonging to the prep
group OR all the validation playbooks belonging to the os and/or system
categories:

$ validation list -h
$ validation list --group prep --category os,system

The `run` sub command has also its new --category argument. Note that
this new argument is mutually exclusive with the --validation and
--group arguments:

$ validation run -h
$ validation run --category networking --inventory /etc/ansible/hosts

The `show parameter` sub command has the same new argument which is also
mutually exclusive with the --validation and --group arguments:

$ validation show parameter -h
$ validation show parameter --category os,system,hardware,ram

Change-Id: I4297f83355bdd209d21518fbadb17d1343fd4680
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
2021-07-27 07:00:47 +00:00
doc Update Validations Framework IRC channels 2021-06-04 10:00:53 +02: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 Add Categories metadata key management 2021-07-27 07:00:47 +00: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 Build containers in gate - to match check 2021-07-23 14:58:58 -04: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 Moving doc structure closer to that in validations-commons. 2021-02-25 13:11:34 +01: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 setup.cfg: Replace dashes with underscores 2021-05-08 15:37:41 +08:00
setup.py Adding the foundation files 2020-02-28 14:47:28 +01:00
test-requirements.txt Filling license info for Ansible and Pyflakes 2021-06-15 11:56:54 +02:00
tox.ini Correct the tox option for skipping sdist generation 2021-06-17 17:15:17 +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