herve4m.quay.quay_quota (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 storage quota for organizations.

Usage examples

Scanned by Steampunk Spotter

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

- name: Ensure the organization has a 1.5 TiB quota with 80% and 95% limits
  herve4m.quay.quay_quota:
    organization: production
    quota: 1.5 TiB
    warning_pct: 80
    reject_pct: 95
    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 the production organization has no warning limit
  herve4m.quay.quay_quota:
    organization: production
    warning_pct: 0
    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 the production organization has no quota
  herve4m.quay.quay_quota:
    organization: production
    state: absent
    quay_host: https://quay.example.com
    quay_token: vgfH9zH5q6eV16Con7SvDQYSr0KPYQimMHVehZv7

Inputs

    
quota:
    description:
    - Quota that Quay uses to compute the warning and reject limits for the organization.
    - You specify a quota in bytes, but you can also use the K[i]B, M[i]B, G[i]B, or T[i]B
      suffixes.
    required: false
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the quota and limits for the given organization.
    - If C(present), then the module establishes the quota and limits for the given organization.
    - If quota and limits are already set, then the module updates them.
    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

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

reject_pct:
    description:
    - Reject (hard) limit as a percentage of the quota.
    - Quay terminates any image push in the organization when the limit is reached.
    - Set I(reject_pct) to C(0) to remove the reject limit.
    required: false
    type: int

warning_pct:
    description:
    - Warning (soft) limit as a percentage of the quota.
    - Quay notifies the users when the limit is reached.
    - Set I(warning_pct) to C(0) to remove the warning limit.
    required: false
    type: int

organization:
    description:
    - Name of the organization. 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