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

Примечание

Этот модуль является частью коллекции community.docker (версия 3.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в плейбуке укажите: community.docker.docker_config.

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

Описание

Создание и удаление конфигураций Docker в среде Swarm. Аналогично docker config create и docker config rm.
Добавляет в метаданные новых конфигураций поле ‘ansible_key’, представляющее собой зашифрованный хеш данных, который затем используется в последующих запусках для проверки изменений в конфигурации. Если ‘ansible_key’ отсутствует, конфигурация не будет обновлена, если не установлен параметр force.
Обновление конфигураций выполняется путем удаления конфигурации и ее повторного создания.

Требования

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

API Docker >= 1.30
Docker SDK для Python: Обратите внимание, что модуль Python docker-py устарел и заменен на docker (подробнее см. здесь). Этот модуль *не* работает с docker-py.
Docker SDK для Python >= 2.6.0
Python >= 2.7

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker. Если значение не указано в задаче, используется значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не задана, используется значение по умолчанию. По умолчанию: `"auto"`
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь	Использование сертификата CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче, а переменная среды `DOCKER_CERT_PATH` установлена, используется файл `ca.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое название добавлено в качестве псевдонима и по-прежнему может использоваться.
client_cert псевдонимы: tls_client_cert, cert_path путь	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче, а переменная среды `DOCKER_CERT_PATH` установлена, используется файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path путь	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче, а переменная среды `DOCKER_CERT_PATH` установлена, используется файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
data строка	Значение конфигурации. Взаимоисключающий параметр с `data_src`. Один из `data` и `data_src` требуется, если `state=present`.
data_is_b64 булево	Если установлено `true`, данные предполагаются закодированными в Base64 и будут декодированы перед использованием. Для использования бинарных `data`, лучше сохранить их в Base64-кодировке и позволить декодировать этому параметру. Варианты: `false` ← (по умолчанию) `true`
data_src путь добавлен в community.docker 1.10.0	Файл на целевом устройстве, из которого следует считать конфигурацию. Взаимоисключающий параметр с `data`. Один из `data` и `data_src` требуется, если `state=present`.
debug булево	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url строка	URL или путь к сокету Unix для подключения к API Docker. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, используется значение переменной среды `DOCKER_HOST`. Если переменная среды не задана, используется значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
force булево	Использовать с `state=present` для всегда удаления и создания новой конфигурации. Если `true`, существующая конфигурация будет заменена, даже если она не была изменена. Варианты: `false` ← (по умолчанию) `true`
labels словарь	Словарь метаданных ключ:значение, где `key` и `value` должны быть строками. Если предоставляются новые метаданные или изменяются существующие, конфигурация будет обновлена путем удаления и повторного создания.
name строка / обязательно	Имя конфигурации.
rolling_versions булево добавлен в community.docker 2.2.0	Если установлено `true`, конфигурации создаются с возрастающим номером версии, добавленным к их имени. Добавляет метку, содержащую номер версии, к управляемым конфигурациям с именем `ansible_version`. Варианты: `false` ← (по умолчанию) `true`

ssl_version string	Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_SSL_VERSION`. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание этого параметра с Docker SDK для Python 7.0.0 или более новой версией приведёт к ошибке.
state string	Установите в `present`, если конфигурация должна существовать, и в `absent`, если она не должна существовать. Варианты: `"absent"` `"present"` ← (по умолчанию)
template_driver string добавлен в community.docker 2.5.0	Установите в `golang` для использования шаблона Go в `data` или файла шаблона Go в `data_src`. Варианты: `"golang"`
timeout integer	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `60`
tls boolean	Обеспечьте защищённое соединение с API, используя TLS без проверки подлинности сервера Docker. Обратите внимание, что если `validate_certs` также установлено в `true`, то будет использоваться это значение. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности сервера Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использовано значение по умолчанию. Обратите внимание, что этот параметр имел значение по умолчанию `localhost` в более старых версиях. Он был удалён в community.docker 3.0.0. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание этого параметра с Docker SDK для Python 7.0.0 или более новой версией приведёт к ошибке.
use_ssh_client boolean добавлен в community.docker 1.5.0	Для SSH-транспортов используйте утилиту командной строки `ssh` вместо paramiko. Требуется Docker SDK для Python 4.4.0 или более новой версии. Варианты: `false` ← (по умолчанию) `true`
validate_certs aliases: tls_verify boolean	Обеспечьте защищённое соединение с API, используя TLS и проверяя подлинность сервера Docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
versions_to_keep integer добавлен в community.docker 2.2.0	При использовании `rolling_versions`, количество старых версий конфигурации, которые нужно сохранить. Избыточные старые конфигурации удаляются после создания новой. Установите в `-1` для сохранения всех или `0` или `1` для сохранения только текущей. По умолчанию: `5`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff вернёт подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`).

Примечания

Примечание

Подключитесь к демону Docker, указав параметры для каждой задачи или определив переменные окружения. Вы можете определить DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите скрипт, поставляемый с продуктом, который настраивает среду. Он установит эти переменные за вас. Подробнее см. https://docs.docker.com/machine/reference/env/.
При подключении к демону Docker с TLS вам может потребоваться установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или новее это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать $HOME/.docker/config.json , если переменная окружения DOCKER_CONFIG не указана, и $DOCKER_CONFIG/config.json в противном случае.
Этот модуль использует Docker SDK для Python для связи с демоном Docker.

Примеры

- name: Create config foo (from a file on the control machine)
  community.docker.docker_config:
    name: foo
    # If the file is JSON or binary, Ansible might modify it (because
    # it is first decoded and later re-encoded). Base64-encoding the
    # file directly after reading it prevents this to happen.
    data: "{{ lookup('file', '/path/to/config/file') | b64encode }}"
    data_is_b64: true
    state: present

- name: Create config foo (from a file on the target machine)
  community.docker.docker_config:
    name: foo
    data_src: /path/to/config/file
    state: present

- name: Change the config data
  community.docker.docker_config:
    name: foo
    data: Goodnight everyone!
    labels:
      bar: baz
      one: '1'
    state: present

- name: Add a new label
  community.docker.docker_config:
    name: foo
    data: Goodnight everyone!
    labels:
      bar: baz
      one: '1'
      # Adding a new label will cause a remove/create of the config
      two: '2'
    state: present

- name: No change
  community.docker.docker_config:
    name: foo
    data: Goodnight everyone!
    labels:
      bar: baz
      one: '1'
      # Even though 'two' is missing, there is no change to the existing config
    state: present

- name: Update an existing label
  community.docker.docker_config:
    name: foo
    data: Goodnight everyone!
    labels:
      bar: monkey   # Changing a label will cause a remove/create of the config
      one: '1'
    state: present

- name: Force the (re-)creation of the config
  community.docker.docker_config:
    name: foo
    data: Goodnight everyone!
    force: true
    state: present

- name: Remove config foo
  community.docker.docker_config:
    name: foo
    state: absent

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

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

Ключ	Описание
config_id строка	Идентификатор, назначенный Docker объекту конфигурации. Возвращается: при успехе и `state=present` Пример: `"hzehrmyjigmcp2gb6nlhmjqcv"`
config_name строка добавлено в community.docker 2.2.0	Имя созданного объекта конфигурации. Возвращается: при успехе и `state=present` Пример: `"awesome_config"`

Авторы

Chris Houseknecht (@chouseknecht)
John Hu (@ushuz)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/docker/docker_config_module.html