From 3e9bc5bb84993ff58a1d3d50855d3d61e5cfc605 Mon Sep 17 00:00:00 2001 From: felixfontein Date: Sat, 26 Apr 2025 10:48:52 +0000 Subject: [PATCH] deploy: 2487d1a0bf4f2c79d3ab5a9e7d0f969432bf32a2 --- branch/main/current_container_facts_module.html | 3 ++- branch/main/docker_compose_v2_exec_module.html | 3 ++- branch/main/docker_compose_v2_module.html | 3 ++- branch/main/docker_compose_v2_pull_module.html | 3 ++- branch/main/docker_compose_v2_run_module.html | 3 ++- branch/main/docker_config_module.html | 3 ++- branch/main/docker_container_copy_into_module.html | 3 ++- branch/main/docker_container_exec_module.html | 3 ++- branch/main/docker_container_info_module.html | 3 ++- branch/main/docker_container_module.html | 3 ++- branch/main/docker_context_info_module.html | 3 ++- branch/main/docker_host_info_module.html | 3 ++- branch/main/docker_image_build_module.html | 3 ++- branch/main/docker_image_export_module.html | 3 ++- branch/main/docker_image_info_module.html | 3 ++- branch/main/docker_image_load_module.html | 3 ++- branch/main/docker_image_module.html | 3 ++- branch/main/docker_image_pull_module.html | 3 ++- branch/main/docker_image_push_module.html | 3 ++- branch/main/docker_image_remove_module.html | 3 ++- branch/main/docker_image_tag_module.html | 3 ++- branch/main/docker_login_module.html | 3 ++- branch/main/docker_network_info_module.html | 3 ++- branch/main/docker_network_module.html | 3 ++- branch/main/docker_node_info_module.html | 3 ++- branch/main/docker_node_module.html | 3 ++- branch/main/docker_plugin_module.html | 3 ++- branch/main/docker_prune_module.html | 3 ++- branch/main/docker_secret_module.html | 3 ++- branch/main/docker_stack_info_module.html | 3 ++- branch/main/docker_stack_module.html | 3 ++- branch/main/docker_stack_task_info_module.html | 3 ++- branch/main/docker_swarm_info_module.html | 3 ++- branch/main/docker_swarm_module.html | 3 ++- branch/main/docker_swarm_service_info_module.html | 3 ++- branch/main/docker_swarm_service_module.html | 3 ++- branch/main/docker_volume_info_module.html | 3 ++- branch/main/docker_volume_module.html | 3 ++- 38 files changed, 76 insertions(+), 38 deletions(-) diff --git a/branch/main/current_container_facts_module.html b/branch/main/current_container_facts_module.html index ccd14053..e728ef17 100644 --- a/branch/main/current_container_facts_module.html +++ b/branch/main/current_container_facts_module.html @@ -245,7 +245,8 @@ To check whether it is installed, run

Examples

-
- name: Get facts on current container
+
---
+- name: Get facts on current container
   community.docker.current_container_facts:
 
 - name: Print information on current container when running in a container
diff --git a/branch/main/docker_compose_v2_exec_module.html b/branch/main/docker_compose_v2_exec_module.html
index a2a7a31c..ad91e362 100644
--- a/branch/main/docker_compose_v2_exec_module.html
+++ b/branch/main/docker_compose_v2_exec_module.html
@@ -599,7 +599,8 @@ will change over time. New releases of the Docker compose CLI plugin can break t
 
 

 
Examples

-
- name: Run a simple command (command)
+
---
+- name: Run a simple command (command)
   community.docker.docker_compose_v2_exec:
     service: foo
     command: /bin/bash -c "ls -lah"
diff --git a/branch/main/docker_compose_v2_module.html b/branch/main/docker_compose_v2_module.html
index e29e8e75..63e1db58 100644
--- a/branch/main/docker_compose_v2_module.html
+++ b/branch/main/docker_compose_v2_module.html
@@ -679,7 +679,8 @@ will change over time. New releases of the Docker compose CLI plugin can break t
 

 

 
Examples

-
# Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the
+
---
+# Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the
 # flask directory
 
 - name: Run using a project directory
