ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Correct Errors in Documentation (#50507)

Browse source 
* Correct Errors in Documentation

According to the module, "compose" is not required, but the docs said it was - removed the "required" tag. Additionally, the example for removing a stack did not include the required "name" option (this method is why "compose" is not required.
+label: docsite_pr

* Removed change to description

Corrected issue to my "correction" on the description.

* Removed required false

* Removed all instances of required: false.
This commit is contained in:
UNR Information Security 2019-01-04 02:16:16 -08:00 committed by ansibot
parent 83da2de9a0
commit 8f55e817d2
1 changed files with 1 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
lib/ansible/modules/cloud/docker/docker_stack.py
View file

@ -35,14 +35,12 @@ options:
- present - present
- absent - absent
compose: compose:
required: true
default: [] default: []
description: description:
- List of compose definitions. Any element may be a string - List of compose definitions. Any element may be a string
referring to the path of the compose file on the target host referring to the path of the compose file on the target host
or the YAML contents of a compose file nested as dictionary. or the YAML contents of a compose file nested as dictionary.
prune: prune:
required: false
default: false default: false
description: description:
- If true will add the C(--prune) option to the C(docker stack deploy) command. - If true will add the C(--prune) option to the C(docker stack deploy) command.
@ -50,21 +48,18 @@ options:
current stack definition. current stack definition.
type: bool type: bool
with_registry_auth: with_registry_auth:
required: false
default: false default: false
description: description:
- If true will add the C(--with-registry-auth) option to the C(docker stack deploy) command. - If true will add the C(--with-registry-auth) option to the C(docker stack deploy) command.
This will have docker send registry authentication details to Swarm agents. This will have docker send registry authentication details to Swarm agents.
type: bool type: bool
resolve_image: resolve_image:
required: false
choices: ["always", "changed", "never"] choices: ["always", "changed", "never"]
description: description:
- If set will add the C(--resolve-image) option to the C(docker stack deploy) command. - If set will add the C(--resolve-image) option to the C(docker stack deploy) command.
This will have docker query the registry to resolve image digest and This will have docker query the registry to resolve image digest and
supported platforms. If not set, docker use "always" by default. supported platforms. If not set, docker use "always" by default.
absent_retries: absent_retries:
required: false
default: 0 default: 0
description: description:
- If C(>0) and C(state==absent) the module will retry up to - If C(>0) and C(state==absent) the module will retry up to
@ -73,7 +68,6 @@ options:
If the last try still reports the stack as not completely If the last try still reports the stack as not completely
removed the module will fail. removed the module will fail.
absent_retries_interval: absent_retries_interval:
required: false
default: 1 default: 1
description: description:
- Interval in seconds between C(absent_retries) - Interval in seconds between C(absent_retries)
@ -119,6 +113,7 @@ EXAMPLES = '''
- name: deprovision 'stack1' - name: deprovision 'stack1'
docker_stack: docker_stack:
name: stack1
state: absent state: absent
''' '''