herve4m.quay.quay_proxy_cache (1.2.0) — module

Install collection

Install with ansible-galaxy collection install herve4m.quay:==1.2.0

Add to requirements.yml

  collections:
    - name: herve4m.quay
      version: 1.2.0

Description

Create, delete, and update the proxy cache configuration in organizations.

Usage examples

Scanned by Steampunk Spotter

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

- name: Ensure proxy cache is enabled in the production organization
  herve4m.quay.quay_proxy_cache:
    organization: production
    registry: quay.io/prodimgs
    username: cwade
    password: My53cr3Tpa55
    expiration: 172800
    state: present
    quay_host: https://quay.example.com
    quay_token: vgfH9zH5q6eV16Con7SvDQYSr0KPYQimMHVehZv7

Scanned by Steampunk Spotter

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

- name: Ensure proxy cache is disabled in the production organization
  herve4m.quay.quay_proxy_cache:
    organization: production
    state: absent
    quay_host: https://quay.example.com
    quay_token: vgfH9zH5q6eV16Con7SvDQYSr0KPYQimMHVehZv7

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module removes the proxy cache configuration.
    - The module does not fail if the proxy cache configuration does not exist, because
      the state is already as expected.
    - If C(present), then the module creates the proxy cache configuration.
    - If a proxy cache configuration already exists, then the module deletes it first.
    type: str

insecure:
    default: false
    description:
    - Whether to allow insecure connections to the remote registry.
    - If C(yes), then the module does not validate SSL certificates.
    type: bool

password:
    description:
    - User's password as a clear string.
    - Do not set a password for a public access to the remote registry.
    type: str

registry:
    default: quay.io
    description:
    - Name of the remote registry.
    - Add a namespace to the remote registry to restrict caching images from that namespace.
    type: str

username:
    description:
    - Name of the user account to use for authenticating with the remote registry.
    - Do not set a username for a public access to the remote registry.
    type: str

quay_host:
    default: http://127.0.0.1
    description:
    - URL for accessing the API. U(https://quay.example.com:8443) for example.
    - If you do not set the parameter, then the module uses the C(QUAY_HOST) environment
      variable.
    - If you do no set the environment variable either, then the module uses the U(http://127.0.0.1)
      URL.
    type: str

expiration:
    default: 86400
    description:
    - Tag expiration in seconds for cached images.
    - 86400 (one day) by default.
    type: int

quay_token:
    description:
    - OAuth access token for authenticating against the API.
    - If you do not set the parameter, then the module tries the C(QUAY_TOKEN) environment
      variable.
    - Mutually exclusive with I(quay_username) and I(quay_password).
    type: str

organization:
    description:
    - Name of the organization in which to create the proxy cache configuration. That
      organization must exist.
    required: true
    type: str

quay_password:
    description:
    - The password to use for authenticating against the API.
    - If you do not set the parameter, then the module tries the C(QUAY_PASSWORD) environment
      variable.
    - If you set I(quay_password), then you also need to set I(quay_username).
    - Mutually exclusive with I(quay_token).
    type: str

quay_username:
    description:
    - The username to use for authenticating against the API.
    - If you do not set the parameter, then the module tries the C(QUAY_USERNAME) environment
      variable.
    - If you set I(quay_username), then you also need to set I(quay_password).
    - Mutually exclusive with I(quay_token).
    type: str

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description:
    - Whether to allow insecure connections to the API.
    - If C(no), then the module does not validate SSL certificates.
    - If you do not set the parameter, then the module tries the C(QUAY_VERIFY_SSL) environment
      variable (C(yes), C(1), and C(True) mean yes, and C(no), C(0), C(False), and no
      value mean no).
    type: bool