e4b5dc3ea7
This patch adds the Cliff Sphinx Extension support for auto documenting the `validation` Command Line Interface. It also standardizes the `metavar` description for all the --group, --category and --product arguments by using <group_id>, <category_id> and <product_id>. Moreover, it removes usage example(s) in the arguments helpers which are often duplicated with the `metavar`. Change-Id: I3009337e8afadd705bbee5b89d9022c78093cdc8 Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com> |
||
|---|---|---|
| doc | ||
| dockerfiles/localvalidations | ||
| playbooks | ||
| releasenotes | ||
| validations_libs | ||
| .coveragerc | ||
| .dockerignore | ||
| .gitignore | ||
| .gitreview | ||
| .pre-commit-config.yaml | ||
| .reqcheck_override.yaml | ||
| .stestr.conf | ||
| .zuul.yaml | ||
| bindep.txt | ||
| CONTRIBUTING.rst | ||
| Dockerfile | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
| Vagrantfile.centos | ||
| Vagrantfile.ubuntu | ||
validations-libs
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.
- Free software: Apache_license
- Documentation: https://docs.openstack.org/validations-libs/latest/
- Source: https://opendev.org/openstack/validations-libs
- Bugs - Upstream: https://bugs.launchpad.net/tripleo/+bugs?field.tag=validations
- Bugs - Downstream: https://bugzilla.redhat.com/buglist.cgi?component=validations-libs&product=Red%20Hat%20OpenStack
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 upOnce 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/bashThen run validations:
validation.py run --validation check-ftype,512e --inventory /etc/ansible/hosts