zuul-jobs/roles/upload-logs-s3
Ian Wienand af3f79121a
linter: Use capitals for names
This is pretty trivial, but consistency is probably better in this
regard and it does guide you to writing a sentence that is human
parsable, which is the point of it.

Change-Id: Iaab9bb6aec0ad0f1d3cae10364c1f1b37d02801e
2022-11-07 10:37:53 +11:00
..
defaults Add configuration to make logs public 2020-12-21 18:12:25 +01:00
meta Merge upload logs modules into common role 2020-09-25 13:21:12 +02:00
tasks linter: Use capitals for names 2022-11-07 10:37:53 +11:00
README.rst Revert "Update upload-logs roles to support endpoint override" 2021-02-19 09:08:24 -08:00

Upload logs to S3

Before using this role, create at least one bucket and set up appropriate access controls or lifecycle events. This role will not automatically create buckets.

This role requires the boto3 Python package to be installed in the Ansible environment on the Zuul executor.

Role Variables

This role will not create buckets which do not already exist. If partitioning is not enabled, this is the name of the bucket which will be used. If partitioning is enabled, then this will be used as the prefix for the bucket name which will be separated from the partition name by an underscore. For example, "logs_42" would be the bucket name for partition 42.

Note that you will want to set this to a value that uniquely identifies your Zuul installation.

AWS access key to use.

AWS secret key for the AWS access key.

The endpoint to use when uploading logs to an s3 compatible service. By default this will be automatically constructed by boto but should be set when working with non-aws hosted s3 service.