docker_image – Управление образами docker

• Описание
• Требования
• Параметры
• Примечания
• Примеры
• Возвращаемые значения
• Статус

Описание

• Сборка, загрузка или получение образа, делая образ доступным для создания контейнеров. Также поддерживает добавление тега к образу в репозиторий и архивирование образа в файл .tar.
• Начиная с Ansible 2.8, рекомендуется явно указывать источник образа (source может быть build, load, pull или local). Это станет обязательным начиная с Ansible 2.12.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

• Docker API >= 1.20
• Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (см. здесь для получения подробностей). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны быть установлены одновременно. Также обратите внимание, что при установке и последующей деинсталляции одного из модулей другой может перестать работать, и потребуется его повторная установка.
• Docker SDK для Python >= 1.8.0 (используйте docker-py для Python 2.6)

Параметры

Примечания

Примеры

- name: pull an image
  docker_image:
    name: pacur/centos-7
    source: pull

- name: Tag and push to docker hub
  docker_image:
    name: pacur/centos-7:56
    repository: dcoppenhagan/myimage:7.56
    push: yes
    source: local

- name: Tag and push to local registry
  docker_image:
    # Image will be centos:7
    name: centos
    # Will be pushed to localhost:5000/centos:7
    repository: localhost:5000/centos
    tag: 7
    push: yes
    source: local

- name: Add tag latest to image
  docker_image:
    name: myimage:7.1.2
    repository: myimage:latest
    # As 'latest' usually already is present, we need to enable overwriting of existing tags:
    force_tag: yes
    source: local

- name: Remove image
  docker_image:
    state: absent
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1

- name: Build an image and push it to a private repo
  docker_image:
    build:
      path: ./sinatra
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1
    push: yes
    source: build

- name: Archive image
  docker_image:
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1
    archive_path: my_sinatra.tar
    source: local

- name: Load image from archive and push to a private registry
  docker_image:
    name: localhost:5000/myimages/sinatra
    tag: v1
    push: yes
    load_path: my_sinatra.tar
    source: load

- name: Build image and with build args
  docker_image:
    name: myimage
    build:
      path: /path/to/build/dir
      args:
        log_volume: /var/log/myapp
        listen_port: 8080
    source: build

- name: Build image using cache source
  docker_image:
    name: myimage:latest
    build:
      path: /path/to/build/dir
      # Use as cache source for building myimage
      cache_from:
        - nginx:latest
        - alpine:3.8
    source: build

Значения возврата

Общие значения возврата описаны в документации, следующие поля уникальны для данного модуля:

Статус

• Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
• Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

• Павел Антонов (@softzilla)
• Крис Хауснект (@chouseknecht)