docker_swarm_service: Documentation fixes (#50861)
* Describe labels and container_labels correctly * Clarify reserve_memory and limit_memory docs * Remove default from container_labels doc * Remove trailing whitespace * Document min api version for configs and secrets * Add changelog fragment * Specify type on labels and container_labels * Consolidate required API version descriptions * Update reserve and limit memory docs * Use correct power-of-two units * Remove description about limit_memory minimum 4mb
This commit is contained in:
parent
d28bf14c67
commit
644057e9ec
2 changed files with 28 additions and 13 deletions
|
@ -0,0 +1,4 @@
|
||||||
|
bugfixes:
|
||||||
|
- "docker_swarm_service - Document minimal API version for ``configs`` and ``secrets``."
|
||||||
|
- "docker_swarm_service - Document ``labels`` and ``container_labels`` with correct type."
|
||||||
|
- "docker_swarm_service - Document ``limit_memory`` and ``reserve_memory`` correctly on how to specify sizes."
|
|
@ -53,7 +53,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Container hostname
|
- Container hostname
|
||||||
- Maps docker service --hostname option.
|
- Maps docker service --hostname option.
|
||||||
- Requires api_version >= 1.25
|
- Requires API version >= 1.25
|
||||||
tty:
|
tty:
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
|
@ -61,28 +61,28 @@ options:
|
||||||
description:
|
description:
|
||||||
- Allocate a pseudo-TTY
|
- Allocate a pseudo-TTY
|
||||||
- Maps docker service --tty option.
|
- Maps docker service --tty option.
|
||||||
- Requires api_version >= 1.25
|
- Requires API version >= 1.25
|
||||||
dns:
|
dns:
|
||||||
required: false
|
required: false
|
||||||
default: []
|
default: []
|
||||||
description:
|
description:
|
||||||
- List of custom DNS servers.
|
- List of custom DNS servers.
|
||||||
- Maps docker service --dns option.
|
- Maps docker service --dns option.
|
||||||
- Requires api_version >= 1.25
|
- Requires API version >= 1.25
|
||||||
dns_search:
|
dns_search:
|
||||||
required: false
|
required: false
|
||||||
default: []
|
default: []
|
||||||
description:
|
description:
|
||||||
- List of custom DNS search domains.
|
- List of custom DNS search domains.
|
||||||
- Maps docker service --dns-search option.
|
- Maps docker service --dns-search option.
|
||||||
- Requires api_version >= 1.25
|
- Requires API version >= 1.25
|
||||||
dns_options:
|
dns_options:
|
||||||
required: false
|
required: false
|
||||||
default: []
|
default: []
|
||||||
description:
|
description:
|
||||||
- List of custom DNS options.
|
- List of custom DNS options.
|
||||||
- Maps docker service --dns-option option.
|
- Maps docker service --dns-option option.
|
||||||
- Requires api_version >= 1.25
|
- Requires API version >= 1.25
|
||||||
force_update:
|
force_update:
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
|
@ -90,18 +90,19 @@ options:
|
||||||
description:
|
description:
|
||||||
- Force update even if no changes require it.
|
- Force update even if no changes require it.
|
||||||
- Maps to docker service update --force option.
|
- Maps to docker service update --force option.
|
||||||
- Requires api_version >= 1.25
|
- Requires API version >= 1.25
|
||||||
labels:
|
labels:
|
||||||
required: false
|
required: false
|
||||||
|
type: dict
|
||||||
description:
|
description:
|
||||||
- List of the service labels.
|
- Dictionary of key value pairs.
|
||||||
- Maps docker service --label option.
|
- Maps docker service --label option.
|
||||||
container_labels:
|
container_labels:
|
||||||
required: false
|
required: false
|
||||||
|
type: dict
|
||||||
description:
|
description:
|
||||||
- List of the service containers labels.
|
- Dictionary of key value pairs.
|
||||||
- Maps docker service --container-label option.
|
- Maps docker service --container-label option.
|
||||||
default: []
|
|
||||||
endpoint_mode:
|
endpoint_mode:
|
||||||
required: false
|
required: false
|
||||||
description:
|
description:
|
||||||
|
@ -143,13 +144,21 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: 0
|
default: 0
|
||||||
description:
|
description:
|
||||||
- Service memory limit in MB. 0 equals no limit.
|
- "Service memory limit (format: C(<number>[<unit>])). Number is a positive integer.
|
||||||
|
Unit can be C(B) (byte), C(K) (kibibyte, 1024B), C(M) (mebibyte), C(G) (gibibyte),
|
||||||
|
C(T) (tebibyte), or C(P) (pebibyte)."
|
||||||
|
- 0 equals no limit.
|
||||||
|
- Omitting the unit defaults to bytes.
|
||||||
- Maps docker service --limit-memory option.
|
- Maps docker service --limit-memory option.
|
||||||
reserve_memory:
|
reserve_memory:
|
||||||
required: false
|
required: false
|
||||||
default: 0
|
default: 0
|
||||||
description:
|
description:
|
||||||
- Service memory reservation in MB. 0 equals no reservation.
|
- "Service memory reservation (format: C(<number>[<unit>])). Number is a positive integer.
|
||||||
|
Unit can be C(B) (byte), C(K) (kibibyte, 1024B), C(M) (mebibyte), C(G) (gibibyte),
|
||||||
|
C(T) (tebibyte), or C(P) (pebibyte)."
|
||||||
|
- 0 equals no reservation.
|
||||||
|
- Omitting the unit defaults to bytes.
|
||||||
- Maps docker service --reserve-memory option.
|
- Maps docker service --reserve-memory option.
|
||||||
mode:
|
mode:
|
||||||
required: false
|
required: false
|
||||||
|
@ -170,6 +179,7 @@ options:
|
||||||
- List of dictionaries describing the service secrets.
|
- List of dictionaries describing the service secrets.
|
||||||
- Every item must be a dictionary exposing the keys secret_id, secret_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444)
|
- Every item must be a dictionary exposing the keys secret_id, secret_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444)
|
||||||
- Maps docker service --secret option.
|
- Maps docker service --secret option.
|
||||||
|
- Requires API version >= 1.25
|
||||||
default: []
|
default: []
|
||||||
configs:
|
configs:
|
||||||
required: false
|
required: false
|
||||||
|
@ -177,6 +187,7 @@ options:
|
||||||
- List of dictionaries describing the service configs.
|
- List of dictionaries describing the service configs.
|
||||||
- Every item must be a dictionary exposing the keys config_id, config_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444)
|
- Every item must be a dictionary exposing the keys config_id, config_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444)
|
||||||
- Maps docker service --config option.
|
- Maps docker service --config option.
|
||||||
|
- Requires API version >= 1.30
|
||||||
default: null
|
default: null
|
||||||
networks:
|
networks:
|
||||||
required: false
|
required: false
|
||||||
|
@ -191,7 +202,7 @@ options:
|
||||||
- List of dictionaries describing the service published ports.
|
- List of dictionaries describing the service published ports.
|
||||||
- Every item must be a dictionary exposing the keys published_port, target_port, protocol (defaults to 'tcp')
|
- Every item must be a dictionary exposing the keys published_port, target_port, protocol (defaults to 'tcp')
|
||||||
- Only used with api_version >= 1.25
|
- Only used with api_version >= 1.25
|
||||||
- If api_version >= 1.32 and docker python library >= 3.0.0 attribute 'mode' can be set to 'ingress' or 'host' (default 'ingress').
|
- If API version >= 1.32 and docker python library >= 3.0.0 attribute 'mode' can be set to 'ingress' or 'host' (default 'ingress').
|
||||||
replicas:
|
replicas:
|
||||||
required: false
|
required: false
|
||||||
default: -1
|
default: -1
|
||||||
|
@ -267,7 +278,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies the order of operations when rolling out an updated task.
|
- Specifies the order of operations when rolling out an updated task.
|
||||||
- Maps to docker service --update-order
|
- Maps to docker service --update-order
|
||||||
- Requires docker api version >= 1.29
|
- Requires API version >= 1.29
|
||||||
user:
|
user:
|
||||||
required: false
|
required: false
|
||||||
default: root
|
default: root
|
||||||
|
|
Loading…
Reference in a new issue