community.general.docker_config – Управление конфигурациями Docker.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.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 строка | Значение по умолчанию: "auto" | Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном docker. Если значение не указано в задаче, используется значение переменной окружения DOCKER_API_VERSION. Если переменная окружения не задана, используется значение по умолчанию.Псевдонимы: docker_api_version |
| ca_cert путь | Использование сертификата CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и установлена переменная окружения DOCKER_CERT_PATH, используется файл ca.pem из директории, указанной в переменной окружения DOCKER_CERT_PATH. Псевдонимы: tls_ca_cert, cacert_path | |
| client_cert путь | Путь к файлу сертификата TLS клиента. Если значение не указано в задаче и установлена переменная окружения DOCKER_CERT_PATH, используется файл cert.pem из директории, указанной в переменной окружения DOCKER_CERT_PATH. Псевдонимы: tls_client_cert, cert_path | |
| client_key путь | Путь к файлу ключа TLS клиента. Если значение не указано в задаче и установлена переменная окружения DOCKER_CERT_PATH, используется файл key.pem из директории, указанной в переменной окружения DOCKER_CERT_PATH. Псевдонимы: tls_client_key, key_path | |
| data строка | Значение конфигурации. Требуется, когда состояние present. | |
| data_is_b64 логическое |
| Если установлено true, данные предполагаются закодированными в Base64 и будут декодированы перед использованием.Для использования двоичных данных лучше оставить их закодированными в Base64 и позволить декодировать с помощью этой опции. |
| debug логическое |
| Отладочный режим |
| docker_host строка | Значение по умолчанию: "unix://var/run/docker.sock" | URL или путь к Unix-сокету для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, tcp://192.0.2.23:2376. Если для шифрования подключения используется TLS, модуль автоматически заменит tcp в URL подключения на https.Если значение не указано в задаче, используется значение переменной окружения DOCKER_HOST. Если переменная окружения не задана, используется значение по умолчанию.Псевдонимы: docker_url |
| force логическое |
| Используйте со статусом present для всегда удаления и повторного создания существующей конфигурации.Если true, существующая конфигурация будет заменена, даже если она не была изменена. |
| labels словарь | Карта ключей:значений метаданных, где и ключ, и значение ожидаются как строки. Если предоставляются новые метаданные или изменяются существующие, конфигурация будет обновлена путем удаления и повторного создания. | |
| name строка / обязательно | Имя конфигурации. | |
| ssl_version строка | Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной окружения DOCKER_SSL_VERSION. | |
| state строка |
| Установите в значение present, если конфигурация должна существовать, и absent, если она не должна. |
| timeout целое число | Значение по умолчанию: 60 | Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, используется значение переменной окружения DOCKER_TIMEOUT.Если переменная окружения не задана, используется значение по умолчанию. |
| tls логическое |
| Защитить подключение к API с помощью TLS без проверки подлинности хоста Docker. Обратите внимание, что если validate_certs также установлено в yes, оно будет иметь приоритет.Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS.Если переменная окружения не задана, используется значение по умолчанию. |
| tls_hostname строка | Значение по умолчанию: "localhost" | При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS_HOSTNAME.Если переменная окружения не задана, используется значение по умолчанию. |
| validate_certs логическое |
| Защитить подключение к API с помощью TLS и проверить подлинность хоста Docker. Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS_VERIFY.Если переменная окружения не задана, используется значение по умолчанию. Псевдонимы: tls_verify |
Примечания
Примечание
- Подключение к демону 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в противном случае.
Примеры
- name: Create config foo (from a file on the control machine)
community.general.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: Change the config data
community.general.docker_config:
name: foo
data: Goodnight everyone!
labels:
bar: baz
one: '1'
state: present
- name: Add a new label
community.general.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.general.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.general.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.general.docker_config:
name: foo
data: Goodnight everyone!
force: yes
state: present
- name: Remove config foo
community.general.docker_config:
name: foo
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| config_id строка | успех и состояние present
| Идентификатор, назначенный Docker объекту конфигурации. Пример: hzehrmyjigmcp2gb6nlhmjqcv |
Авторы
- Крис Хаускнект (@chouseknecht)
- Джон Ху (@ushuz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/docker_config_module.html