validations-libs/README.rst
Jiri Podivin bcd6d6e857 Moving doc structure closer to that in validations-commons.
After merge of 723586 anyway.

Specific changes include:
new readme.rst in doc structure
tox adjustment
license info
bugtracking and source links
date update
badges
CONTRIBUTING.rst
ansible_autodoc.py
release notes infrastructure

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: Ia3db253e05d0f8d754259ff841a783f29cd6a70f
2021-02-25 13:11:34 +01:00

2.2 KiB

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