diff --git a/branch/main/docker_compose_v2_pull_module.html b/branch/main/docker_compose_v2_pull_module.html
index e453df43..a57010ae 100644
--- a/branch/main/docker_compose_v2_pull_module.html
+++ b/branch/main/docker_compose_v2_pull_module.html
@@ -523,7 +523,8 @@ will change over time. New releases of the Docker compose CLI plugin can break t
 

 

 
Examples

-
- name: Pull images for flask project
+
---
+- name: Pull images for flask project
   community.docker.docker_compose_v2_pull:
     project_src: /path/to/flask
 

diff --git a/branch/main/docker_compose_v2_run_module.html b/branch/main/docker_compose_v2_run_module.html
index 03dd2eb3..06cbd5bd 100644
--- a/branch/main/docker_compose_v2_run_module.html
+++ b/branch/main/docker_compose_v2_run_module.html
@@ -728,7 +728,8 @@ will change over time. New releases of the Docker compose CLI plugin can break t
 

 

 
Examples

-
- name: Run a simple command (command)
+
---
+- name: Run a simple command (command)
   community.docker.docker_compose_v2_run:
     service: foo
     command: /bin/bash -c "ls -lah"
diff --git a/branch/main/docker_config_module.html b/branch/main/docker_config_module.html
index ff170158..3c42c003 100644
--- a/branch/main/docker_config_module.html
+++ b/branch/main/docker_config_module.html
@@ -523,7 +523,8 @@ see 
 
Examples

-
- name: Create config foo (from a file on the control machine)
+
---
+- name: Create config foo (from a file on the control machine)
   community.docker.docker_config:
     name: foo
     # If the file is JSON or binary, Ansible might modify it (because
diff --git a/branch/main/docker_container_copy_into_module.html b/branch/main/docker_container_copy_into_module.html
index f1ab0202..bd6a22ae 100644
--- a/branch/main/docker_container_copy_into_module.html
+++ b/branch/main/docker_container_copy_into_module.html
@@ -531,7 +531,8 @@ see 
 
Examples

-
- name: Copy a file into the container
+
---
+- name: Copy a file into the container
   community.docker.docker_container_copy_into:
     container: mydata
     path: /home/user/data.txt
diff --git a/branch/main/docker_container_exec_module.html b/branch/main/docker_container_exec_module.html
index 6eb92e74..4613e179 100644
--- a/branch/main/docker_container_exec_module.html
+++ b/branch/main/docker_container_exec_module.html
@@ -521,7 +521,8 @@ see 
 
Examples

-
- name: Run a simple command (command)
+
---
+- name: Run a simple command (command)
   community.docker.docker_container_exec:
     container: foo
     command: /bin/bash -c "ls -lah"
diff --git a/branch/main/docker_container_info_module.html b/branch/main/docker_container_info_module.html
index 26120848..23bf2a72 100644
--- a/branch/main/docker_container_info_module.html
+++ b/branch/main/docker_container_info_module.html
@@ -423,7 +423,8 @@ see 
 
Examples

-
- name: Get infos on container
+
---
+- name: Get infos on container
   community.docker.docker_container_info:
     name: mydata
   register: result
diff --git a/branch/main/docker_container_module.html b/branch/main/docker_container_module.html
index fe456a62..f9370539 100644
--- a/branch/main/docker_container_module.html
+++ b/branch/main/docker_container_module.html
@@ -1724,7 +1724,8 @@ see 
 
Examples

-
- name: Create a data container
+
---
+- name: Create a data container
   community.docker.docker_container:
     name: mydata
     image: busybox
diff --git a/branch/main/docker_context_info_module.html b/branch/main/docker_context_info_module.html
index d45b5e12..83109bd1 100644
--- a/branch/main/docker_context_info_module.html
+++ b/branch/main/docker_context_info_module.html
@@ -282,7 +282,8 @@ To check whether it is installed, run 
 
Examples

-
- name: Get infos on contexts
+
---
+- name: Get infos on contexts
   community.docker.docker_context_info:
   register: result
 
