herve4m.quay.quay_team (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 teams in organizations.

Usage examples

Scanned by Steampunk Spotter

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

- name: Ensure team operators exists in the production organization
  herve4m.quay.quay_team:
    name: operators
    organization: production
    description: |
        # Operation Team

        * Operators can create repositories
        * Operators can store their images in those repositories
    role: creator
    members:
      - lvasquez
      - dwilde
      - production+automationrobot
    append: false
    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 team developers does not exist in the production organization
  herve4m.quay.quay_team:
    name: developers
    organization: production
    state: absent
    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 team administrators has no members
  herve4m.quay.quay_team:
    name: administrators
    organization: production
    members: []
    append: false
    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 team operators has additional members
  herve4m.quay.quay_team:
    name: operators
    organization: production
    members:
      - jziglar
      - chorwitz
    append: true
    state: present
    quay_host: https://quay.example.com
    quay_token: vgfH9zH5q6eV16Con7SvDQYSr0KPYQimMHVehZv7

Inputs

    
name:
    description:
    - Name of the team to create, remove, or modify.
    - The name must be in lowercase, must not contain white spaces, must not start by
      a digit, and must be at least two characters long.
    required: true
    type: str

role:
    choices:
    - member
    - creator
    - admin
    description:
    - Role of the team within the organization. If not set, then the new team has the
      C(member) role.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the team.
    - The module does not fail if the team does not exist, because the state is already
      as expected.
    - If C(present), then the module creates the team if it does not already exist.
    - If the team already exists, then the module updates its state.
    type: str

append:
    default: true
    description:
    - If C(yes), then add the users specified in I(members) to the team.
    - If C(no), then the module sets the team members to users specified in I(members),
      removing all others users from the team.
    type: bool

members:
    description:
    - List of the user or robot accounts in the team. Use the syntax C(organization)+C(robotshortname)
      for robot accounts.
    - If the team is synchronized with an LDAP group (see the M(herve4m.quay.quay_team_ldap)
      module), then you can only add or remove robot accounts.
    elements: str
    type: list

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

description:
    description:
    - Text in Markdown format that describes the team.
    type: str

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