docker_secret - Управление секретами Docker.

Новая версия в версии 2.4.

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Описание

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

Требования (к хосту, на котором выполняется модуль)

docker-py >= 2.1.0
Docker API >= 1.25

Параметры

параметр	обязателен	значение по умолчанию	выбор	комментарии
api_version	нет	значение по умолчанию, предоставляемое docker-py		Версия Docker API, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. псевдонимы: docker_api_version
cacert_path	нет			Использование сертификата CA при проверке сервера путём указания пути к файлу сертификата CA. псевдонимы: tls_ca_cert
cert_path	нет			Путь к файлу TLS-сертификата клиента. псевдонимы: tls_client_cert
data	нет			Строка. Значение секрета. Требуется, когда состояние равно `present`.
docker_host	нет	unix://var/run/docker.sock		URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, 'tcp://192.0.2.23:2376'. Если для шифрования подключения используется TLS, модуль автоматически заменит 'tcp' в URL-адресе соединения на 'https'. псевдонимы: docker_url
force	нет			Булево значение. Используется со значением состояния `present`, чтобы всегда удалять и пересоздавать существующий секрет. Если true, существующий секрет будет заменён, даже если он не изменился.
key_path	нет			Путь к файлу TLS-ключа клиента. псевдонимы: tls_client_key
labels	нет			Словарь метаданных ключ:значение, где как ключ, так и значение являются строками. Если предоставлены новые метаданные или изменены существующие, секрет будет обновлён путём удаления и повторного создания.
name	да			Имя секрета.
ssl_version	нет	1.0		Укажите версию SSL. Значение по умолчанию определяется docker-py, в настоящее время 1.0.
state	нет	present	absent present	Установите значение `present`, если секрет должен существовать, и `absent`, если он не должен.
timeout	нет	60		Максимальное время в секундах ожидания ответа от API.
tls	нет			Защитите подключение к API с помощью TLS без проверки подлинности хоста Docker.
tls_hostname	нет	localhost		При проверке подлинности хоста Docker укажите ожидаемое имя сервера.
tls_verify	нет			Защитите подключение к API с помощью TLS и проверьте подлинность хоста Docker.

Примеры

- name: Create secret foo
  docker_secret:
    name: foo
    data: Hello World!
    state: present

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

- name: Add a new label
  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
  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
  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
  docker_secret:
    name: foo
    data: Goodnight everyone!
    force: yes
    state: present

- name: Remove secret foo
  docker_secret:
    name: foo
    state: absent

Возвращаемые значения

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

имя	описание	возвращаемое значение	тип	пример
secret_id	Идентификатор, присвоенный Docker объекту секрета.	успех	строка	hzehrmyjigmcp2gb6nlhmjqcv

Примечания

Примечание

Подключение к демону 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://docker-py.readthedocs.org/en/stable/machine/

Статус

Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если вы заинтересованы, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/docker_secret_module.html