diff --git a/branch/main/docker_host_info_module.html b/branch/main/docker_host_info_module.html
index 0e351c90..6875044d 100644
--- a/branch/main/docker_host_info_module.html
+++ b/branch/main/docker_host_info_module.html
@@ -544,7 +544,8 @@ see 
 
Examples

-
- name: Get info on docker host
+
---
+- name: Get info on docker host
   community.docker.docker_host_info:
   register: result
 
diff --git a/branch/main/docker_image_build_module.html b/branch/main/docker_image_build_module.html
index bd4755e8..c5a31ee0 100644
--- a/branch/main/docker_image_build_module.html
+++ b/branch/main/docker_image_build_module.html
@@ -679,7 +679,8 @@ Provides the secret from a given value 
 
Examples

-
- name: Build Python 3.12 image
+
---
+- name: Build Python 3.12 image
   community.docker.docker_image_build:
     name: localhost/python/3.12:latest
     path: /home/user/images/python
diff --git a/branch/main/docker_image_export_module.html b/branch/main/docker_image_export_module.html
index 73dfd4c1..c52f675f 100644
--- a/branch/main/docker_image_export_module.html
+++ b/branch/main/docker_image_export_module.html
@@ -467,7 +467,8 @@ see 
 
Examples

-
- name: Export an image
+
---
+- name: Export an image
   community.docker.docker_image_export:
     name: pacur/centos-7
     path: /tmp/centos-7.tar
diff --git a/branch/main/docker_image_info_module.html b/branch/main/docker_image_info_module.html
index 24b548ff..781bfc44 100644
--- a/branch/main/docker_image_info_module.html
+++ b/branch/main/docker_image_info_module.html
@@ -425,7 +425,8 @@ see 
 
Examples

-
- name: Inspect a single image
+
---
+- name: Inspect a single image
   community.docker.docker_image_info:
     name: pacur/centos-7
 
diff --git a/branch/main/docker_image_load_module.html b/branch/main/docker_image_load_module.html
index c61a301a..027d2107 100644
--- a/branch/main/docker_image_load_module.html
+++ b/branch/main/docker_image_load_module.html
@@ -437,7 +437,8 @@ see 
 
Examples

-
- name: Load all image(s) from the given tar file
+
---
+- name: Load all image(s) from the given tar file
   community.docker.docker_image_load:
     path: /path/to/images.tar
   register: result
diff --git a/branch/main/docker_image_module.html b/branch/main/docker_image_module.html
index fe639117..22bb4c64 100644
--- a/branch/main/docker_image_module.html
+++ b/branch/main/docker_image_module.html
@@ -757,7 +757,8 @@ see 
 
Examples

-
- name: Pull an image
+
---
+- name: Pull an image
   community.docker.docker_image:
     name: pacur/centos-7
     source: pull
diff --git a/branch/main/docker_image_pull_module.html b/branch/main/docker_image_pull_module.html
index 986ebb16..78a159b0 100644
--- a/branch/main/docker_image_pull_module.html
+++ b/branch/main/docker_image_pull_module.html
@@ -468,7 +468,8 @@ see 
 
Examples

-
- name: Pull an image
+
---
+- name: Pull an image
   community.docker.docker_image_pull:
     name: pacur/centos-7
     # Select platform for pulling. If not specified, will pull whatever docker prefers.
diff --git a/branch/main/docker_image_push_module.html b/branch/main/docker_image_push_module.html
index 28681603..aba3ddcd 100644
--- a/branch/main/docker_image_push_module.html
+++ b/branch/main/docker_image_push_module.html
@@ -445,7 +445,8 @@ see 
 
Examples

-
- name: Push an image
+
---
+- name: Push an image
   community.docker.docker_image_push:
     name: registry.example.com:5000/repo/image
     tag: latest
diff --git a/branch/main/docker_image_remove_module.html b/branch/main/docker_image_remove_module.html
index fdc3ca81..9f631197 100644
--- a/branch/main/docker_image_remove_module.html
+++ b/branch/main/docker_image_remove_module.html
@@ -469,7 +469,8 @@ see 
 
Examples

-
- name: Remove an image
+
---
+- name: Remove an image
   community.docker.docker_image_remove:
     name: pacur/centos-7
 

