Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.65 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.65 KB

Common role

The common role is used to manage log file found on the system that can help with debugging playbooks that include the analysis or upgrade roles.

This role also implements a mutex locking mechanism that protects against accidentally running simultaneous playbook jobs on the same host.

Additionally this role can be used to set common variables used by both analysis and upgrade.

This is a common role included by the analysis and upgrade roles. It does not need to be explicitly included in your playbook.

Requirements

Define job_name in the import as seen below

Role variables

Name Type Optional Default value Description
job_name String No None The string describes the job run
log_directory DirPath Yes "/var/log/ripu" Directory under which local log files will be written. This directory will be created is it is not already present
log_file FilePath Yes "{{ log_directory }}/ripu.log" Local log filename. When a playbook job finishes, a timestamp suffix is appended to the end of the specified filename

Logging

Logs will accumulate in the directory referenced by logfile, with a suffixed datestamp upon completion.

If a log file exists during execution of this role (without suffixed datestamp), execution will terminate as there is an analysis job running already.

Logs will not survive a rollback. They need to be removed off the system prior to a snapshot revert.

Authors

Bob Mader, Scott Vick, Mike Savage, Jeffrey Cutter, David Danielsson

License

MIT