Files

Alex Schultz c8f6348079 Update docs around output variables

Per the comments in
https://review.opendev.org/#/c/702284/6/roles/tripleo-container-image-list/tasks/main.yml,
we should have a consistent result naming convention. I'm proposing that
we return the shell exection results always via
<underscored role name>_result. If there is output that a user might
want to use in ansible then we can also return the stdout via
<underscored role name>_output.

Change-Id: I5c0b95a7037eeca0f849fb24248a0ffd16dc82c0

2020-01-15 11:27:34 -07:00

defaults

Add container image push role

2020-01-14 16:00:33 -07:00

README.md

tripleo-container-image-push

A role to perform the container image push against a registry.

Requirements

None.

Role Variables

tripleo_container_image_push_append_tag: (String) Tag to append to the existing tag when pushing the container.
tripleo_container_image_push_become: (Boolean) Run the command as root. This needs to be true when uploading to the local undercloud registry. Default: true
tripleo_container_image_push_cleanup: (Boolean) Remove local copy of the image after uploading. Default: false
tripleo_container_image_push_debug: (Boolean) Flag to print out the push command. Default: False
tripleo_container_image_push_dry_run: (Boolean) Perform a dry run upload which will exercise the authentication process but not upload the container. Default: false
tripleo_container_image_push_image: (String) REQUIRED. Container image to upload. Should be in the form of //:tag. If the tag is not provided, 'latest' is used.
tripleo_container_image_push_local: (Boolean) Use this flag if teh container image is already on the current system and does not need to be pulled from a remote registry. Default: false
tripleo_container_image_push_multi_arch: (Boolean) Enable multi arch support for the upload. Default: false
tripleo_container_image_push_password: (String) Password for the registry
tripleo_container_image_push_registry_url: (String) URL of the destiantionr egistry in the form :.
tripleo_container_image_push_timeout: (Number) Amount of time to wait for the command to conplete. Default: 360
tripleo_container_image_push_username: (String) Username for the registry

Output Variables

tripleo_container_image_push_result: Ansible shell execution results

Dependencies

None.

Example Playbook

Example container push execution playbook

- hosts: undercloud
  gather_facts: true
  tasks:
    - name: Push a container
      import_role:
        name: tripleo-container-image-push
      vars:
        tripleo_container_image_push_image: docker.io/library/centos:7
    - name: Print output
      debug:
        var: tripleo_container_image_push_output

License

Apache-2.0