Reformat documentation with 'andebox yaml-doc'.

ansible-collections · Dec 28, 2024 · 479c4d1 · 479c4d1
1 parent f69536e
commit 479c4d1
Show file tree

Hide file tree

Showing 46 changed files with 2,072 additions and 2,527 deletions.
diff --git a/plugins/connection/docker.py b/plugins/connection/docker.py
@@ -10,116 +10,107 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 author:
-    - Lorin Hochestein (!UNKNOWN)
-    - Leendert Brouwer (!UNKNOWN)
+  - Lorin Hochestein (!UNKNOWN)
+  - Leendert Brouwer (!UNKNOWN)
 name: docker
 short_description: Run tasks in docker containers
 description:
-    - Run commands or put/fetch files to an existing docker container.
-    - Uses the Docker CLI to execute commands in the container. If you prefer
-      to directly connect to the Docker daemon, use the
-      P(community.docker.docker_api#connection) connection plugin.
+  - Run commands or put/fetch files to an existing docker container.
+  - Uses the Docker CLI to execute commands in the container. If you prefer to directly connect to the Docker daemon, use
+    the P(community.docker.docker_api#connection) connection plugin.
 options:
-    remote_addr:
-        description:
-            - The name of the container you want to access.
-        default: inventory_hostname
-        vars:
-            - name: inventory_hostname
-            - name: ansible_host
-            - name: ansible_docker_host
-    remote_user:
-        description:
-            - The user to execute as inside the container.
-            - If Docker is too old to allow this (< 1.7), the one set by Docker itself will be used.
-        vars:
-            - name: ansible_user
-            - name: ansible_docker_user
-        ini:
-            - section: defaults
-              key: remote_user
-        env:
-            - name: ANSIBLE_REMOTE_USER
-        cli:
-            - name: user
-        keyword:
-            - name: remote_user
-    docker_extra_args:
-        description:
-            - Extra arguments to pass to the docker command line.
-        default: ''
-        vars:
-            - name: ansible_docker_extra_args
-        ini:
-            - section: docker_connection
-              key: extra_cli_args
-    container_timeout:
-        default: 10
-        description:
-            - Controls how long we can wait to access reading output from the container once execution started.
-        env:
-            - name: ANSIBLE_TIMEOUT
-            - name: ANSIBLE_DOCKER_TIMEOUT
-              version_added: 2.2.0
-        ini:
-            - key: timeout
-              section: defaults
-            - key: timeout
-              section: docker_connection
-              version_added: 2.2.0
-        vars:
-          - name: ansible_docker_timeout
-            version_added: 2.2.0
-        cli:
-          - name: timeout
-        type: integer
-    extra_env:
-        description:
-          - Provide extra environment variables to set when running commands in the Docker container.
-          - This option can currently only be provided as Ansible variables due to limitations of
-            ansible-core's configuration manager.
-        # env:
-        #   - name: ANSIBLE_DOCKER_EXTRA_ENV
-        # ini:
-        #   - key: extra_env
-        #     section: docker_connection
-        # ansible-core's config manager does NOT support converting JSON strings (or other things) to dictionaries,
-        # it only accepts actual dictionaries (which do not happen to come from env and ini vars). So there's no way
-        # to actually provide this parameter from env and ini sources... :-(
-        vars:
-          - name: ansible_docker_extra_env
-        type: dict
-        version_added: 3.12.0
-    working_dir:
-        description:
-          - The directory inside the container to run commands in.
-          - Requires Docker CLI version 18.06 or later.
-        env:
-          - name: ANSIBLE_DOCKER_WORKING_DIR
-        ini:
-          - key: working_dir
-            section: docker_connection
-        vars:
-          - name: ansible_docker_working_dir
-        type: string
-        version_added: 3.12.0
-    privileged:
-        description:
-          - Whether commands should be run with extended privileges.
-          - B(Note) that this allows command to potentially break out of the container. Use with care!
-        env:
-          - name: ANSIBLE_DOCKER_PRIVILEGED
-        ini:
-          - key: privileged
-            section: docker_connection
-        vars:
-          - name: ansible_docker_privileged
-        type: boolean
-        default: false
-        version_added: 3.12.0
-'''
+  remote_addr:
+    description:
+      - The name of the container you want to access.
+    default: inventory_hostname
+    vars:
+      - name: inventory_hostname
+      - name: ansible_host
+      - name: ansible_docker_host
+  remote_user:
+    description:
+      - The user to execute as inside the container.
+      - If Docker is too old to allow this (< 1.7), the one set by Docker itself will be used.
+    vars:
+      - name: ansible_user
+      - name: ansible_docker_user
+    ini:
+      - section: defaults
+        key: remote_user
+    env:
+      - name: ANSIBLE_REMOTE_USER
+    cli:
+      - name: user
+    keyword:
+      - name: remote_user
+  docker_extra_args:
+    description:
+      - Extra arguments to pass to the docker command line.
+    default: ''
+    vars:
+      - name: ansible_docker_extra_args
+    ini:
+      - section: docker_connection
+        key: extra_cli_args
+  container_timeout:
+    default: 10
+    description:
+      - Controls how long we can wait to access reading output from the container once execution started.
+    env:
+      - name: ANSIBLE_TIMEOUT
+      - name: ANSIBLE_DOCKER_TIMEOUT
+        version_added: 2.2.0
+    ini:
+      - key: timeout
+        section: defaults
+      - key: timeout
+        section: docker_connection
+        version_added: 2.2.0
+    vars:
+      - name: ansible_docker_timeout
+        version_added: 2.2.0
+    cli:
+      - name: timeout
+    type: integer
+  extra_env:
+    description:
+      - Provide extra environment variables to set when running commands in the Docker container.
+      - This option can currently only be provided as Ansible variables due to limitations of ansible-core's configuration
+        manager.
+    vars:
+      - name: ansible_docker_extra_env
+    type: dict
+    version_added: 3.12.0
+  working_dir:
+    description:
+      - The directory inside the container to run commands in.
+      - Requires Docker CLI version 18.06 or later.
+    env:
+      - name: ANSIBLE_DOCKER_WORKING_DIR
+    ini:
+      - key: working_dir
+        section: docker_connection
+    vars:
+      - name: ansible_docker_working_dir
+    type: string
+    version_added: 3.12.0
+  privileged:
+    description:
+      - Whether commands should be run with extended privileges.
+      - B(Note) that this allows command to potentially break out of the container. Use with care!
+    env:
+      - name: ANSIBLE_DOCKER_PRIVILEGED
+    ini:
+      - key: privileged
+        section: docker_connection
+    vars:
+      - name: ansible_docker_privileged
+    type: boolean
+    default: false
+    version_added: 3.12.0
+"""
 
 import fcntl
 import os