Руководство по Docker

Параметры

Большинство плагинов и модулей можно настроить с помощью следующих параметров:

docker_host

URL или путь к сокету Unix, используемый для подключения к API Docker. По умолчанию — unix:///var/run/docker.sock. Для подключения к удалённому хосту укажите строку TCP-подключения (например: tcp://192.0.2.23:2376). Если для шифрования подключения к API используется TLS, модуль автоматически заменит tcp в URL подключения на https.

api_version

Версия API Docker, работающего на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая установленным Docker SDK for Python.

timeout

Максимальное время ожидания ответа API в секундах. По умолчанию — 60 секунд.

tls

Защищает подключение к API с помощью TLS без проверки подлинности сервера хоста Docker. По умолчанию — false.

validate_certs

Защищает подключение к API с помощью TLS и проверяет подлинность сервера хоста Docker. По умолчанию — false.

ca_path

Используйте сертификат центра сертификации при проверке сервера, указав путь к файлу сертификата центра сертификации.

cert_path

Путь к файлу клиентского TLS-сертификата.

key_path

Путь к файлу клиентского TLS-ключа.

tls_hostname

При проверке подлинности сервера хоста Docker укажите ожидаемое имя сервера. По умолчанию — localhost.

ssl_version

Укажите допустимый номер версии SSL. Значение по умолчанию определяется Docker SDK for Python.

Этот параметр недоступен для плагинов на основе CLI. В основном он требуется для устаревших систем, поэтому его следует избегать.

Группа параметров модуля по умолчанию

Чтобы не указывать общие параметры для всех модулей в каждой задаче, можно использовать community.docker.docker группу параметров модуля по умолчанию или её краткое имя docker.

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

---
- name: Pull image and start the container
  hosts: localhost
  gather_facts: false
  module_defaults:
    group/community.docker.docker:
      # Select Docker Daemon on other host
      docker_host: tcp://192.0.2.23:2376
      # Configure TLS
      tls: true
      validate_certs: true
      tls_hostname: docker.example.com
      ca_path: /path/to/cacert.pem
      # Increase timeout
      timeout: 120
  tasks:
    - name: Pull image
      community.docker.docker_image_pull:
        name: python
        tag: 3.12

    - name: Start container
      community.docker.docker_container:
        cleanup: true
        command: python --version
        detach: false
        image: python:3.12
        name: my-python-container
        output_logs: true

    - name: Show output
      ansible.builtin.debug:
        msg: "{{ output.container.Output }}"

Здесь в двух задачах community.docker будут использоваться параметры, заданные для группы параметров модуля по умолчанию.

Переменные окружения

Также можно управлять тем, как плагины и модули подключаются к API Docker, задав следующие переменные окружения.

Для плагинов их необходимо задать в окружении, в котором работает сам Ansible. Для модулей их необходимо задать в окружении, в котором выполняются модули. Если модули выполняются на удалённых машинах, переменные окружения необходимо задать на этой машине для пользователя, от имени которого выполняются модули.

DOCKER_HOST

URL или путь к сокету Unix, используемый для подключения к API Docker.

DOCKER_API_VERSION

Версия API Docker, работающего на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK for Python.

DOCKER_TIMEOUT

Максимальное время ожидания ответа API в секундах.

DOCKER_CERT_PATH

Путь к каталогу, содержащему клиентский сертификат, клиентский ключ и сертификат центра сертификации.

DOCKER_SSL_VERSION

Укажите допустимый номер версии SSL.

DOCKER_TLS

Защищает подключение к API с помощью TLS без проверки подлинности хоста Docker.

DOCKER_TLS_HOSTNAME

При проверке подлинности хоста Docker использует это имя узла для сравнения с сертификатом хоста.

DOCKER_TLS_VERIFY

Защищает подключение к API с помощью TLS и проверяет подлинность хоста Docker.

Docker Compose v2

Для работы с проектами Docker Compose доступны несколько модулей:

community.docker.docker_compose_v2

Модуль community.docker.docker_compose_v2 позволяет использовать существующие файлы Docker Compose для оркестрации контейнеров на одном демоне Docker или в Swarm.

community.docker.docker_compose_v2_exec

Модуль community.docker.docker_compose_v2_exec позволяет выполнять команду в контейнере проекта Docker Compose.

community.docker.docker_compose_v2_pull

Модуль community.docker.docker_compose_v2_pull позволяет загружать проекты Docker Compose.

community.docker.docker_compose_v2_run

Модуль community.docker.docker_compose_v2_run позволяет выполнять команду в новом контейнере проекта Docker Compose.

Эти модули используют плагин «compose» Docker CLI (docker compose), поэтому им необходим доступ к инструменту Docker CLI. Помимо инструмента CLI и его плагина Docker Compose никаких дополнительных требований нет.

Управление Swarm

Для управления Docker Swarm доступны один плагин инвентаризации и несколько модулей:

плагин инвентаризации docker_swarm

Плагин инвентаризации community.docker.docker_swarm позволяет динамически добавлять все узлы Docker Swarm в инвентаризацию Ansible.

модуль docker_swarm

Модуль community.docker.docker_swarm позволяет глобально настраивать узлы-менеджеры Docker Swarm для присоединения к кластерам и выхода из них, а также изменять конфигурацию Docker Swarm.

модуль docker_swarm_info

Модуль community.docker.docker_swarm_info позволяет получать сведения о Docker Swarm.

модуль docker_node

Модуль community.docker.docker_node позволяет управлять узлами Docker Swarm.

модуль docker_node_info

Модуль community.docker.docker_node_info позволяет получать сведения об узлах Docker Swarm.

Управление конфигурацией

Коллекция community.docker предоставляет модули для управления конфигурациями и секретами Docker Swarm:

модуль docker_config

Модуль community.docker.docker_config позволяет создавать и изменять конфигурации Docker Swarm.

модуль docker_secret

Модуль community.docker.docker_secret позволяет создавать и изменять секреты Docker Swarm.

Сервисы Swarm

Сервисы Docker Swarm можно создавать и обновлять с помощью модуля community.docker.docker_swarm_service, а получать сведения о них — с помощью модуля community.docker.docker_swarm_service_info.