mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
docker modules: add missing option types (#52422)
* Add missing option types for docker modules. * Reorder argument_spec. * First part of option reordering/reformatting. * Second part of option reordering/reformatting. * Forgot two required: false. * Normalize booleans. * Added missing period.
This commit is contained in:
parent
0e9ff44df1
commit
8388c89a29
18 changed files with 647 additions and 561 deletions
|
@ -32,111 +32,120 @@ description:
|
|||
|
||||
options:
|
||||
project_src:
|
||||
description:
|
||||
- Path to a directory containing a docker-compose.yml or docker-compose.yaml file.
|
||||
- Mutually exclusive with C(definition).
|
||||
- Required when no C(definition) is provided.
|
||||
description:
|
||||
- Path to a directory containing a docker-compose.yml or docker-compose.yaml file.
|
||||
- Mutually exclusive with C(definition).
|
||||
- Required when no C(definition) is provided.
|
||||
type: path
|
||||
project_name:
|
||||
description:
|
||||
- Provide a project name. If not provided, the project name is taken from the basename of C(project_src).
|
||||
- Required when C(definition) is provided.
|
||||
description:
|
||||
- Provide a project name. If not provided, the project name is taken from the basename of C(project_src).
|
||||
- Required when C(definition) is provided.
|
||||
type: str
|
||||
files:
|
||||
description:
|
||||
- List of file names relative to C(project_src). Overrides docker-compose.yml or docker-compose.yaml.
|
||||
- Files are loaded and merged in the order given.
|
||||
description:
|
||||
- List of file names relative to C(project_src). Overrides docker-compose.yml or docker-compose.yaml.
|
||||
- Files are loaded and merged in the order given.
|
||||
type: list
|
||||
state:
|
||||
description:
|
||||
- Desired state of the project.
|
||||
- Specifying I(present) is the same as running I(docker-compose up).
|
||||
- Specifying I(absent) is the same as running I(docker-compose down).
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
default: present
|
||||
description:
|
||||
- Desired state of the project.
|
||||
- Specifying I(present) is the same as running I(docker-compose up).
|
||||
- Specifying I(absent) is the same as running I(docker-compose down).
|
||||
type: str
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
services:
|
||||
description:
|
||||
- When C(state) is I(present) run I(docker-compose up) on a subset of services.
|
||||
description:
|
||||
- When C(state) is I(present) run I(docker-compose up) on a subset of services.
|
||||
type: list
|
||||
scale:
|
||||
description:
|
||||
- When C(state) is I(present) scale services. Provide a dictionary of key/value pairs where the key
|
||||
is the name of the service and the value is an integer count for the number of containers.
|
||||
description:
|
||||
- When C(state) is I(present) scale services. Provide a dictionary of key/value pairs where the key
|
||||
is the name of the service and the value is an integer count for the number of containers.
|
||||
type: dict
|
||||
dependencies:
|
||||
description:
|
||||
- When C(state) is I(present) specify whether or not to include linked services.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
description:
|
||||
- When C(state) is I(present) specify whether or not to include linked services.
|
||||
type: bool
|
||||
default: yes
|
||||
definition:
|
||||
description:
|
||||
- Provide docker-compose yaml describing one or more services, networks and volumes.
|
||||
- Mutually exclusive with C(project_src) and C(files).
|
||||
description:
|
||||
- Provide docker-compose yaml describing one or more services, networks and volumes.
|
||||
- Mutually exclusive with C(project_src) and C(files).
|
||||
type: dict
|
||||
hostname_check:
|
||||
description:
|
||||
- Whether or not to check the Docker daemon's hostname against the name provided in the client certificate.
|
||||
type: bool
|
||||
default: 'no'
|
||||
description:
|
||||
- Whether or not to check the Docker daemon's hostname against the name provided in the client certificate.
|
||||
type: bool
|
||||
default: no
|
||||
recreate:
|
||||
description:
|
||||
- By default containers will be recreated when their configuration differs from the service definition.
|
||||
- Setting to I(never) ignores configuration differences and leaves existing containers unchanged.
|
||||
- Setting to I(always) forces recreation of all existing containers.
|
||||
required: false
|
||||
choices:
|
||||
- always
|
||||
- never
|
||||
- smart
|
||||
default: smart
|
||||
description:
|
||||
- By default containers will be recreated when their configuration differs from the service definition.
|
||||
- Setting to I(never) ignores configuration differences and leaves existing containers unchanged.
|
||||
- Setting to I(always) forces recreation of all existing containers.
|
||||
type: str
|
||||
default: smart
|
||||
choices:
|
||||
- always
|
||||
- never
|
||||
- smart
|
||||
build:
|
||||
description:
|
||||
- Use with state I(present) to always build images prior to starting the application.
|
||||
- Same as running docker-compose build with the pull option.
|
||||
- Images will only be rebuilt if Docker detects a change in the Dockerfile or build directory contents.
|
||||
- Use the C(nocache) option to ignore the image cache when performing the build.
|
||||
- If an existing image is replaced, services using the image will be recreated unless C(recreate) is I(never).
|
||||
type: bool
|
||||
default: 'no'
|
||||
description:
|
||||
- Use with state I(present) to always build images prior to starting the application.
|
||||
- Same as running docker-compose build with the pull option.
|
||||
- Images will only be rebuilt if Docker detects a change in the Dockerfile or build directory contents.
|
||||
- Use the C(nocache) option to ignore the image cache when performing the build.
|
||||
- If an existing image is replaced, services using the image will be recreated unless C(recreate) is I(never).
|
||||
type: bool
|
||||
default: no
|
||||
pull:
|
||||
description:
|
||||
- Use with state I(present) to always pull images prior to starting the application.
|
||||
- Same as running docker-compose pull.
|
||||
- When a new image is pulled, services using the image will be recreated unless C(recreate) is I(never).
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- Use with state I(present) to always pull images prior to starting the application.
|
||||
- Same as running docker-compose pull.
|
||||
- When a new image is pulled, services using the image will be recreated unless C(recreate) is I(never).
|
||||
type: bool
|
||||
default: no
|
||||
version_added: "2.2"
|
||||
nocache:
|
||||
description:
|
||||
- Use with the build option to ignore the cache during the image build process.
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- Use with the build option to ignore the cache during the image build process.
|
||||
type: bool
|
||||
default: no
|
||||
version_added: "2.2"
|
||||
remove_images:
|
||||
description:
|
||||
- Use with state I(absent) to remove the all images or only local images.
|
||||
choices:
|
||||
- 'all'
|
||||
- 'local'
|
||||
description:
|
||||
- Use with state I(absent) to remove the all images or only local images.
|
||||
type: str
|
||||
choices:
|
||||
- 'all'
|
||||
- 'local'
|
||||
remove_volumes:
|
||||
description:
|
||||
- Use with state I(absent) to remove data volumes.
|
||||
type: bool
|
||||
default: 'no'
|
||||
description:
|
||||
- Use with state I(absent) to remove data volumes.
|
||||
type: bool
|
||||
default: no
|
||||
stopped:
|
||||
description:
|
||||
- Use with state I(present) to leave the containers in an exited or non-running state.
|
||||
type: bool
|
||||
default: 'no'
|
||||
description:
|
||||
- Use with state I(present) to leave the containers in an exited or non-running state.
|
||||
type: bool
|
||||
default: no
|
||||
restarted:
|
||||
description:
|
||||
- Use with state I(present) to restart all containers.
|
||||
type: bool
|
||||
default: 'no'
|
||||
description:
|
||||
- Use with state I(present) to restart all containers.
|
||||
type: bool
|
||||
default: no
|
||||
remove_orphans:
|
||||
description:
|
||||
- Remove containers for services not defined in the compose file.
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- Remove containers for services not defined in the compose file.
|
||||
type: bool
|
||||
default: no
|
||||
timeout:
|
||||
description:
|
||||
- timeout in seconds for container shutdown when attached or when containers are already running.
|
||||
type: int
|
||||
default: 10
|
||||
|
||||
extends_documentation_fragment:
|
||||
|
@ -1033,10 +1042,10 @@ def main():
|
|||
project_src=dict(type='path'),
|
||||
project_name=dict(type='str',),
|
||||
files=dict(type='list', elements='path'),
|
||||
state=dict(type='str', choices=['absent', 'present'], default='present'),
|
||||
state=dict(type='str', default='present', choices=['absent', 'present']),
|
||||
definition=dict(type='dict'),
|
||||
hostname_check=dict(type='bool', default=False),
|
||||
recreate=dict(type='str', choices=['always', 'never', 'smart'], default='smart'),
|
||||
recreate=dict(type='str', default='smart', choices=['always', 'never', 'smart']),
|
||||
build=dict(type='bool', default=False),
|
||||
remove_images=dict(type='str', choices=['all', 'local']),
|
||||
remove_volumes=dict(type='bool', default=False),
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue