modules: fix examples to use FQCN (#644)

* modules: fix examples to use FQCN

* fix

* fix

* fix
This commit is contained in:
Andrew Klychkov 2020-07-13 22:50:31 +03:00 committed by Felix Fontein
parent d0ad62b869
commit 564dd62c80
21 changed files with 128 additions and 128 deletions

View File

@ -168,12 +168,12 @@ EXAMPLES = '''
gather_facts: no gather_facts: no
tasks: tasks:
- name: Tear down existing services - name: Tear down existing services
docker_compose: community.docker.docker_compose:
project_src: flask project_src: flask
state: absent state: absent
- name: Create and start services - name: Create and start services
docker_compose: community.docker.docker_compose:
project_src: flask project_src: flask
register: output register: output
@ -181,7 +181,7 @@ EXAMPLES = '''
var: output var: output
- name: Run `docker-compose up` again - name: Run `docker-compose up` again
docker_compose: community.docker.docker_compose:
project_src: flask project_src: flask
build: no build: no
register: output register: output
@ -193,7 +193,7 @@ EXAMPLES = '''
that: "not output.changed " that: "not output.changed "
- name: Stop all services - name: Stop all services
docker_compose: community.docker.docker_compose:
project_src: flask project_src: flask
build: no build: no
stopped: yes stopped: yes
@ -208,7 +208,7 @@ EXAMPLES = '''
- "not db.flask_db_1.state.running" - "not db.flask_db_1.state.running"
- name: Restart services - name: Restart services
docker_compose: community.docker.docker_compose:
project_src: flask project_src: flask
build: no build: no
restarted: yes restarted: yes
@ -226,7 +226,7 @@ EXAMPLES = '''
hosts: localhost hosts: localhost
gather_facts: no gather_facts: no
tasks: tasks:
- docker_compose: - community.docker.docker_compose:
project_src: flask project_src: flask
scale: scale:
web: 2 web: 2
@ -239,11 +239,11 @@ EXAMPLES = '''
hosts: localhost hosts: localhost
gather_facts: no gather_facts: no
tasks: tasks:
- docker_compose: - community.docker.docker_compose:
project_src: flask project_src: flask
state: absent state: absent
- docker_compose: - community.docker.docker_compose:
project_name: flask project_name: flask
definition: definition:
version: '2' version: '2'
@ -273,11 +273,11 @@ EXAMPLES = '''
hosts: localhost hosts: localhost
gather_facts: no gather_facts: no
tasks: tasks:
- docker_compose: - community.docker.docker_compose:
project_src: flask project_src: flask
state: absent state: absent
- docker_compose: - community.docker.docker_compose:
project_name: flask project_name: flask
definition: definition:
db: db:

View File

@ -75,7 +75,7 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Create config foo (from a file on the control machine) - name: Create config foo (from a file on the control machine)
docker_config: community.docker.docker_config:
name: foo name: foo
# If the file is JSON or binary, Ansible might modify it (because # If the file is JSON or binary, Ansible might modify it (because
# it is first decoded and later re-encoded). Base64-encoding the # it is first decoded and later re-encoded). Base64-encoding the
@ -85,7 +85,7 @@ EXAMPLES = '''
state: present state: present
- name: Change the config data - name: Change the config data
docker_config: community.docker.docker_config:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -94,7 +94,7 @@ EXAMPLES = '''
state: present state: present
- name: Add a new label - name: Add a new label
docker_config: community.docker.docker_config:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -105,7 +105,7 @@ EXAMPLES = '''
state: present state: present
- name: No change - name: No change
docker_config: community.docker.docker_config:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -115,7 +115,7 @@ EXAMPLES = '''
state: present state: present
- name: Update an existing label - name: Update an existing label
docker_config: community.docker.docker_config:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -124,14 +124,14 @@ EXAMPLES = '''
state: present state: present
- name: Force the (re-)creation of the config - name: Force the (re-)creation of the config
docker_config: community.docker.docker_config:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
force: yes force: yes
state: present state: present
- name: Remove config foo - name: Remove config foo
docker_config: community.docker.docker_config:
name: foo name: foo
state: absent state: absent
''' '''

View File

@ -830,14 +830,14 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Create a data container - name: Create a data container
docker_container: community.docker.docker_container:
name: mydata name: mydata
image: busybox image: busybox
volumes: volumes:
- /data - /data
- name: Re-create a redis container - name: Re-create a redis container
docker_container: community.docker.docker_container:
name: myredis name: myredis
image: redis image: redis
command: redis-server --appendonly yes command: redis-server --appendonly yes
@ -849,7 +849,7 @@ EXAMPLES = '''
- mydata - mydata
- name: Restart a container - name: Restart a container
docker_container: community.docker.docker_container:
name: myapplication name: myapplication
image: someuser/appimage image: someuser/appimage
state: started state: started
@ -876,19 +876,19 @@ EXAMPLES = '''
BOOLEAN_KEY: "yes" BOOLEAN_KEY: "yes"
- name: Container present - name: Container present
docker_container: community.docker.docker_container:
name: mycontainer name: mycontainer
state: present state: present
image: ubuntu:14.04 image: ubuntu:14.04
command: sleep infinity command: sleep infinity
- name: Stop a container - name: Stop a container
docker_container: community.docker.docker_container:
name: mycontainer name: mycontainer
state: stopped state: stopped
- name: Start 4 load-balanced containers - name: Start 4 load-balanced containers
docker_container: community.docker.docker_container:
name: "container{{ item }}" name: "container{{ item }}"
recreate: yes recreate: yes
image: someuser/anotherappimage image: someuser/anotherappimage
@ -896,12 +896,12 @@ EXAMPLES = '''
with_sequence: count=4 with_sequence: count=4
- name: Remove container - name: Remove container
docker_container: community.docker.docker_container:
name: ohno name: ohno
state: absent state: absent
- name: Syslogging output - name: Syslogging output
docker_container: community.docker.docker_container:
name: myservice name: myservice
image: busybox image: busybox
log_driver: syslog log_driver: syslog
@ -913,14 +913,14 @@ EXAMPLES = '''
tag: myservice tag: myservice
- name: Create db container and connect to network - name: Create db container and connect to network
docker_container: community.docker.docker_container:
name: db_test name: db_test
image: "postgres:latest" image: "postgres:latest"
networks: networks:
- name: "{{ docker_network_name }}" - name: "{{ docker_network_name }}"
- name: Start container, connect to network and link - name: Start container, connect to network and link
docker_container: community.docker.docker_container:
name: sleeper name: sleeper
image: ubuntu:14.04 image: ubuntu:14.04
networks: networks:
@ -933,13 +933,13 @@ EXAMPLES = '''
- name: TestingNet2 - name: TestingNet2
- name: Start a container with a command - name: Start a container with a command
docker_container: community.docker.docker_container:
name: sleepy name: sleepy
image: ubuntu:14.04 image: ubuntu:14.04
command: ["sleep", "infinity"] command: ["sleep", "infinity"]
- name: Add container to networks - name: Add container to networks
docker_container: community.docker.docker_container:
name: sleepy name: sleepy
networks: networks:
- name: TestingNet - name: TestingNet
@ -950,7 +950,7 @@ EXAMPLES = '''
ipv4_address: 172.1.10.20 ipv4_address: 172.1.10.20
- name: Update network with aliases - name: Update network with aliases
docker_container: community.docker.docker_container:
name: sleepy name: sleepy
networks: networks:
- name: TestingNet - name: TestingNet
@ -959,25 +959,25 @@ EXAMPLES = '''
- zzzz - zzzz
- name: Remove container from one network - name: Remove container from one network
docker_container: community.docker.docker_container:
name: sleepy name: sleepy
networks: networks:
- name: TestingNet2 - name: TestingNet2
purge_networks: yes purge_networks: yes
- name: Remove container from all networks - name: Remove container from all networks
docker_container: community.docker.docker_container:
name: sleepy name: sleepy
purge_networks: yes purge_networks: yes
- name: Start a container and use an env file - name: Start a container and use an env file
docker_container: community.docker.docker_container:
name: agent name: agent
image: jenkinsci/ssh-slave image: jenkinsci/ssh-slave
env_file: /var/tmp/jenkins/agent.env env_file: /var/tmp/jenkins/agent.env
- name: Create a container with limited capabilities - name: Create a container with limited capabilities
docker_container: community.docker.docker_container:
name: sleepy name: sleepy
image: ubuntu:16.04 image: ubuntu:16.04
command: sleep infinity command: sleep infinity
@ -987,7 +987,7 @@ EXAMPLES = '''
- all - all
- name: Finer container restart/update control - name: Finer container restart/update control
docker_container: community.docker.docker_container:
name: test name: test
image: ubuntu:18.04 image: ubuntu:18.04
env: env:
@ -1001,7 +1001,7 @@ EXAMPLES = '''
volumes: allow_more_present # if there are more volumes, that's ok, as long as `/tmp:/tmp` is there volumes: allow_more_present # if there are more volumes, that's ok, as long as `/tmp:/tmp` is there
- name: Finer container restart/update control II - name: Finer container restart/update control II
docker_container: community.docker.docker_container:
name: test name: test
image: ubuntu:18.04 image: ubuntu:18.04
env: env:
@ -1012,7 +1012,7 @@ EXAMPLES = '''
env: strict # except for environment variables; there, we want to be strict env: strict # except for environment variables; there, we want to be strict
- name: Start container with healthstatus - name: Start container with healthstatus
docker_container: community.docker.docker_container:
name: nginx-proxy name: nginx-proxy
image: nginx:1.13 image: nginx:1.13
state: started state: started
@ -1026,7 +1026,7 @@ EXAMPLES = '''
start_period: 30s start_period: 30s
- name: Remove healthcheck from container - name: Remove healthcheck from container
docker_container: community.docker.docker_container:
name: nginx-proxy name: nginx-proxy
image: nginx:1.13 image: nginx:1.13
state: started state: started
@ -1035,7 +1035,7 @@ EXAMPLES = '''
test: ["NONE"] test: ["NONE"]
- name: Start container with block device read limit - name: Start container with block device read limit
docker_container: community.docker.docker_container:
name: test name: test
image: ubuntu:18.04 image: ubuntu:18.04
state: started state: started

View File

@ -41,7 +41,7 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get infos on container - name: Get infos on container
docker_container_info: community.docker.docker_container_info:
name: mydata name: mydata
register: result register: result

View File

@ -100,29 +100,29 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get info on docker host - name: Get info on docker host
docker_host_info: community.docker.docker_host_info:
register: result register: result
- name: Get info on docker host and list images - name: Get info on docker host and list images
docker_host_info: community.docker.docker_host_info:
images: yes images: yes
register: result register: result
- name: Get info on docker host and list images matching the filter - name: Get info on docker host and list images matching the filter
docker_host_info: community.docker.docker_host_info:
images: yes images: yes
images_filters: images_filters:
label: "mylabel" label: "mylabel"
register: result register: result
- name: Get info on docker host and verbose list images - name: Get info on docker host and verbose list images
docker_host_info: community.docker.docker_host_info:
images: yes images: yes
verbose_output: yes verbose_output: yes
register: result register: result
- name: Get info on docker host and used disk space - name: Get info on docker host and used disk space
docker_host_info: community.docker.docker_host_info:
disk_usage: yes disk_usage: yes
register: result register: result

View File

@ -313,19 +313,19 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Pull an image - name: Pull an image
docker_image: community.docker.docker_image:
name: pacur/centos-7 name: pacur/centos-7
source: pull source: pull
- name: Tag and push to docker hub - name: Tag and push to docker hub
docker_image: community.docker.docker_image:
name: pacur/centos-7:56 name: pacur/centos-7:56
repository: dcoppenhagan/myimage:7.56 repository: dcoppenhagan/myimage:7.56
push: yes push: yes
source: local source: local
- name: Tag and push to local registry - name: Tag and push to local registry
docker_image: community.docker.docker_image:
# Image will be centos:7 # Image will be centos:7
name: centos name: centos
# Will be pushed to localhost:5000/centos:7 # Will be pushed to localhost:5000/centos:7
@ -335,7 +335,7 @@ EXAMPLES = '''
source: local source: local
- name: Add tag latest to image - name: Add tag latest to image
docker_image: community.docker.docker_image:
name: myimage:7.1.2 name: myimage:7.1.2
repository: myimage:latest repository: myimage:latest
# As 'latest' usually already is present, we need to enable overwriting of existing tags: # As 'latest' usually already is present, we need to enable overwriting of existing tags:
@ -343,13 +343,13 @@ EXAMPLES = '''
source: local source: local
- name: Remove image - name: Remove image
docker_image: community.docker.docker_image:
state: absent state: absent
name: registry.ansible.com/chouseknecht/sinatra name: registry.ansible.com/chouseknecht/sinatra
tag: v1 tag: v1
- name: Build an image and push it to a private repo - name: Build an image and push it to a private repo
docker_image: community.docker.docker_image:
build: build:
path: ./sinatra path: ./sinatra
name: registry.ansible.com/chouseknecht/sinatra name: registry.ansible.com/chouseknecht/sinatra
@ -358,14 +358,14 @@ EXAMPLES = '''
source: build source: build
- name: Archive image - name: Archive image
docker_image: community.docker.docker_image:
name: registry.ansible.com/chouseknecht/sinatra name: registry.ansible.com/chouseknecht/sinatra
tag: v1 tag: v1
archive_path: my_sinatra.tar archive_path: my_sinatra.tar
source: local source: local
- name: Load image from archive and push to a private registry - name: Load image from archive and push to a private registry
docker_image: community.docker.docker_image:
name: localhost:5000/myimages/sinatra name: localhost:5000/myimages/sinatra
tag: v1 tag: v1
push: yes push: yes
@ -373,7 +373,7 @@ EXAMPLES = '''
source: load source: load
- name: Build image and with build args - name: Build image and with build args
docker_image: community.docker.docker_image:
name: myimage name: myimage
build: build:
path: /path/to/build/dir path: /path/to/build/dir
@ -383,7 +383,7 @@ EXAMPLES = '''
source: build source: build
- name: Build image using cache source - name: Build image using cache source
docker_image: community.docker.docker_image:
name: myimage:latest name: myimage:latest
build: build:
path: /path/to/build/dir path: /path/to/build/dir

View File

@ -51,11 +51,11 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Inspect a single image - name: Inspect a single image
docker_image_info: community.docker.docker_image_info:
name: pacur/centos-7 name: pacur/centos-7
- name: Inspect multiple images - name: Inspect multiple images
docker_image_info: community.docker.docker_image_info:
name: name:
- pacur/centos-7 - pacur/centos-7
- sinatra - sinatra

View File

@ -86,25 +86,25 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Log into DockerHub - name: Log into DockerHub
docker_login: community.docker.docker_login:
username: docker username: docker
password: rekcod password: rekcod
- name: Log into private registry and force re-authorization - name: Log into private registry and force re-authorization
docker_login: community.docker.docker_login:
registry_url: your.private.registry.io registry_url: your.private.registry.io
username: yourself username: yourself
password: secrets3 password: secrets3
reauthorize: yes reauthorize: yes
- name: Log into DockerHub using a custom config file - name: Log into DockerHub using a custom config file
docker_login: community.docker.docker_login:
username: docker username: docker
password: rekcod password: rekcod
config_path: /tmp/.mydockercfg config_path: /tmp/.mydockercfg
- name: Log out of DockerHub - name: Log out of DockerHub
docker_login: community.docker.docker_login:
state: absent state: absent
''' '''

View File

@ -197,11 +197,11 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Create a network - name: Create a network
docker_network: community.docker.docker_network:
name: network_one name: network_one
- name: Remove all but selected list of containers - name: Remove all but selected list of containers
docker_network: community.docker.docker_network:
name: network_one name: network_one
connected: connected:
- container_a - container_a
@ -209,25 +209,25 @@ EXAMPLES = '''
- container_c - container_c
- name: Remove a single container - name: Remove a single container
docker_network: community.docker.docker_network:
name: network_one name: network_one
connected: "{{ fulllist|difference(['container_a']) }}" connected: "{{ fulllist|difference(['container_a']) }}"
- name: Add a container to a network, leaving existing containers connected - name: Add a container to a network, leaving existing containers connected
docker_network: community.docker.docker_network:
name: network_one name: network_one
connected: connected:
- container_a - container_a
appends: yes appends: yes
- name: Create a network with driver options - name: Create a network with driver options
docker_network: community.docker.docker_network:
name: network_two name: network_two
driver_options: driver_options:
com.docker.network.bridge.name: net2 com.docker.network.bridge.name: net2
- name: Create a network with custom IPAM config - name: Create a network with custom IPAM config
docker_network: community.docker.docker_network:
name: network_three name: network_three
ipam_config: ipam_config:
- subnet: 172.3.27.0/24 - subnet: 172.3.27.0/24
@ -238,21 +238,21 @@ EXAMPLES = '''
host2: 172.3.27.4 host2: 172.3.27.4
- name: Create a network with labels - name: Create a network with labels
docker_network: community.docker.docker_network:
name: network_four name: network_four
labels: labels:
key1: value1 key1: value1
key2: value2 key2: value2
- name: Create a network with IPv6 IPAM config - name: Create a network with IPv6 IPAM config
docker_network: community.docker.docker_network:
name: network_ipv6_one name: network_ipv6_one
enable_ipv6: yes enable_ipv6: yes
ipam_config: ipam_config:
- subnet: fdd1:ac8c:0557:7ce1::/64 - subnet: fdd1:ac8c:0557:7ce1::/64
- name: Create a network with IPv6 and custom IPv4 IPAM config - name: Create a network with IPv6 and custom IPv4 IPAM config
docker_network: community.docker.docker_network:
name: network_ipv6_two name: network_ipv6_two
enable_ipv6: yes enable_ipv6: yes
ipam_config: ipam_config:
@ -260,7 +260,7 @@ EXAMPLES = '''
- subnet: fdd1:ac8c:0557:7ce2::/64 - subnet: fdd1:ac8c:0557:7ce2::/64
- name: Delete a network, disconnecting all containers - name: Delete a network, disconnecting all containers
docker_network: community.docker.docker_network:
name: network_one name: network_one
state: absent state: absent
force: yes force: yes

View File

@ -41,7 +41,7 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get infos on network - name: Get infos on network
docker_network_info: community.docker.docker_network_info:
name: mydata name: mydata
register: result register: result

View File

@ -83,35 +83,35 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Set node role - name: Set node role
docker_node: community.docker.docker_node:
hostname: mynode hostname: mynode
role: manager role: manager
- name: Set node availability - name: Set node availability
docker_node: community.docker.docker_node:
hostname: mynode hostname: mynode
availability: drain availability: drain
- name: Replace node labels with new labels - name: Replace node labels with new labels
docker_node: community.docker.docker_node:
hostname: mynode hostname: mynode
labels: labels:
key: value key: value
labels_state: replace labels_state: replace
- name: Merge node labels and new labels - name: Merge node labels and new labels
docker_node: community.docker.docker_node:
hostname: mynode hostname: mynode
labels: labels:
key: value key: value
- name: Remove all labels assigned to node - name: Remove all labels assigned to node
docker_node: community.docker.docker_node:
hostname: mynode hostname: mynode
labels_state: replace labels_state: replace
- name: Remove selected labels from the node - name: Remove selected labels from the node
docker_node: community.docker.docker_node:
hostname: mynode hostname: mynode
labels_to_remove: labels_to_remove:
- key1 - key1

View File

@ -51,23 +51,23 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get info on all nodes - name: Get info on all nodes
docker_node_info: community.docker.docker_node_info:
register: result register: result
- name: Get info on node - name: Get info on node
docker_node_info: community.docker.docker_node_info:
name: mynode name: mynode
register: result register: result
- name: Get info on list of nodes - name: Get info on list of nodes
docker_node_info: community.docker.docker_node_info:
name: name:
- mynode1 - mynode1
- mynode2 - mynode2
register: result register: result
- name: Get info on host if it is Swarm Manager - name: Get info on host if it is Swarm Manager
docker_node_info: community.docker.docker_node_info:
self: true self: true
register: result register: result
''' '''

View File

@ -87,14 +87,14 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Prune containers older than 24h - name: Prune containers older than 24h
docker_prune: community.docker.docker_prune:
containers: yes containers: yes
containers_filters: containers_filters:
# only consider containers created more than 24 hours ago # only consider containers created more than 24 hours ago
until: 24h until: 24h
- name: Prune everything - name: Prune everything
docker_prune: community.docker.docker_prune:
containers: yes containers: yes
images: yes images: yes
networks: yes networks: yes
@ -102,7 +102,7 @@ EXAMPLES = '''
builder_cache: yes builder_cache: yes
- name: Prune everything (including non-dangling images) - name: Prune everything (including non-dangling images)
docker_prune: community.docker.docker_prune:
containers: yes containers: yes
images: yes images: yes
images_filters: images_filters:

View File

@ -74,7 +74,7 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Create secret foo (from a file on the control machine) - name: Create secret foo (from a file on the control machine)
docker_secret: community.docker.docker_secret:
name: foo name: foo
# If the file is JSON or binary, Ansible might modify it (because # If the file is JSON or binary, Ansible might modify it (because
# it is first decoded and later re-encoded). Base64-encoding the # it is first decoded and later re-encoded). Base64-encoding the
@ -84,7 +84,7 @@ EXAMPLES = '''
state: present state: present
- name: Change the secret data - name: Change the secret data
docker_secret: community.docker.docker_secret:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -93,7 +93,7 @@ EXAMPLES = '''
state: present state: present
- name: Add a new label - name: Add a new label
docker_secret: community.docker.docker_secret:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -104,7 +104,7 @@ EXAMPLES = '''
state: present state: present
- name: No change - name: No change
docker_secret: community.docker.docker_secret:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -114,7 +114,7 @@ EXAMPLES = '''
state: present state: present
- name: Update an existing label - name: Update an existing label
docker_secret: community.docker.docker_secret:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
labels: labels:
@ -123,14 +123,14 @@ EXAMPLES = '''
state: present state: present
- name: Force the removal/creation of the secret - name: Force the removal/creation of the secret
docker_secret: community.docker.docker_secret:
name: foo name: foo
data: Goodnight everyone! data: Goodnight everyone!
force: yes force: yes
state: present state: present
- name: Remove secret foo - name: Remove secret foo
docker_secret: community.docker.docker_secret:
name: foo name: foo
state: absent state: absent
''' '''

View File

@ -96,14 +96,14 @@ stack_spec_diff:
EXAMPLES = ''' EXAMPLES = '''
- name: Deploy stack from a compose file - name: Deploy stack from a compose file
docker_stack: community.docker.docker_stack:
state: present state: present
name: mystack name: mystack
compose: compose:
- /opt/docker-compose.yml - /opt/docker-compose.yml
- name: Deploy stack from base compose file and override the web service - name: Deploy stack from base compose file and override the web service
docker_stack: community.docker.docker_stack:
state: present state: present
name: mystack name: mystack
compose: compose:
@ -116,7 +116,7 @@ EXAMPLES = '''
ENVVAR: envvar ENVVAR: envvar
- name: Remove stack - name: Remove stack
docker_stack: community.docker.docker_stack:
name: mystack name: mystack
state: absent state: absent
''' '''

View File

@ -190,37 +190,37 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Init a new swarm with default parameters - name: Init a new swarm with default parameters
docker_swarm: community.docker.docker_swarm:
state: present state: present
- name: Update swarm configuration - name: Update swarm configuration
docker_swarm: community.docker.docker_swarm:
state: present state: present
election_tick: 5 election_tick: 5
- name: Add nodes - name: Add nodes
docker_swarm: community.docker.docker_swarm:
state: join state: join
advertise_addr: 192.168.1.2 advertise_addr: 192.168.1.2
join_token: SWMTKN-1--xxxxx join_token: SWMTKN-1--xxxxx
remote_addrs: [ '192.168.1.1:2377' ] remote_addrs: [ '192.168.1.1:2377' ]
- name: Leave swarm for a node - name: Leave swarm for a node
docker_swarm: community.docker.docker_swarm:
state: absent state: absent
- name: Remove a swarm manager - name: Remove a swarm manager
docker_swarm: community.docker.docker_swarm:
state: absent state: absent
force: true force: true
- name: Remove node from swarm - name: Remove node from swarm
docker_swarm: community.docker.docker_swarm:
state: remove state: remove
node_id: mynode node_id: mynode
- name: Inspect swarm - name: Inspect swarm
docker_swarm: community.docker.docker_swarm:
state: inspect state: inspect
register: swarm_info register: swarm_info
''' '''

View File

@ -89,7 +89,7 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get info on Docker Swarm - name: Get info on Docker Swarm
docker_swarm_info: community.docker.docker_swarm_info:
ignore_errors: yes ignore_errors: yes
register: result register: result
@ -103,18 +103,18 @@ EXAMPLES = '''
- block: - block:
- name: Get info on Docker Swarm and list of registered nodes - name: Get info on Docker Swarm and list of registered nodes
docker_swarm_info: community.docker.docker_swarm_info:
nodes: yes nodes: yes
register: result register: result
- name: Get info on Docker Swarm and extended list of registered nodes - name: Get info on Docker Swarm and extended list of registered nodes
docker_swarm_info: community.docker.docker_swarm_info:
nodes: yes nodes: yes
verbose_output: yes verbose_output: yes
register: result register: result
- name: Get info on Docker Swarm and filtered list of registered nodes - name: Get info on Docker Swarm and filtered list of registered nodes
docker_swarm_info: community.docker.docker_swarm_info:
nodes: yes nodes: yes
nodes_filters: nodes_filters:
name: mynode name: mynode
@ -124,7 +124,7 @@ EXAMPLES = '''
var: result.swarm_facts var: result.swarm_facts
- name: Get the swarm unlock key - name: Get the swarm unlock key
docker_swarm_info: community.docker.docker_swarm_info:
unlock_key: yes unlock_key: yes
register: result register: result

View File

@ -891,7 +891,7 @@ rebuilt:
EXAMPLES = ''' EXAMPLES = '''
- name: Set command and arguments - name: Set command and arguments
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
command: sleep command: sleep
@ -899,7 +899,7 @@ EXAMPLES = '''
- "3600" - "3600"
- name: Set a bind mount - name: Set a bind mount
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
mounts: mounts:
@ -908,7 +908,7 @@ EXAMPLES = '''
type: bind type: bind
- name: Set service labels - name: Set service labels
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
labels: labels:
@ -916,7 +916,7 @@ EXAMPLES = '''
com.example.department: "Finance" com.example.department: "Finance"
- name: Set environment variables - name: Set environment variables
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
env: env:
@ -927,7 +927,7 @@ EXAMPLES = '''
- envs/apps/web.env - envs/apps/web.env
- name: Set fluentd logging - name: Set fluentd logging
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
logging: logging:
@ -938,7 +938,7 @@ EXAMPLES = '''
tag: myservice tag: myservice
- name: Set restart policies - name: Set restart policies
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
restart_config: restart_config:
@ -948,7 +948,7 @@ EXAMPLES = '''
window: 120s window: 120s
- name: Set update config - name: Set update config
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
update_config: update_config:
@ -957,7 +957,7 @@ EXAMPLES = '''
order: stop-first order: stop-first
- name: Set rollback config - name: Set rollback config
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine image: alpine
update_config: update_config:
@ -968,7 +968,7 @@ EXAMPLES = '''
order: stop-first order: stop-first
- name: Set placement preferences - name: Set placement preferences
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine:edge image: alpine:edge
placement: placement:
@ -979,7 +979,7 @@ EXAMPLES = '''
- engine.labels.operatingsystem == ubuntu 14.04 - engine.labels.operatingsystem == ubuntu 14.04
- name: Set configs - name: Set configs
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine:edge image: alpine:edge
configs: configs:
@ -987,14 +987,14 @@ EXAMPLES = '''
filename: "/tmp/config.txt" filename: "/tmp/config.txt"
- name: Set networks - name: Set networks
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine:edge image: alpine:edge
networks: networks:
- mynetwork - mynetwork
- name: Set networks as a dictionary - name: Set networks as a dictionary
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine:edge image: alpine:edge
networks: networks:
@ -1005,7 +1005,7 @@ EXAMPLES = '''
foo: bar foo: bar
- name: Set secrets - name: Set secrets
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine:edge image: alpine:edge
secrets: secrets:
@ -1013,7 +1013,7 @@ EXAMPLES = '''
filename: "/run/secrets/secret.txt" filename: "/run/secrets/secret.txt"
- name: Start service with healthcheck - name: Start service with healthcheck
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: nginx:1.13 image: nginx:1.13
healthcheck: healthcheck:
@ -1026,7 +1026,7 @@ EXAMPLES = '''
start_period: 30s start_period: 30s
- name: Configure service resources - name: Configure service resources
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
image: alpine:edge image: alpine:edge
reservations: reservations:
@ -1037,7 +1037,7 @@ EXAMPLES = '''
memory: 50M memory: 50M
- name: Remove service - name: Remove service
docker_swarm_service: community.docker.docker_swarm_service:
name: myservice name: myservice
state: absent state: absent
''' '''

View File

@ -40,7 +40,7 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get info from a service - name: Get info from a service
docker_swarm_service_info: community.docker.docker_swarm_service_info:
name: myservice name: myservice
register: result register: result
''' '''

View File

@ -92,16 +92,16 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Create a volume - name: Create a volume
docker_volume: community.docker.docker_volume:
name: volume_one name: volume_one
- name: Remove a volume - name: Remove a volume
docker_volume: community.docker.docker_volume:
name: volume_one name: volume_one
state: absent state: absent
- name: Create a volume with options - name: Create a volume with options
docker_volume: community.docker.docker_volume:
name: volume_two name: volume_two
driver_options: driver_options:
type: btrfs type: btrfs

View File

@ -37,7 +37,7 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
- name: Get infos on volume - name: Get infos on volume
docker_volume_info: community.docker.docker_volume_info:
name: mydata name: mydata
register: result register: result