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

Примечание

Этот модуль входит в коллекцию community.docker (версия 5.2.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.
Обновление конфигураций выполняется путем удаления конфигурации и ее повторного создания.

Требования

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

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

Параметры

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

Примечания

Примечание

Подключайтесь к демону Docker, передавая параметры в каждой задаче или задавая переменные окружения. Можно задать DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите поставляемый с продуктом скрипт настройки среды. Он задаст эти переменные за вас. Дополнительные сведения см. по адресу https://docs.docker.com/machine/reference/env/.
При подключении к демону Docker по TLS может потребоваться установить дополнительные пакеты Python. Для Docker SDK for Python версии 2.4 или новее это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
Обратите внимание: Docker SDK for Python позволяет указать путь к конфигурации Docker лишь для очень небольшого числа функций. Как правило, если переменная окружения DOCKER_CONFIG не задана, будет использоваться $HOME/.docker/config.json, а в противном случае — $DOCKER_CONFIG/config.json.
Этот модуль использует Docker SDK for 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 string	Идентификатор, присвоенный Docker объекту конфигурации. Возвращается: при успешном выполнении и `state=present` Пример: `"hzehrmyjigmcp2gb6nlhmjqcv"`
config_name string добавлен в community.docker 2.2.0	Имя созданного объекта конфигурации. Возвращается: при успешном выполнении и `state=present` Пример: `"awesome_config"`

Авторы

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

Ссылки на коллекцию

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