containers.podman.podman_login (1.12.1) — module

Install collection

Install with ansible-galaxy collection install containers.podman:==1.12.1

Add to requirements.yml

  collections:
    - name: containers.podman
      version: 1.12.1

Description

Login to a container registry server using the podman login command If the registry is not specified, the first registry under `[registries.search]` from `registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile` flag. The default path used is `${XDG_RUNTIME_DIR}/containers/auth.json`.

Requirements

• Podman installed on host

Usage examples

Scanned by Steampunk Spotter

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

- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
  containers.podman.podman_login:
    username: user
    password: 'p4ssw0rd'

Scanned by Steampunk Spotter

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

- name: Login to quay.io and create ${XDG_RUNTIME_DIR}/containers/auth.json
  containers.podman.podman_login:
    username: user
    password: 'p4ssw0rd'
    registry: quay.io

Inputs

    
certdir:
    description:
    - Use certificates at path (*.crt, *.cert, *.key) to connect to the registry.  Default
      certificates directory is /etc/containers/certs.d.
    type: path

authfile:
    description:
    - Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json``
      You can also override the default path of the authentication file by setting the
      ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``
    type: path

password:
    description:
    - Password for the registry server.
    required: true
    type: str

registry:
    description:
    - Registry server. If the registry is not specified, the first registry under `[registries.search]`
      from `registries.conf` will be used.
    type: str

username:
    description:
    - Username for the registry server.
    required: true
    type: str

tlsverify:
    description:
    - Require HTTPS and verify certificates when contacting registries.  If explicitly
      set to true, then TLS verification will be used. If set to false, then TLS verification
      will not be used.  If not specified, TLS verification will be used unless the target
      registry is listed as an insecure registry in registries.conf.
    type: bool

executable:
    default: podman
    description:
    - Path to C(podman) executable if it is not in the C($PATH) on the machine running
      C(podman)
    type: str