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

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

Описание

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

Требования

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

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

Параметры

Примечания

Примеры

- name: Create secret foo (from a file on the control machine)
  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: 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

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

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

Статус

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

Авторы

• Chris Houseknecht (@chouseknecht)