mirror of
https://github.com/ansible-collections/community.docker.git
synced 2026-07-29 11:55:04 +00:00
Use semantic markup (#645)
* Use semantic markup. * Linting. * Define docsite targets. * Forgot one env var. * Add array stubs.
This commit is contained in:
@@ -18,7 +18,7 @@ description:
|
||||
- Create and remove Docker configs in a Swarm environment. Similar to C(docker config create) and C(docker config rm).
|
||||
- Adds to the metadata of new configs 'ansible_key', an encrypted hash representation of the data, which is then used
|
||||
in future runs to test if a config has changed. If 'ansible_key' is not present, then a config will not be updated
|
||||
unless the I(force) option is set.
|
||||
unless the O(force) option is set.
|
||||
- Updates to configs are performed by removing the config and creating it again.
|
||||
|
||||
extends_documentation_fragment:
|
||||
@@ -37,45 +37,45 @@ options:
|
||||
data:
|
||||
description:
|
||||
- The value of the config.
|
||||
- Mutually exclusive with I(data_src). One of I(data) and I(data_src) is required if I(state=present).
|
||||
- Mutually exclusive with O(data_src). One of O(data) and O(data_src) is required if O(state=present).
|
||||
type: str
|
||||
data_is_b64:
|
||||
description:
|
||||
- If set to C(true), the data is assumed to be Base64 encoded and will be
|
||||
- If set to V(true), the data is assumed to be Base64 encoded and will be
|
||||
decoded before being used.
|
||||
- To use binary I(data), it is better to keep it Base64 encoded and let it
|
||||
- To use binary O(data), it is better to keep it Base64 encoded and let it
|
||||
be decoded by this option.
|
||||
type: bool
|
||||
default: false
|
||||
data_src:
|
||||
description:
|
||||
- The file on the target from which to read the config.
|
||||
- Mutually exclusive with I(data). One of I(data) and I(data_src) is required if I(state=present).
|
||||
- Mutually exclusive with O(data). One of O(data) and O(data_src) is required if O(state=present).
|
||||
type: path
|
||||
version_added: 1.10.0
|
||||
labels:
|
||||
description:
|
||||
- "A map of key:value meta data, where both the I(key) and I(value) are expected to be a string."
|
||||
- "A map of key:value meta data, where both the C(key) and C(value) are expected to be a string."
|
||||
- If new meta data is provided, or existing meta data is modified, the config will be updated by removing it and creating it again.
|
||||
type: dict
|
||||
force:
|
||||
description:
|
||||
- Use with state C(present) to always remove and recreate an existing config.
|
||||
- If C(true), an existing config will be replaced, even if it has not been changed.
|
||||
- Use with O(state=present) to always remove and recreate an existing config.
|
||||
- If V(true), an existing config will be replaced, even if it has not been changed.
|
||||
type: bool
|
||||
default: false
|
||||
rolling_versions:
|
||||
description:
|
||||
- If set to C(true), configs are created with an increasing version number appended to their name.
|
||||
- If set to V(true), configs are created with an increasing version number appended to their name.
|
||||
- Adds a label containing the version number to the managed configs with the name C(ansible_version).
|
||||
type: bool
|
||||
default: false
|
||||
version_added: 2.2.0
|
||||
versions_to_keep:
|
||||
description:
|
||||
- When using I(rolling_versions), the number of old versions of the config to keep.
|
||||
- When using O(rolling_versions), the number of old versions of the config to keep.
|
||||
- Extraneous old configs are deleted after the new one is created.
|
||||
- Set to C(-1) to keep everything or to C(0) or C(1) to keep only the current one.
|
||||
- Set to V(-1) to keep everything or V(0) or V(1) to keep only the current one.
|
||||
type: int
|
||||
default: 5
|
||||
version_added: 2.2.0
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- Set to C(present), if the config should exist, and C(absent), if it should not.
|
||||
- Set to V(present), if the config should exist, and V(absent), if it should not.
|
||||
type: str
|
||||
default: present
|
||||
choices:
|
||||
@@ -94,7 +94,7 @@ options:
|
||||
- present
|
||||
template_driver:
|
||||
description:
|
||||
- Set to C(golang) to use a Go template in I(data) or a Go template file in I(data_src).
|
||||
- Set to V(golang) to use a Go template in O(data) or a Go template file in O(data_src).
|
||||
type: str
|
||||
choices:
|
||||
- golang
|
||||
@@ -183,13 +183,13 @@ RETURN = '''
|
||||
config_id:
|
||||
description:
|
||||
- The ID assigned by Docker to the config object.
|
||||
returned: success and I(state) is C(present)
|
||||
returned: success and O(state=present)
|
||||
type: str
|
||||
sample: 'hzehrmyjigmcp2gb6nlhmjqcv'
|
||||
config_name:
|
||||
description:
|
||||
- The name of the created config object.
|
||||
returned: success and I(state) is C(present)
|
||||
returned: success and O(state=present)
|
||||
type: str
|
||||
sample: 'awesome_config'
|
||||
version_added: 2.2.0
|
||||
|
||||
Reference in New Issue
Block a user