/ home / community / community.general / 1.3.14 / module / docker_image_info

community.general.docker_image_info (1.3.14) — module

Inspect docker images

Authors: Chris Houseknecht (@chouseknecht)

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Provide one or more image names, and the module will inspect each, returning an array of inspection results.

If an image does not exist locally, it will not appear in the results. If you want to check whether an image exists locally, you can call the module with the image name, then check whether the result list is empty (image does not exist) or has one element (the image exists locally).

The module will not attempt to pull images from registries. Use M(community.general.docker_image) with I(source) set to C(pull) to ensure an image is pulled.

Requirements

Docker API >= 1.20
Docker SDK for Python: Please note that the L(docker-py,https://pypi.org/project/docker-py/) Python module has been superseded by L(docker,https://pypi.org/project/docker/) (see L(here,https://github.com/docker/docker-py/issues/1310) for details). For Python 2.6, C(docker-py) must be used. Otherwise, it is recommended to install the C(docker) Python module. Note that both modules should *not* be installed at the same time. Also note that when both modules are installed and one of them is uninstalled, the other might no longer function and a reinstall of it is required.
L(Docker SDK for Python,https://docker-py.readthedocs.io/en/stable/) >= 1.8.0 (use L(docker-py,https://pypi.org/project/docker-py/) for Python 2.6)

Usage examples

Scanned by Steampunk Spotter

- name: Inspect a single image
  community.general.docker_image_info:
    name: pacur/centos-7

Scanned by Steampunk Spotter

- name: Inspect multiple images
  community.general.docker_image_info:
    name:
      - pacur/centos-7
      - sinatra
  register: result

Scanned by Steampunk Spotter

- name: Make sure that both images pacur/centos-7 and sinatra exist locally
  ansible.builtin.assert:
    that:
      - result.images | length == 2

Inputs

tls:
default: false
description:
- Secure the connection to the API by using TLS without verifying the authenticity
of the Docker host server. Note that if I(validate_certs) is set to C(yes) as well,
it will take precedence.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS)
will be used instead. If the environment variable is not set, the default value
will be used.
type: bool

name:
description:
- An image name or a list of image names. Name format will be C(name[:tag]) or C(repository/name[:tag]),
where C(tag) is optional. If a tag is not provided, C(latest) will be used. Instead
of image names, also image IDs can be used.
- If no name is provided, a list of all images will be returned.
elements: str
type: list

debug:
default: false
description:
- Debug mode
type: bool

ca_cert:
aliases:
- tls_ca_cert
- cacert_path
description:
- Use a CA certificate when performing server verification by providing the path to
a CA certificate file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
is set, the file C(ca.pem) from the directory specified in the environment variable
C(DOCKER_CERT_PATH) will be used.
type: path

timeout:
default: 60
description:
- The maximum amount of time in seconds to wait on a response from the API.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TIMEOUT)
will be used instead. If the environment variable is not set, the default value
will be used.
type: int

client_key:
aliases:
- tls_client_key
- key_path
description:
- Path to the client's TLS key file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
is set, the file C(key.pem) from the directory specified in the environment variable
C(DOCKER_CERT_PATH) will be used.
type: path

api_version:
aliases:
- docker_api_version
default: auto
description:
- The version of the Docker API running on the Docker Host.
- Defaults to the latest version of the API supported by Docker SDK for Python and
the docker daemon.
- If the value is not specified in the task, the value of environment variable C(DOCKER_API_VERSION)
will be used instead. If the environment variable is not set, the default value
will be used.
type: str

client_cert:
aliases:
- tls_client_cert
- cert_path
description:
- Path to the client's TLS certificate file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
is set, the file C(cert.pem) from the directory specified in the environment variable
C(DOCKER_CERT_PATH) will be used.
type: path

docker_host:
aliases:
- docker_url
default: unix://var/run/docker.sock
description:
- The URL or Unix socket path used to connect to the Docker API. To connect to a remote
host, provide the TCP connection string. For example, C(tcp://192.0.2.23:2376).
If TLS is used to encrypt the connection, the module will automatically replace
C(tcp) in the connection URL with C(https).
- If the value is not specified in the task, the value of environment variable C(DOCKER_HOST)
will be used instead. If the environment variable is not set, the default value
will be used.
type: str

ssl_version:
description:
- Provide a valid SSL version number. Default value determined by ssl.py module.
- If the value is not specified in the task, the value of environment variable C(DOCKER_SSL_VERSION)
will be used instead.
type: str

tls_hostname:
default: localhost
description:
- When verifying the authenticity of the Docker Host server, provide the expected
name of the server.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_HOSTNAME)
will be used instead. If the environment variable is not set, the default value
will be used.
type: str

validate_certs:
aliases:
- tls_verify
default: false
description:
- Secure the connection to the API by using TLS and verifying the authenticity of
the Docker host server.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_VERIFY)
will be used instead. If the environment variable is not set, the default value
will be used.
type: bool

Outputs

images:
  description:
  - Inspection results for the selected images.
  - The list only contains inspection results of images existing locally.
  elements: dict
  returned: always
  sample:
  - Architecture: amd64
    Author: ''
    Comment: ''
    Config:
      AttachStderr: false
      AttachStdin: false
      AttachStdout: false
      Cmd:
      - /etc/docker/registry/config.yml
      Domainname: ''
      Entrypoint:
      - /bin/registry
      Env:
      - PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
      ExposedPorts:
        5000/tcp: {}
      Hostname: e5c68db50333
      Image: c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799
      Labels: {}
      OnBuild: []
      OpenStdin: false
      StdinOnce: false
      Tty: false
      User: ''
      Volumes:
        /var/lib/registry: {}
      WorkingDir: ''
    Container: e83a452b8fb89d78a25a6739457050131ca5c863629a47639530d9ad2008d610
    ContainerConfig:
      AttachStderr: false
      AttachStdin: false
      AttachStdout: false
      Cmd:
      - /bin/sh
      - -c
      - '#(nop) CMD ["/etc/docker/registry/config.yml"]'
      Domainname: ''
      Entrypoint:
      - /bin/registry
      Env:
      - PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
      ExposedPorts:
        5000/tcp: {}
      Hostname: e5c68db50333
      Image: c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799
      Labels: {}
      OnBuild: []
      OpenStdin: false
      StdinOnce: false
      Tty: false
      User: ''
      Volumes:
        /var/lib/registry: {}
      WorkingDir: ''
    Created: '2016-03-08T21:08:15.399680378Z'
    DockerVersion: 1.9.1
    GraphDriver:
      Data: null
      Name: aufs
    Id: 53773d8552f07b730f3e19979e32499519807d67b344141d965463a950a66e08
    Name: registry:2
    Os: linux
    Parent: f0b1f729f784b755e7bf9c8c2e65d8a0a35a533769c2588f02895f6781ac0805
    RepoDigests: []
    RepoTags:
    - registry:2
    Size: 0
    VirtualSize: 165808884
  type: list