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

Fix linting errors.

Browse Source
This commit is contained in:
Felix Fontein
2025-04-26 11:20:32 +02:00
parent 795e6b23dc
commit 2487d1a0bf
125 changed files with 5778 additions and 5662 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/modules/current_container_facts.py
+1
View File
@@ -27,6 +27,7 @@ extends_documentation_fragment:
"""
EXAMPLES = r"""
---
- name: Get facts on current container
community.docker.current_container_facts:
plugins/modules/docker_compose_v2.py
+1
View File
@@ -178,6 +178,7 @@ seealso:
"""
EXAMPLES = r"""
---
# Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the
# flask directory
plugins/modules/docker_compose_v2_exec.py
+1
View File
@@ -119,6 +119,7 @@ notes:
"""
EXAMPLES = r"""
---
- name: Run a simple command (command)
community.docker.docker_compose_v2_exec:
service: foo
plugins/modules/docker_compose_v2_pull.py
+1
View File
@@ -75,6 +75,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Pull images for flask project
community.docker.docker_compose_v2_pull:
project_src: /path/to/flask
plugins/modules/docker_compose_v2_run.py
+1
View File
@@ -187,6 +187,7 @@ notes:
"""
EXAMPLES = r"""
---
- name: Run a simple command (command)
community.docker.docker_compose_v2_run:
service: foo
plugins/modules/docker_config.py
+1
View File
@@ -111,6 +111,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Create config foo (from a file on the control machine)
community.docker.docker_config:
name: foo
plugins/modules/docker_container.py
+1
View File
@@ -996,6 +996,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Create a data container
community.docker.docker_container:
name: mydata
plugins/modules/docker_container_copy_into.py
+1
View File
@@ -120,6 +120,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Copy a file into the container
community.docker.docker_container_copy_into:
container: mydata
plugins/modules/docker_container_exec.py
+1
View File
@@ -111,6 +111,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Run a simple command (command)
community.docker.docker_container_exec:
container: foo
plugins/modules/docker_container_info.py
+1
View File
@@ -40,6 +40,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get infos on container
community.docker.docker_container_info:
name: mydata
plugins/modules/docker_context_info.py
+1
View File
@@ -51,6 +51,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Get infos on contexts
community.docker.docker_context_info:
register: result
plugins/modules/docker_host_info.py
+1
View File
@@ -122,6 +122,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get info on docker host
community.docker.docker_host_info:
register: result
plugins/modules/docker_image.py
+1
View File
@@ -263,6 +263,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Pull an image
community.docker.docker_image:
name: pacur/centos-7
plugins/modules/docker_image_build.py
+1
View File
@@ -248,6 +248,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Build Python 3.12 image
community.docker.docker_image_build:
name: localhost/python/3.12:latest
plugins/modules/docker_image_export.py
+1
View File
@@ -71,6 +71,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Export an image
community.docker.docker_image_export:
name: pacur/centos-7
plugins/modules/docker_image_info.py
+63 -14
View File
@@ -46,6 +46,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Inspect a single image
community.docker.docker_image_info:
name: pacur/centos-7
@@ -71,20 +72,68 @@ images:
returned: always
type: list
elements: dict
sample: [{"Architecture": "amd64", "Author": "", "Comment": "", "Config": {"AttachStderr": false, "AttachStdin": false,
"AttachStdout": false, "Cmd": ["/etc/docker/registry/config.yml"], "Domainname": "", "Entrypoint": ["/bin/registry"],
"Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"], "ExposedPorts": {"5000/tcp": {}},
"Hostname": "e5c68db50333", "Image": "c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799", "Labels": {},
"OnBuild": [], "OpenStdin": false, "StdinOnce": false, "Tty": false, "User": "", "Volumes": {"/var/lib/registry": {}},
"WorkingDir": ""}, "Container": "e83a452b8fb89d78a25a6739457050131ca5c863629a47639530d9ad2008d610", "ContainerConfig": {
"AttachStderr": false, "AttachStdin": false, "AttachStdout": false, "Cmd": ["/bin/sh", "-c", '#(nop) CMD ["/etc/docker/registry/config.yml"]'],
"Domainname": "", "Entrypoint": ["/bin/registry"], "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"],
"ExposedPorts": {"5000/tcp": {}}, "Hostname": "e5c68db50333", "Image": "c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799",
"Labels": {}, "OnBuild": [], "OpenStdin": false, "StdinOnce": false, "Tty": false, "User": "", "Volumes": {"/var/lib/registry": {}},
"WorkingDir": ""}, "Created": "2016-03-08T21:08:15.399680378Z", "DockerVersion": "1.9.1", "GraphDriver": {"Data": null,
"Name": "aufs"}, "Id": "53773d8552f07b730f3e19979e32499519807d67b344141d965463a950a66e08", "Name": "registry:2",
"Os": "linux", "Parent": "f0b1f729f784b755e7bf9c8c2e65d8a0a35a533769c2588f02895f6781ac0805", "RepoDigests": [], "RepoTags": [
"registry:2"], "Size": 0, "VirtualSize": 165808884}]
sample: [
{
"Architecture": "amd64",
"Author": "",
"Comment": "",
"Config": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": ["/etc/docker/registry/config.yml"],
"Domainname": "",
"Entrypoint": ["/bin/registry"],
"Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"],
"ExposedPorts": {"5000/tcp": {}},
"Hostname": "e5c68db50333",
"Image": "c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799",
"Labels": {},
"OnBuild": [],
"OpenStdin": false,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": {"/var/lib/registry": {}},
"WorkingDir": "",
},
"Container": "e83a452b8fb89d78a25a6739457050131ca5c863629a47639530d9ad2008d610",
"ContainerConfig": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": ["/bin/sh", "-c", '#(nop) CMD ["/etc/docker/registry/config.yml"]'],
"Domainname": "",
"Entrypoint": ["/bin/registry"],
"Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"],
"ExposedPorts": {"5000/tcp": {}},
"Hostname": "e5c68db50333",
"Image": "c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799",
"Labels": {},
"OnBuild": [],
"OpenStdin": false,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": {"/var/lib/registry": {}},
"WorkingDir": "",
},
"Created": "2016-03-08T21:08:15.399680378Z",
"DockerVersion": "1.9.1",
"GraphDriver": {
"Data": null,
"Name": "aufs",
},
"Id": "53773d8552f07b730f3e19979e32499519807d67b344141d965463a950a66e08",
"Name": "registry:2",
"Os": "linux",
"Parent": "f0b1f729f784b755e7bf9c8c2e65d8a0a35a533769c2588f02895f6781ac0805",
"RepoDigests": [],
"RepoTags": ["registry:2"],
"Size": 0,
"VirtualSize": 165808884,
},
]
"""
import traceback
plugins/modules/docker_image_load.py
+1
View File
@@ -52,6 +52,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Load all image(s) from the given tar file
community.docker.docker_image_load:
path: /path/to/images.tar
plugins/modules/docker_image_pull.py
+1
View File
@@ -75,6 +75,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Pull an image
community.docker.docker_image_pull:
name: pacur/centos-7
plugins/modules/docker_image_push.py
+1
View File
@@ -57,6 +57,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Push an image
community.docker.docker_image_push:
name: registry.example.com:5000/repo/image
plugins/modules/docker_image_remove.py
+1
View File
@@ -68,6 +68,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Remove an image
community.docker.docker_image_remove:
name: pacur/centos-7
plugins/modules/docker_image_tag.py
+1
View File
@@ -76,6 +76,7 @@ seealso:
"""
EXAMPLES = r"""
---
- name: Tag Python 3.12 image with two new names
community.docker.docker_image_tag:
name: python:3.12
plugins/modules/docker_login.py
+1
View File
@@ -85,6 +85,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Log into DockerHub
community.docker.docker_login:
username: docker
plugins/modules/docker_network.py
+1
View File
@@ -203,6 +203,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Create a network
community.docker.docker_network:
name: network_one
plugins/modules/docker_network_info.py
+27 -4
View File
@@ -40,6 +40,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get infos on network
community.docker.docker_network_info:
name: mydata
@@ -68,10 +69,32 @@ network:
- Will be V(none) if network does not exist.
returned: always
type: dict
sample: {"Attachable": false, "ConfigFrom": {"Network": ""}, "ConfigOnly": false, "Containers": {}, "Created": "2018-12-07T01:47:51.250835114-06:00",
"Driver": "bridge", "EnableIPv6": false, "IPAM": {"Config": [{"Gateway": "192.168.96.1", "Subnet": "192.168.96.0/20"}],
"Driver": "default", "Options": null}, "Id": "0856968545f22026c41c2c7c3d448319d3b4a6a03a40b148b3ac4031696d1c0a", "Ingress": false,
"Internal": false, "Labels": {}, "Name": "ansible-test-f2700bba", "Options": {}, "Scope": "local"}
sample: {
"Attachable": false,
"ConfigFrom": {"Network": ""},
"ConfigOnly": false,
"Containers": {},
"Created": "2018-12-07T01:47:51.250835114-06:00",
"Driver": "bridge",
"EnableIPv6": false,
"IPAM": {
"Config": [
{
"Gateway": "192.168.96.1",
"Subnet": "192.168.96.0/20",
},
],
"Driver": "default",
"Options": null,
},
"Id": "0856968545f22026c41c2c7c3d448319d3b4a6a03a40b148b3ac4031696d1c0a",
"Ingress": false,
"Internal": false,
"Labels": {},
"Name": "ansible-test-f2700bba",
"Options": {},
"Scope": "local",
}
"""
import traceback
plugins/modules/docker_node.py
+1
View File
@@ -90,6 +90,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Set node role
community.docker.docker_node:
hostname: mynode
plugins/modules/docker_node_info.py
+1
View File
@@ -52,6 +52,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get info on all nodes
community.docker.docker_node_info:
register: result
plugins/modules/docker_plugin.py
+1
View File
@@ -86,6 +86,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Install a plugin
community.docker.docker_plugin:
plugin_name: plugin_one
plugins/modules/docker_prune.py
+1
View File
@@ -114,6 +114,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Prune containers older than 24h
community.docker.docker_prune:
containers: true
plugins/modules/docker_secret.py
+1
View File
@@ -103,6 +103,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Create secret foo (from a file on the control machine)
community.docker.docker_secret:
name: foo
plugins/modules/docker_stack.py
+1
View File
@@ -128,6 +128,7 @@ stack_spec_diff:
"""
EXAMPLES = r"""
---
- name: Deploy stack from a compose file
community.docker.docker_stack:
state: present
plugins/modules/docker_stack_info.py
+1
View File
@@ -66,6 +66,7 @@ results:
"""
EXAMPLES = r"""
---
- name: Shows stack info
community.docker.docker_stack_info:
register: result
plugins/modules/docker_stack_task_info.py
+9 -2
View File
@@ -59,14 +59,21 @@ results:
description:
- List of dictionaries containing the list of tasks associated to a stack name.
sample:
- {"CurrentState": "Running", "DesiredState": "Running", "Error": "", "ID": "7wqv6m02ugkw", "Image": "busybox", "Name": "test_stack.1",
"Node": "swarm", "Ports": ""}
- CurrentState: Running
DesiredState: Running
Error: ""
ID: 7wqv6m02ugkw
Image: busybox
Name: test_stack.1
Node: swarm
Ports: ""
returned: always
type: list
elements: dict
"""
EXAMPLES = r"""
---
- name: Shows stack info
community.docker.docker_stack_task_info:
name: test_stack
plugins/modules/docker_swarm.py
+1
View File
@@ -206,6 +206,7 @@ author:
"""
EXAMPLES = r"""
---
- name: Init a new swarm with default parameters
community.docker.docker_swarm:
state: present
plugins/modules/docker_swarm_info.py
+1
View File
@@ -89,6 +89,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get info on Docker Swarm
community.docker.docker_swarm_info:
ignore_errors: true
plugins/modules/docker_swarm_service.py
+1
View File
@@ -694,6 +694,7 @@ rebuilt:
"""
EXAMPLES = r"""
---
- name: Set command and arguments
community.docker.docker_swarm_service:
name: myservice
plugins/modules/docker_swarm_service_info.py
+1
View File
@@ -41,6 +41,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get info from a service
community.docker.docker_swarm_service_info:
name: myservice
plugins/modules/docker_volume.py
+1
View File
@@ -91,6 +91,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Create a volume
community.docker.docker_volume:
name: volume_one
plugins/modules/docker_volume_info.py
+1
View File
@@ -38,6 +38,7 @@ requirements:
"""
EXAMPLES = r"""
---
- name: Get infos on volume
community.docker.docker_volume_info:
name: mydata