RETIRED, A collection of generic ansible playbooks for the Validation Framework
Go to file
Zuul e054debf84 Merge "Cover report omits test files" 2021-04-07 11:06:32 +00:00
.ansible-lint_rules Add RoleNames ansible-lint rule 2020-03-06 11:32:14 +01:00
doc Docs are now built in pdf 2021-03-03 14:21:09 +01:00
playbooks [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
releasenotes Fix pygments style 2020-06-24 11:58:39 +08:00
roles Add default value for validation.py inventory 2020-12-02 14:17:25 +01:00
scripts [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
tests [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
tools Add external http logging callback 2021-01-28 09:28:52 +01:00
validations_common [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
.ansible-lint Add RoleNames ansible-lint rule 2020-03-06 11:32:14 +01:00
.coveragerc Cover report omits test files 2021-04-06 15:34:18 +02:00
.gitignore .gitignore now excludes JSON molecule logs 2021-03-31 08:38:40 +02:00
.gitreview Migrate molecule jobs from centos 7 to 8 2020-03-13 12:23:25 +01:00
.pre-commit-config.yaml Initialization of validations-common 2020-03-04 15:54:39 +01:00
.stestr.conf Make the measuring code coverage test working 2021-02-08 13:25:46 +01:00
.yamllint Move Ansible components to validations_common directory 2020-03-05 14:53:02 +01:00
.zuul.yaml Add validation-common documentation structure 2021-02-15 14:58:05 +01:00
CONTRIBUTING.rst Add validation-common documentation structure 2021-02-15 14:58:05 +01:00
LICENSE Add License File 2020-03-10 15:41:26 +01:00
MANIFEST.in Initialization of validations-common 2020-03-04 15:54:39 +01:00
README.rst Re-add documentation for http_json callback 2021-03-31 14:06:58 +00:00
ansible-test-env.rc [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
bindep.txt [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
molecule-requirements.txt [Testing Infra] Apply here the improvements done to tripleo-validations 2021-04-01 10:16:07 +02:00
requirements.txt Fix lower-constraints errors for validations-common 2020-09-11 22:26:10 +02:00
setup.cfg Add validation-common documentation structure 2021-02-15 14:58:05 +01:00
setup.py Fix pbr installation issues 2020-03-05 10:44:48 +01:00
test-requirements.txt Remove workaround for broken dogpile.cache and lower-constraints file 2020-12-09 09:58:18 +01:00
tox.ini Merge "Cover report omits test files" 2021-04-07 11:06:32 +00:00

README.rst

Validations-common

image

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.

Installation

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.

$ pip install validations-common

Or, if you have virtualenvwrapper installed.

$ mkvirtualenv validations-common
$ pip install validations-common

Installation with package manager

Alternativelly it is possible to install validations-common using package manager.

Such as yum...

$ yum install validations-common

or the more modern dnf.

$ dnf install validations-common

Usage

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.

The validations included with validations-common are intended to be demonstrations, capable of running on most setups. But they are not meant for production environment.

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=8989

The callback will post JSON log to the URL provided. This repository has a simple HTTP server for testing purpose under:

tools/http_server.py

The default host and port are localhost and 8989, feel free to adjust those values to your needs.