Spec-Zone.ru › Ansible 2.7

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

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

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

Обзор

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

Требования

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

  • docker-py >= 2.1.0
  • Обратите внимание, что модуль Python docker-py был заменен модулем docker (подробнее см. здесь). Версия 2.1.0 или более поздняя доступна только с модулем docker.
  • Docker API >= 1.25

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_version
-
По умолчанию:
"auto"
Версия Docker API, запущенная на хосте Docker. По умолчанию используется самая последняя версия API, поддерживаемая docker-py.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_API_VERSION. Если переменная окружения не задана, используется значение по умолчанию.

Псевдонимы: docker_api_version
cacert_path
-
Использование сертификата CA при проверке сервера путем указания пути к файлу сертификата CA.
Если значение не указано в задаче, и переменная окружения DOCKER_CERT_PATH установлена, используется файл ca.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

Псевдонимы: tls_ca_cert
cert_path
-
Путь к файлу TLS-сертификата клиента.
Если значение не указано в задаче, и переменная окружения DOCKER_CERT_PATH установлена, используется файл cert.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

Псевдонимы: tls_client_cert
data
-
Строка. Значение секрета. Требуется, когда состояние равно present.
debug
boolean
    Варианты:
  • нет ←
  • да
Режим отладки
docker_host
-
По умолчанию:
"unix://var/run/docker.sock"
URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, 'tcp://192.0.2.23:2376'. Если для шифрования соединения используется TLS, модуль автоматически заменит 'tcp' в URL соединения на 'https'.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_HOST. Если переменная окружения не задана, используется значение по умолчанию.

Псевдонимы: docker_url
force
boolean
    Варианты:
  • нет ←
  • да
Использовать со значением состояния present, чтобы всегда удалять и пересоздавать существующий секрет.
Если истина, существующий секрет будет заменён, даже если он не изменился.
key_path
-
Путь к файлу ключа TLS клиента.
Если значение не указано в задаче, и переменная окружения DOCKER_CERT_PATH установлена, используется файл key.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

Псевдонимы: tls_client_key
labels
-
Словарь метаданных ключ:значение, где и ключ и значение ожидаются как строки.
Если предоставляются новые метаданные или изменяются существующие метаданные, секрет будет обновлён путём удаления и повторного создания.
name
- / обязательно
Имя секрета.
ssl_version
-
Укажите действительное значение версии SSL. Значение по умолчанию определяется модулем ssl.py.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_SSL_VERSION.
state
-
    Варианты:
  • отсутствует
  • есть ←
Установить в present, если секрет должен существовать, и absent, если он не должен.
timeout
-
По умолчанию:
60
Максимальное время в секундах ожидания ответа от API.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TIMEOUT. Если переменная окружения не задана, используется значение по умолчанию.
tls
boolean
    Варианты:
  • нет ←
  • да
Обеспечьте безопасность соединения с API с помощью TLS без проверки подлинности хоста Docker.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS. Если переменная окружения не задана, используется значение по умолчанию.
tls_hostname
-
По умолчанию:
"localhost"
При проверке подлинности хоста Docker укажите ожидаемое имя сервера.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS_HOSTNAME. Если переменная окружения не задана, используется значение по умолчанию.
tls_verify
boolean
    Варианты:
  • нет ←
  • да
Защитите соединение с API с помощью TLS и проверьте подлинность хоста Docker.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_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://docker-py.readthedocs.io/en/stable/machine/
  • При подключении к демону Docker с TLS, вам может потребоваться установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или выше, это можно сделать, установив docker[tls] с помощью pip.
  • Обратите внимание, что Docker SDK для Python позволяет указывать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать $HOME/docker/config.json, если переменная окружения DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.

Примеры

- 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


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Chris Houseknecht (@chouseknecht)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API