Модуль community.docker.docker_secret – Управление секретами Docker.

Примечание

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

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

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

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

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

Описание

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

Требования

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

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

Параметры

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

Примечания

Примечание

Подключитесь к демону 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 secret foo (from a file on the control machine)
  community.docker.docker_secret:
    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/secret/file') | b64encode }}"
    data_is_b64: true
    state: present

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

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

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

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

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

- name: Force the removal/creation of the secret
  community.docker.docker_secret:
    name: foo
    data: Goodnight everyone!
    force: true
    state: present

- name: Remove secret foo
  community.docker.docker_secret:
    name: foo
    state: absent

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

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

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

Авторы

Chris Houseknecht (@chouseknecht)

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

© 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_secret_module.html