docker_secret - Manage docker secrets.

• Synopsis
  • Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status
• Maintenance
  • Author

Synopsis

• Create and remove Docker secrets in a Swarm environment. Similar to docker secret create and docker secret rm.
• Adds to the metadata of new secrets ‘ansible_key’, an encrypted hash representation of the data, which is then used
• in future runs to test if a secret has changed.
• If ‘ansible_key is not present, then a secret will not be updated unless the force option is set.
• Updates to secrets are performed by removing the secret and creating it again.

Requirements

The below requirements are needed on the host that executes this module.

• docker-py >= 2.1.0
• Please note that the docker-py Python module has been superseded by docker (see here for details). Version 2.1.0 or newer is only available with the docker module.
• Docker API >= 1.25

Parameters

Notes

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

• Chris Houseknecht (@chouseknecht)