zuul-jobs/roles/upload-artifactory
Ian Wienand f76cfbab11 linters: fix spaces between filters
This fixes a number of places where we do not have spaces between
filters.  I think that this is a reasonable rule for readability (I
also think it probably was enforced, but maybe later versions got
better at detecting it?).

These are detected by a later version of Ansible lint; this change
should have no operational change to any roles but prepares us to
update in a follow-on change.

Change-Id: I07e1a109b87adce86f483d14d7e02fcecb8313d5
2022-07-27 17:13:39 +10:00
..
tasks linters: fix spaces between filters 2022-07-27 17:13:39 +10:00
README.rst Switch docs theme to RTD 2021-12-16 06:48:49 -08:00

README.rst

Upload artifacts specified from the executor to artifactory.

Note

This role uses the src function of the uri module introduced in Ansible 2.7 therefore any ansible version lower than that is not supported.

Role Variables

Complex argument that contains the information about credentials, fqdn and name. This argument is expected to come from a secret.

User for authenticating.

Password for authenticating. Has a lower precedense than api_key.

API key for authenticating. Has a higher precedense than password.

Fully qualified domain name to the instance.

Dictionary of types of items to upload. Currently only supports artifacts.

Variable that contains a manifest of the artifacts that should be uploaded to a specific instance of artifactory. This is expected to be set during the build as a cached fact.

artifacts:
  - name: tarball
    src: artifact.tar.gz
    dest: /destination/to/put/artifact/artifact.tar.gz
    instance: artifact-server1
    headers:
      Content-Type: application/gzip

The attributes available on an artifact are the following.

Name of the artifact. This will be displayed in the build page.

Path relative to {{ zuul.executor.work_root }}/artifacts/.

Destination where the artifact should be put in.

Artifactory instance to place the artiface in, this is to choose which entry in :zuulupload-artifactory.upload_artifactory_instances to upload the artifact to.

Any headers that should be passed to ansibles uri module when uploading.

Properties to set in artifactory.

Properties can be either strings or lists of strings.

properties:
  property1: value1
  property2:
    - value2
    - value3

Any metadata that should be returned to Zuul together with the artifact link.