ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-04 23:44:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Fix M(). (#591)

Browse source 
* Fix M().

* Break long line.

* Fix the remaining M(...).

* Break long line.
This commit is contained in:
Felix Fontein 2020-06-29 14:59:15 +02:00 • committed by GitHub
commit 097aebadb0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
126 changed files with 155 additions and 198 deletions
Download patch file Download diff file Expand all files Collapse all files

2
plugins/modules/cloud/docker/docker_container.py
View file

@ -522,7 +522,7 @@ options:
- List of networks the container belongs to.
- For examples of the data structure and usage see EXAMPLES below.
- To remove a container from one or more networks, use the I(purge_networks) option.
- Note that as opposed to C(docker run ...), M(docker_container) does not remove the default
- Note that as opposed to C(docker run ...), M(community.general.docker_container) does not remove the default
network if I(networks) is specified. You need to explicitly use I(purge_networks) to enforce
the removal of the default network (and all other networks not explicitly mentioned in I(networks)).
Alternatively, use the I(networks_cli_compatible) option, which will be enabled by default from community.general 2.0.0 on.

2
plugins/modules/cloud/docker/docker_container_info.py
View file

@ -15,7 +15,7 @@ short_description: Retrieves facts about docker container
description:
- Retrieves facts about a docker container.
- Essentially returns the output of C(docker inspect <name>), similar to what M(docker_container)
- Essentially returns the output of C(docker inspect <name>), similar to what M(community.general.docker_container)
returns for a non-absent container.

2
plugins/modules/cloud/docker/docker_image_info.py
View file

@ -19,7 +19,7 @@ description:
- If an image does not exist locally, it will not appear in the results. If you want to check whether an image exists
locally, you can call the module with the image name, then check whether the result list is empty (image does not
exist) or has one element (the image exists locally).
- The module will not attempt to pull images from registries. Use M(docker_image) with I(source) set to C(pull)
- The module will not attempt to pull images from registries. Use M(community.general.docker_image) with I(source) set to C(pull)
to ensure an image is pulled.
notes:

4
plugins/modules/cloud/docker/docker_network.py
View file

@ -27,7 +27,7 @@ options:
- List of container names or container IDs to connect to a network.
- Please note that the module only makes sure that these containers are connected to the network,
but does not care about connection options. If you rely on specific IP addresses etc., use the
M(docker_container) module to ensure your containers are correctly connected to this network.
M(community.general.docker_container) module to ensure your containers are correctly connected to this network.
type: list
elements: str
aliases:
@ -180,7 +180,7 @@ notes:
- When network options are changed, the module disconnects all containers from the network, deletes the network, and re-creates the network.
It does not try to reconnect containers, except the ones listed in (I(connected), and even for these, it does not consider specific
connection options like fixed IP addresses or MAC addresses. If you need more control over how the containers are connected to the
network, loop the M(docker_container) module to loop over your containers to make sure they are connected properly.
network, loop the M(community.general.docker_container) module to loop over your containers to make sure they are connected properly.
- The module does not support Docker Swarm, i.e. it will not try to disconnect or reconnect services. If services are connected to the
network, deleting the network will fail. When network options are changed, the network has to be deleted and recreated, so this will
fail as well.

2
plugins/modules/cloud/docker/docker_network_info.py
View file

@ -15,7 +15,7 @@ short_description: Retrieves facts about docker network
description:
- Retrieves facts about a docker network.
- Essentially returns the output of C(docker network inspect <name>), similar to what M(docker_network)
- Essentially returns the output of C(docker network inspect <name>), similar to what M(community.general.docker_network)
returns for a non-absent network.

2
plugins/modules/cloud/docker/docker_node.py
View file

@ -26,7 +26,7 @@ options:
description:
- User-defined key/value metadata that will be assigned as node attribute.
- Label operations in this module apply to the docker swarm node specified by I(hostname).
Use M(docker_swarm) module to add/modify/remove swarm cluster labels.
Use M(community.general.docker_swarm) module to add/modify/remove swarm cluster labels.
- The actual state of labels assigned to the node when module completes its work depends on
I(labels_state) and I(labels_to_remove) parameters values. See description below.
type: dict

4
plugins/modules/cloud/docker/docker_swarm.py
View file

@ -139,7 +139,7 @@ options:
description:
- User-defined key/value metadata.
- Label operations in this module apply to the docker swarm cluster.
Use M(docker_node) module to add/modify/remove swarm node labels.
Use M(community.general.docker_node) module to add/modify/remove swarm node labels.
- Requires API version >= 1.32.
type: dict
signing_ca_cert:
@ -165,7 +165,7 @@ options:
description:
- If set, generate a key and use it to lock data stored on the managers.
- Docker default value is C(no).
- M(docker_swarm_info) can be used to retrieve the unlock key.
- M(community.general.docker_swarm_info) can be used to retrieve the unlock key.
type: bool
rotate_worker_token:
description: Rotate the worker join token.