redhat_cop.ah_configuration.ah_ee_repository (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

Update and delete execution environment repositories (also known as containers).

Grant group access to repositories.

Usage examples

Scanned by Steampunk Spotter

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

- name: Ensure the repository description and README are set
  redhat_cop.ah_configuration.ah_ee_repository:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8
    state: present
    description: Supported execution environment
    readme: |
      # My execution environment

      * bullet 1
      * bullet 2
    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 repository README is set
  redhat_cop.ah_configuration.ah_ee_repository:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8
    state: present
    readme_file: README.md
    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 repository has the new name
  redhat_cop.ah_configuration.ah_ee_repository:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8
    new_name: aap-20/supported
    delete_namespace_if_empty: false
    state: present
    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 repository is removed
  redhat_cop.ah_configuration.ah_ee_repository:
    name: ansible-automation-platform-20-early-access/ee-supported-rhel8
    state: absent
    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: Add a remote repository from quayio registry
  redhat_cop.ah_configuration.ah_ee_repository:
    name: myrepo
    upstream_name: repo
    registry: quayio
    include_tags:
      - latest
      - 0.0.1
    state: present
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Inputs

    
name:
    description:
    - Name of the repository to remove or modify.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the repository.
    - The module does not fail if the repository does not exist because the state is already
      as expected.
    - If C(present), then the module sets the description and README file for the repository.
    type: str

readme:
    description:
    - README text in Markdown format for the repository.
    - Mutually exclusive with the C(readme_file) option.
    type: str

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

new_name:
    description:
    - New name for the repository. Setting this option changes the name of the repository
      which current name is set in C(name).
    type: str

registry:
    description:
    - The remote registry that the repository belongs in.
    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

description:
    description:
    - Text that describes the repository.
    type: str

readme_file:
    description:
    - Path to a README file in Markdown format to associate with the repository.
    - Mutually exclusive with the C(readme) option.
    type: path

exclude_tags:
    description:
    - The tags to avoid pulling in.
    elements: str
    type: list

include_tags:
    description:
    - The tags to pull in.
    elements: str
    type: list

upstream_name:
    description:
    - The name of the image upstream.
    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

delete_namespace_if_empty:
    default: true
    description:
    - If C(true), then the module deletes the original namespace if it is empty after
      the repository has been deleted or moved.
    - If C(false), then the module keeps the namespace even if it is empty.
    - Use C(false) when you plan to re-use the namespace and you want to preserve its
      parameters, such as the group permissions.
    - Only used when C(new_name) is set or C(state) is C(absent).
    type: bool