ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2026-07-29 11:55:04 +00:00
Code Packages Projects Releases Wiki Activity

Improve documentation (#278)

Browse Source 
* Improve documentation.

* More fixes.
This commit is contained in:
Felix Fontein
2022-01-09 14:52:44 +01:00
committed by GitHub
parent 9ca2c61848
commit 3d20ba1bc2
12 changed files with 40 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/modules/docker_volume.py
+4 -4
View File
@@ -13,7 +13,7 @@ module: docker_volume
short_description: Manage Docker volumes
description:
- Create/remove Docker volumes.
- Performs largely the same function as the "docker volume" CLI subcommand.
- Performs largely the same function as the C(docker volume) CLI subcommand.
options:
volume_name:
description:
@@ -32,7 +32,7 @@ options:
driver_options:
description:
- "Dictionary of volume settings. Consult docker docs for valid options and values:
U(https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options)"
U(https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options)."
type: dict
labels:
@@ -43,8 +43,8 @@ options:
recreate:
description:
- Controls when a volume will be recreated when I(state) is C(present). Please
note that recreating an existing volume will cause **any data in the existing volume
to be lost!** The volume will be deleted and a new volume with the same name will be
note that recreating an existing volume will cause B(any data in the existing volume
to be lost!) The volume will be deleted and a new volume with the same name will be
created.
- The value C(always) forces the volume to be always recreated.
- The value C(never) makes sure the volume will not be recreated.