collect standalone deployment config
puppet config, config-download, and rendered roles and playbooks are stored in undercloud-ansible-* in standalone deployments. Change-Id: Ic09fd9fe604014a6177947fa5e3924ce30f58ec9
|4 days ago|
|defaults||4 days ago|
|docs||2 weeks ago|
|files||1 month ago|
|library||1 month ago|
|meta||1 month ago|
|scripts||1 month ago|
|tasks||2 weeks ago|
|templates||1 month ago|
|zuul.d||1 week ago|
|.ansible-lint||1 month ago|
|.gitignore||1 month ago|
|.gitreview||4 weeks ago|
|.pre-commit-config.yaml||1 month ago|
|.yamllint||1 month ago|
|LICENSE||1 month ago|
|README.rst||1 month ago|
|ansible.cfg||1 month ago|
|requirements.txt||1 month ago|
|setup.cfg||2 weeks ago|
|setup.py||1 month ago|
|test-requirements.txt||1 month ago|
|tox.ini||3 weeks ago|
An Ansible role for aggregating logs from different nodes.
This role gathers logs and debug information from a target system and collates them in a designated directory,
artcl_collect_dir, on the localhost.
Additionally, the role will convert templated bash scripts, created and used by TripleO-Quickstart during deployment, into rST files. These rST files are combined with static rST files and fed into Sphinx to create user friendly post-build-documentation specific to an original deployment.
Finally, the role optionally handles uploading these logs to a rsync server or to an OpenStack Swift object storage. Logs from Swift can be exposed with os-loganalyze.
artcl_collect_list– A list of files and directories to gather from the target. Directories are collected recursively and need to end with a “/” to get collected. Should be specified as a YaML list, e.g.:
artcl_collect_list_append– A list of files and directories to be appended in the default list. This is useful for users that want to keep the original list and just add more relevant paths.
artcl_exclude_list– A list of files and directories to exclude from collecting. This list is passed to rsync as an exclude filter and it takes precedence over the collection list. For details see the “FILTER RULES” topic in the rsync man page.
artcl_collect_dir– A local directory where the logs should be gathered, without a trailing slash.
artcl_gzip_only: false/true – When true, gathered files are gzipped one by one in
artcl_collect_dir, when false, a tar.gz file will contain all the logs.
artcl_gen_docs: false/true – If true, the role will use build artifacts and Sphinx and produce user friendly documentation (default: false)
artcl_docs_source_dir– a local directory that serves as the Sphinx source directory.
artcl_docs_build_dir– A local directory that serves as the Sphinx build output directory.
artcl_create_docs_payload– Dictionary of lists that direct what and how to construct documentation.
included_deployment_scripts– List of templated bash scripts to be converted to rST files.
included_deployment_scripts– List of static rST files that will be included in the output documentation.
table_of_contents– List that defines the order in which rST files will be laid out in the output documentation.
artcl_verify_sphinx_build– false/true – If true, verify items defined in
artcl_create_docs_payload.table_of_contentsexist in sphinx generated index.html (default: false)
artcl_publish: true/false – If true, the role will attempt to rsync logs to the target specified by
BUILD_TAGvars from the environment (set during a Jenkins job run) and requires the next to variables to be set.
artcl_txt_rename: false/true – rename text based file to end in .txt.gz to make upstream log servers display them in the browser instead of offering them to download
artcl_publish_timeout: the maximum seconds the role can spend uploading the logs, the default is 1800 (30 minutes)
artcl_use_rsync: false/true – use rsync to upload the logs
artcl_rsync_use_daemon: false/true – use rsync daemon instead of ssh to connect
artcl_rsync_url– rsync target for uploading the logs. The localhost needs to have passwordless authentication to the target or the
PROVISIONER_KEYVar specificed in the environment.
artcl_use_swift: false/true – use swift object storage to publish the logs
artcl_swift_auth_url– the OpenStack auth URL for Swift
artcl_swift_username– OpenStack username for Swift
artcl_swift_password– password for the Swift user
artcl_swift_tenant_name– OpenStack tenant name for Swift
artcl_swift_container– the name of the Swift container to use, default is
artcl_swift_delete_after– The number of seconds after which Swift will remove the uploaded objects, the default is 2678400 seconds = 31 days.
artcl_artifact_url– a HTTP URL at which the uploaded logs will be accessible after upload.
artcl_collect_sosreport– true/false – If true, create and collect a sosreport for each host.
Templated bash scripts used during deployment are converted to rST files during the
create-docs portion of the role’s call. Shell scripts are fed into an awk script and output as restructured text. The awk script has several simple rules:
### ---stop_docswill be parsed.
# nodocwill be excluded.
## ::indicate subsequent lines should be formatted as code blocks
## <anything else>will have the prepended
##removed. This is how and where general rST formatting is added.
sosreport is a unified tool for collecting system logs and other debug information. To enable creation of sosreport(s) with this role, create a custom config (you can use centosci-logs.yml as a template) and ensure that
artcl_collect_sosreport: true is set.