diff --git a/branch/main/docker_image_tag_module.html b/branch/main/docker_image_tag_module.html
index d86735df..d2bc2d39 100644
--- a/branch/main/docker_image_tag_module.html
+++ b/branch/main/docker_image_tag_module.html
@@ -465,7 +465,8 @@ see 
 
Examples

-
- name: Tag Python 3.12 image with two new names
+
---
+- name: Tag Python 3.12 image with two new names
   community.docker.docker_image_tag:
     name: python:3.12
     repository:
diff --git a/branch/main/docker_login_module.html b/branch/main/docker_login_module.html
index fb485dce..dbb94c3a 100644
--- a/branch/main/docker_login_module.html
+++ b/branch/main/docker_login_module.html
@@ -479,7 +479,8 @@ see 
 
Examples

-
- name: Log into DockerHub
+
---
+- name: Log into DockerHub
   community.docker.docker_login:
     username: docker
     password: rekcod
diff --git a/branch/main/docker_network_info_module.html b/branch/main/docker_network_info_module.html
index c8a31919..33310a04 100644
--- a/branch/main/docker_network_info_module.html
+++ b/branch/main/docker_network_info_module.html
@@ -423,7 +423,8 @@ see 
 
Examples

-
- name: Get infos on network
+
---
+- name: Get infos on network
   community.docker.docker_network_info:
     name: mydata
   register: result
diff --git a/branch/main/docker_network_module.html b/branch/main/docker_network_module.html
index 3c48df68..8b887b2d 100644
--- a/branch/main/docker_network_module.html
+++ b/branch/main/docker_network_module.html
@@ -647,7 +647,8 @@ see 
 
Examples

-
- name: Create a network
+
---
+- name: Create a network
   community.docker.docker_network:
     name: network_one
 
diff --git a/branch/main/docker_node_info_module.html b/branch/main/docker_node_info_module.html
index 62368229..26b4f5b1 100644
--- a/branch/main/docker_node_info_module.html
+++ b/branch/main/docker_node_info_module.html
@@ -442,7 +442,8 @@ see 
 
Examples

-
- name: Get info on all nodes
+
---
+- name: Get info on all nodes
   community.docker.docker_node_info:
   register: result
 
diff --git a/branch/main/docker_node_module.html b/branch/main/docker_node_module.html
index 7afe93e9..86179ce6 100644
--- a/branch/main/docker_node_module.html
+++ b/branch/main/docker_node_module.html
@@ -479,7 +479,8 @@ see 
 
Examples

-
- name: Set node role
+
---
+- name: Set node role
   community.docker.docker_node:
     hostname: mynode
     role: manager
diff --git a/branch/main/docker_plugin_module.html b/branch/main/docker_plugin_module.html
index 4b0ad2e1..0cdb962b 100644
--- a/branch/main/docker_plugin_module.html
+++ b/branch/main/docker_plugin_module.html
@@ -474,7 +474,8 @@ see 
 
Examples

-
- name: Install a plugin
+
---
+- name: Install a plugin
   community.docker.docker_plugin:
     plugin_name: plugin_one
     state: present
diff --git a/branch/main/docker_prune_module.html b/branch/main/docker_prune_module.html
index 62d94ad0..94e01958 100644
--- a/branch/main/docker_prune_module.html
+++ b/branch/main/docker_prune_module.html
@@ -539,7 +539,8 @@ see 
 
Examples

-
- name: Prune containers older than 24h
+
---
+- name: Prune containers older than 24h
   community.docker.docker_prune:
     containers: true
     containers_filters:
diff --git a/branch/main/docker_secret_module.html b/branch/main/docker_secret_module.html
index 174062d8..59716233 100644
--- a/branch/main/docker_secret_module.html
+++ b/branch/main/docker_secret_module.html
@@ -511,7 +511,8 @@ see 
 
Examples

-
- name: Create secret foo (from a file on the control machine)
+
---
+- name: Create secret foo (from a file on the control machine)
   community.docker.docker_secret:
     name: foo
     # If the file is JSON or binary, Ansible might modify it (because
