A collection of generic ansible playbooks for the Validation Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Zuul 81ec82fd4c Merge "Artifacts directory path is now set in a variable" 3 months ago
.config/molecule Add shared configuration for all molecule test 3 months ago
doc Docs are now built in pdf 5 months ago
playbooks Add shared configuration for all molecule test 3 months ago
releasenotes Fix pygments style 1 year ago
roles Artifacts directory path is now set in a variable 3 months ago
scripts [Testing Infra] Apply here the improvements done to tripleo-validations 4 months ago
tests [Testing Infra] Apply here the improvements done to tripleo-validations 4 months ago
tools Add external http logging callback 6 months ago
validations_common Merge "Disabling strict mode for ConfigParser in read_ini" 3 months ago
.ansible-lint Remove RoleNames ansible-lint custom rule 3 months ago
.coveragerc Cover report omits test files 4 months ago
.gitignore .gitignore now excludes JSON molecule logs 4 months ago
.gitreview Migrate molecule jobs from centos 7 to 8 1 year ago
.pre-commit-config.yaml Remove RoleNames ansible-lint custom rule 3 months ago
.stestr.conf Make the measuring code coverage test working 6 months ago
.yamllint Move Ansible components to validations_common directory 1 year ago
.zuul.yaml Merge "Update validations role to be used by tripleo CI and devstack tests" 3 months ago
CONTRIBUTING.rst Add validation-common documentation structure 5 months ago
LICENSE Add License File 1 year ago
MANIFEST.in Initialization of validations-common 1 year ago
README.rst Re-add documentation for http_json callback 4 months ago
ansible-test-env.rc [Testing Infra] Apply here the improvements done to tripleo-validations 4 months ago
bindep.txt [Testing Infra] Apply here the improvements done to tripleo-validations 4 months ago
molecule-requirements.txt [Testing Infra] Apply here the improvements done to tripleo-validations 4 months ago
requirements.txt Fix lower-constraints errors for validations-common 11 months ago
setup.cfg Merge "Use new CLI for functionnal tests and remove validation.py script" 3 months ago
setup.py Fix pbr installation issues 1 year ago
test-requirements.txt Tests for validation.py module and helper classes 4 months ago
tox.ini Add shared configuration for all molecule test 3 months ago

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.