RETIRED, A collection of generic ansible playbooks for the Validation Framework
Go to file
David J Peacock ec6bfcb7b8 add pre-update and pre-upgrade groups to ntp playbook
It's important to add NTP to pre-upgrade and pre-update groups to ensure
NTP presence and synchronization prior to these important functions.

Recent events have highlighted the necessity of this.

Change-Id: I5bcd45b766d94adf4e7c0e8a6e0f83d5d3c23b25
2022-01-10 11:15:13 -05:00
.config/molecule Remove workaround for tox-ansible and global molecule config 2021-05-17 09:34:32 +02:00
doc Dependency reorganization 2021-09-10 12:58:18 +02:00
playbooks Update validations for Ansible 2.11 2021-09-10 10:59:12 +00:00
releasenotes Fix pygments style 2020-06-24 11:58:39 +08:00
roles Create clients component for CI Validations Jobs 2021-11-30 09:03:52 +00: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 File validation extended to callback_plugins, main loop optimized 2021-05-17 15:29:27 +02:00
validations_common add pre-update and pre-upgrade groups to ntp playbook 2022-01-10 11:15:13 -05:00
.ansible-lint Update validations for Ansible 2.11 2021-09-10 10:59:12 +00:00
.coveragerc Cover report omits test files 2021-04-06 15:34:18 +02:00
.dockerignore Adds dockerignore to the repo 2021-05-20 05:01:28 +00: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 Update validations for Ansible 2.11 2021-09-10 10:59:12 +00:00
.reqcheck_override.yaml Reqcheck job for upstream validations-common 2021-05-19 15:20:08 +02:00
.stestr.conf Make the measuring code coverage test working 2021-02-08 13:25:46 +01:00
.yamllint Enabling indentation rule for yamllint. 2021-06-11 10:56:30 +02:00
.zuul.yaml reqcheck job is now voting 2021-07-07 12:49:25 +02:00
ansible-collections-requirements.yml Update validations for Ansible 2.11 2021-09-10 10:59:12 +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 Add missing font for PDF generation 2021-07-26 16:36:42 +02:00
CONTRIBUTING.rst Reorganize CONTRIBUTING information 2021-06-23 16:29:48 +02: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
molecule-requirements.txt Update validations for Ansible 2.11 2021-09-10 10:59:12 +00:00
README.rst Reorganize CONTRIBUTING information 2021-06-23 16:29:48 +02:00
requirements.txt Licences are now listed for all requirements. 2021-05-20 09:33:32 +00:00
setup.cfg Removing lookup_plugins data file directive 2021-07-02 13:12:31 +02:00
setup.py Fix pbr installation issues 2020-03-05 10:44:48 +01:00
test-requirements.txt Update validations for Ansible 2.11 2021-09-10 10:59:12 +00:00
tox.ini Use py3 as the default runtime for tox 2021-10-15 08:43:30 +02:00

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.

$ python3 -m pip install validations-common

Or, if you have virtualenvwrapper installed.

$ mkvirtualenv validations-common
$ python3 -m pip install validations-common

Installation with package manager

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

Such as yum or dnf...

$ yum|dnf 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.

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.