redhat_cop.ah_configuration.ah_ee_image (0.9.2) — module

Install collection

Install with ansible-galaxy collection install redhat_cop.ah_configuration:==0.9.2

Add to requirements.yml

  collections:
    - name: redhat_cop.ah_configuration
      version: 0.9.2

Description

Delete execution environment images.

Update container image tags.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the image has the additional tags
  redhat_cop.ah_configuration.ah_ee_image:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8:2.0.0-15
    state: present
    tags:
      - v2
      - "2.0"
      - prod1
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Replace all the image tags
  redhat_cop.ah_configuration.ah_ee_image:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8:2.0.0-15
    state: present
    append: false
    tags:
      - prod2
      - "2.0"
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the image does not exist
  redhat_cop.ah_configuration.ah_ee_image:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8:2.0
    state: absent
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Inputs

    
name:
    description:
    - Name and tag of the image to remove or modify.
    - Use a colon character between the image name and the tag.
    required: true
    type: str

tags:
    description:
    - List of the image tags to update.
    - Only used when C(state) is set to C(present), otherwise ignored.
    elements: str
    type: list

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the image and all its tags.
    - If C(present), then the module updates the image tags.
    type: str

append:
    default: true
    description:
    - If C(yes), then add the tags specified in C(tags) to the image.
    - If C(no), then the module sets the image tags to the given list and removes all
      the other existing tags.
    type: bool

ah_host:
    aliases:
    - ah_hostname
    description:
    - URL to Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_HOST)
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

ah_password:
    description:
    - Password for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_PASSWORD)
    type: str

ah_username:
    description:
    - Username for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_USERNAME)
    type: str

ah_path_prefix:
    default: galaxy
    description:
    - API path used to access the api.
    - For galaxy_ng this is either 'automation-hub' or the custom prefix used on install
      with GALAXY_API_PATH_PREFIX
    - For Automation Hub this is 'galaxy'
    type: str

validate_certs:
    aliases:
    - ah_verify_ssl
    description:
    - Whether to allow insecure connections to Galaxy or Automation Hub Server.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    - If value not set, will try environment variable C(AH_VERIFY_SSL)
    type: bool