redhat_cop.ah_configuration.ah_ee_registry (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 remote registries.

Grant group access to repositories.

Usage examples

Scanned by Steampunk Spotter

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

- name: Add a remote registry to AH
  redhat_cop.ah_configuration.ah_ee_registry:
    name: my_quayio
    state: present
    url: https://quay.io/my/registry
    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 registry which requires auth to AH
  redhat_cop.ah_configuration.ah_ee_registry:
    name: my_quayio_auth
    state: present
    url: https://quay.io/my/registry
    username: myuser
    password: mypassword
    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: Remove a remote registry from AH
  redhat_cop.ah_configuration.ah_ee_registry:
    name: examplehub
    state: absent
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Inputs

    
url:
    description:
    - The URL of the remote registry
    required: true
    type: str

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

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the registry.
    - The module does not fail if the registry does not exist because the state is already
      as expected.
    - If C(present), then the module updates the description and README file for the registry.
    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

ca_cert:
    description:
    - A PEM encoded CA certificate used for authentication.
    - Mutually exclusive with C(ca_cert_path)
    type: str

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

password:
    description:
    - The password to authenticate to the registry with

username:
    description:
    - The username to authenticate to the registry with

proxy_url:
    description:
    - Proxy URL to use for the connection
    type: str

client_key:
    description:
    - A PEM encoded private key file used for authentication.
    - Mutually exclusive with C(client_key_path)
    type: str

rate_limit:
    description:
    - Limits total download rate in requests per second.
    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

client_cert:
    description:
    - A PEM encoded client certificate used for authentication.
    - Mutually exclusive with C(client_cert_path)
    type: str

ca_cert_path:
    description:
    - Path to a PEM encoded CA certificate used for authentication.
    - Mutually exclusive with C(ca_cert)
    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

proxy_password:
    description:
    - Proxy URL to use for the connection

proxy_username:
    description:
    - Proxy URL to use for the connection
    type: str

tls_validation:
    description:
    - Whether to validate TLS when connecting to the remote registry

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

client_key_path:
    description:
    - Path to a PEM encoded private key file used for authentication.
    - Mutually exclusive with C(client_key)
    type: str

client_cert_path:
    description:
    - Path to a PEM encoded client certificate used for authentication.
    - Mutually exclusive with C(client_cert)
    type: str

download_concurrency:
    description:
    - Number of concurrent collections to download.
    type: str