diff --git a/branch/main/docker_stack_info_module.html b/branch/main/docker_stack_info_module.html
index bf2b4d0c..1c8381e1 100644
--- a/branch/main/docker_stack_info_module.html
+++ b/branch/main/docker_stack_info_module.html
@@ -411,7 +411,8 @@ see 
 
Examples

-
- name: Shows stack info
+
---
+- name: Shows stack info
   community.docker.docker_stack_info:
   register: result
 
diff --git a/branch/main/docker_stack_module.html b/branch/main/docker_stack_module.html
index e2073284..a62fb1f9 100644
--- a/branch/main/docker_stack_module.html
+++ b/branch/main/docker_stack_module.html
@@ -492,7 +492,8 @@ see 
 
Examples

-
- name: Deploy stack from a compose file
+
---
+- name: Deploy stack from a compose file
   community.docker.docker_stack:
     state: present
     name: mystack
diff --git a/branch/main/docker_stack_task_info_module.html b/branch/main/docker_stack_task_info_module.html
index 69534deb..ec0a52f0 100644
--- a/branch/main/docker_stack_task_info_module.html
+++ b/branch/main/docker_stack_task_info_module.html
@@ -406,7 +406,8 @@ see 
 
Examples

-
- name: Shows stack info
+
---
+- name: Shows stack info
   community.docker.docker_stack_task_info:
     name: test_stack
   register: result
diff --git a/branch/main/docker_swarm_info_module.html b/branch/main/docker_swarm_info_module.html
index 853ce35c..0109fc9f 100644
--- a/branch/main/docker_swarm_info_module.html
+++ b/branch/main/docker_swarm_info_module.html
@@ -507,7 +507,8 @@ see 
 
Examples

-
- name: Get info on Docker Swarm
+
---
+- name: Get info on Docker Swarm
   community.docker.docker_swarm_info:
   ignore_errors: true
   register: result
diff --git a/branch/main/docker_swarm_module.html b/branch/main/docker_swarm_module.html
index 39660e16..58d65d73 100644
--- a/branch/main/docker_swarm_module.html
+++ b/branch/main/docker_swarm_module.html
@@ -675,7 +675,8 @@ see 
 
Examples

-
- name: Init a new swarm with default parameters
+
---
+- name: Init a new swarm with default parameters
   community.docker.docker_swarm:
     state: present
 
diff --git a/branch/main/docker_swarm_service_info_module.html b/branch/main/docker_swarm_service_info_module.html
index 78602292..1e565f43 100644
--- a/branch/main/docker_swarm_service_info_module.html
+++ b/branch/main/docker_swarm_service_info_module.html
@@ -424,7 +424,8 @@ see 
 
Examples

-
- name: Get info from a service
+
---
+- name: Get info from a service
   community.docker.docker_swarm_service_info:
     name: myservice
   register: result
diff --git a/branch/main/docker_swarm_service_module.html b/branch/main/docker_swarm_service_module.html
index f1047c82..bd467065 100644
--- a/branch/main/docker_swarm_service_module.html
+++ b/branch/main/docker_swarm_service_module.html
@@ -1324,7 +1324,8 @@ see 
 
Examples

-
- name: Set command and arguments
+
---
+- name: Set command and arguments
   community.docker.docker_swarm_service:
     name: myservice
     image: alpine
diff --git a/branch/main/docker_volume_info_module.html b/branch/main/docker_volume_info_module.html
index cc695a3c..ecb714d1 100644
--- a/branch/main/docker_volume_info_module.html
+++ b/branch/main/docker_volume_info_module.html
@@ -423,7 +423,8 @@ see 
 
Examples

-
- name: Get infos on volume
+
---
+- name: Get infos on volume
   community.docker.docker_volume_info:
     name: mydata
   register: result
diff --git a/branch/main/docker_volume_module.html b/branch/main/docker_volume_module.html
index 45e50d81..ba7eeec6 100644
--- a/branch/main/docker_volume_module.html
+++ b/branch/main/docker_volume_module.html
@@ -474,7 +474,8 @@ see 
 
Examples

-
- name: Create a volume
+
---
+- name: Create a volume
   community.docker.docker_volume:
     name: volume_one