4a7a3c940f
This patch moves all the contributing information from doc/source/contributing.rst to CONTRIBUTING.rst file. It also removes the installation.rst because we have the same content in the readme.rst. Change-Id: I87f992918e6db67d8182a1bcc3ba2637f922bcf5 Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
3.1 KiB
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.
$ python3 -m pip install validations-commonOr, if you have virtualenvwrapper installed.
$ mkvirtualenv validations-common
$ python3 -m pip install validations-commonInstallation with package manager
Alternatively it is possible to install validations-common using package manager.
Such as yum or dnf...
$ yum|dnf install validations-commonor the more modern dnf.
$ dnf install validations-commonUsage
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.
Validations Callbacks
http_json callback
The callback http_json sends Validations logs and information to an HTTP server as a JSON format in order to get caught and analysed with external tools for log parsing (as Fluentd or others).
This callback inherits from validation_json the format of the logging remains the same as the other logger that the Validation Framework is using by default.
To enable this callback, you need to add it to the callback whitelist. Then you need to export your http server url and port:
export HTTP_JSON_SERVER=http://localhost
export HTTP_JSON_PORT=8989The callback will post JSON log to the URL provided. This repository has a simple HTTP server for testing purpose under:
tools/http_server.pyThe default host and port are localhost and 8989, feel free to adjust those values to your needs.