mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 20:08:41 +00:00
modules: fix examples to use FQCN (#644)
* modules: fix examples to use FQCN * fix * fix * fix
This commit is contained in:
parent
d0ad62b869
commit
564dd62c80
@ -168,12 +168,12 @@ EXAMPLES = '''
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- name: Tear down existing services
|
||||
docker_compose:
|
||||
community.docker.docker_compose:
|
||||
project_src: flask
|
||||
state: absent
|
||||
|
||||
- name: Create and start services
|
||||
docker_compose:
|
||||
community.docker.docker_compose:
|
||||
project_src: flask
|
||||
register: output
|
||||
|
||||
@ -181,7 +181,7 @@ EXAMPLES = '''
|
||||
var: output
|
||||
|
||||
- name: Run `docker-compose up` again
|
||||
docker_compose:
|
||||
community.docker.docker_compose:
|
||||
project_src: flask
|
||||
build: no
|
||||
register: output
|
||||
@ -193,7 +193,7 @@ EXAMPLES = '''
|
||||
that: "not output.changed "
|
||||
|
||||
- name: Stop all services
|
||||
docker_compose:
|
||||
community.docker.docker_compose:
|
||||
project_src: flask
|
||||
build: no
|
||||
stopped: yes
|
||||
@ -208,7 +208,7 @@ EXAMPLES = '''
|
||||
- "not db.flask_db_1.state.running"
|
||||
|
||||
- name: Restart services
|
||||
docker_compose:
|
||||
community.docker.docker_compose:
|
||||
project_src: flask
|
||||
build: no
|
||||
restarted: yes
|
||||
@ -226,7 +226,7 @@ EXAMPLES = '''
|
||||
hosts: localhost
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- docker_compose:
|
||||
- community.docker.docker_compose:
|
||||
project_src: flask
|
||||
scale:
|
||||
web: 2
|
||||
@ -239,11 +239,11 @@ EXAMPLES = '''
|
||||
hosts: localhost
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- docker_compose:
|
||||
- community.docker.docker_compose:
|
||||
project_src: flask
|
||||
state: absent
|
||||
|
||||
- docker_compose:
|
||||
- community.docker.docker_compose:
|
||||
project_name: flask
|
||||
definition:
|
||||
version: '2'
|
||||
@ -273,11 +273,11 @@ EXAMPLES = '''
|
||||
hosts: localhost
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- docker_compose:
|
||||
- community.docker.docker_compose:
|
||||
project_src: flask
|
||||
state: absent
|
||||
|
||||
- docker_compose:
|
||||
- community.docker.docker_compose:
|
||||
project_name: flask
|
||||
definition:
|
||||
db:
|
||||
|
||||
@ -75,7 +75,7 @@ author:
|
||||
EXAMPLES = '''
|
||||
|
||||
- name: Create config foo (from a file on the control machine)
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
# If the file is JSON or binary, Ansible might modify it (because
|
||||
# it is first decoded and later re-encoded). Base64-encoding the
|
||||
@ -85,7 +85,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Change the config data
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -94,7 +94,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Add a new label
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -105,7 +105,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: No change
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -115,7 +115,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Update an existing label
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -124,14 +124,14 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Force the (re-)creation of the config
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
force: yes
|
||||
state: present
|
||||
|
||||
- name: Remove config foo
|
||||
docker_config:
|
||||
community.docker.docker_config:
|
||||
name: foo
|
||||
state: absent
|
||||
'''
|
||||
|
||||
@ -830,14 +830,14 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create a data container
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: mydata
|
||||
image: busybox
|
||||
volumes:
|
||||
- /data
|
||||
|
||||
- name: Re-create a redis container
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: myredis
|
||||
image: redis
|
||||
command: redis-server --appendonly yes
|
||||
@ -849,7 +849,7 @@ EXAMPLES = '''
|
||||
- mydata
|
||||
|
||||
- name: Restart a container
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: myapplication
|
||||
image: someuser/appimage
|
||||
state: started
|
||||
@ -876,19 +876,19 @@ EXAMPLES = '''
|
||||
BOOLEAN_KEY: "yes"
|
||||
|
||||
- name: Container present
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: mycontainer
|
||||
state: present
|
||||
image: ubuntu:14.04
|
||||
command: sleep infinity
|
||||
|
||||
- name: Stop a container
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: mycontainer
|
||||
state: stopped
|
||||
|
||||
- name: Start 4 load-balanced containers
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: "container{{ item }}"
|
||||
recreate: yes
|
||||
image: someuser/anotherappimage
|
||||
@ -896,12 +896,12 @@ EXAMPLES = '''
|
||||
with_sequence: count=4
|
||||
|
||||
- name: Remove container
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: ohno
|
||||
state: absent
|
||||
|
||||
- name: Syslogging output
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: myservice
|
||||
image: busybox
|
||||
log_driver: syslog
|
||||
@ -913,14 +913,14 @@ EXAMPLES = '''
|
||||
tag: myservice
|
||||
|
||||
- name: Create db container and connect to network
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: db_test
|
||||
image: "postgres:latest"
|
||||
networks:
|
||||
- name: "{{ docker_network_name }}"
|
||||
|
||||
- name: Start container, connect to network and link
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleeper
|
||||
image: ubuntu:14.04
|
||||
networks:
|
||||
@ -933,13 +933,13 @@ EXAMPLES = '''
|
||||
- name: TestingNet2
|
||||
|
||||
- name: Start a container with a command
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleepy
|
||||
image: ubuntu:14.04
|
||||
command: ["sleep", "infinity"]
|
||||
|
||||
- name: Add container to networks
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleepy
|
||||
networks:
|
||||
- name: TestingNet
|
||||
@ -950,7 +950,7 @@ EXAMPLES = '''
|
||||
ipv4_address: 172.1.10.20
|
||||
|
||||
- name: Update network with aliases
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleepy
|
||||
networks:
|
||||
- name: TestingNet
|
||||
@ -959,25 +959,25 @@ EXAMPLES = '''
|
||||
- zzzz
|
||||
|
||||
- name: Remove container from one network
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleepy
|
||||
networks:
|
||||
- name: TestingNet2
|
||||
purge_networks: yes
|
||||
|
||||
- name: Remove container from all networks
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleepy
|
||||
purge_networks: yes
|
||||
|
||||
- name: Start a container and use an env file
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: agent
|
||||
image: jenkinsci/ssh-slave
|
||||
env_file: /var/tmp/jenkins/agent.env
|
||||
|
||||
- name: Create a container with limited capabilities
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: sleepy
|
||||
image: ubuntu:16.04
|
||||
command: sleep infinity
|
||||
@ -987,7 +987,7 @@ EXAMPLES = '''
|
||||
- all
|
||||
|
||||
- name: Finer container restart/update control
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: test
|
||||
image: ubuntu:18.04
|
||||
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
|
||||
|
||||
- name: Finer container restart/update control II
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: test
|
||||
image: ubuntu:18.04
|
||||
env:
|
||||
@ -1012,7 +1012,7 @@ EXAMPLES = '''
|
||||
env: strict # except for environment variables; there, we want to be strict
|
||||
|
||||
- name: Start container with healthstatus
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: nginx-proxy
|
||||
image: nginx:1.13
|
||||
state: started
|
||||
@ -1026,7 +1026,7 @@ EXAMPLES = '''
|
||||
start_period: 30s
|
||||
|
||||
- name: Remove healthcheck from container
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: nginx-proxy
|
||||
image: nginx:1.13
|
||||
state: started
|
||||
@ -1035,7 +1035,7 @@ EXAMPLES = '''
|
||||
test: ["NONE"]
|
||||
|
||||
- name: Start container with block device read limit
|
||||
docker_container:
|
||||
community.docker.docker_container:
|
||||
name: test
|
||||
image: ubuntu:18.04
|
||||
state: started
|
||||
|
||||
@ -41,7 +41,7 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get infos on container
|
||||
docker_container_info:
|
||||
community.docker.docker_container_info:
|
||||
name: mydata
|
||||
register: result
|
||||
|
||||
|
||||
@ -100,29 +100,29 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get info on docker host
|
||||
docker_host_info:
|
||||
community.docker.docker_host_info:
|
||||
register: result
|
||||
|
||||
- name: Get info on docker host and list images
|
||||
docker_host_info:
|
||||
community.docker.docker_host_info:
|
||||
images: yes
|
||||
register: result
|
||||
|
||||
- name: Get info on docker host and list images matching the filter
|
||||
docker_host_info:
|
||||
community.docker.docker_host_info:
|
||||
images: yes
|
||||
images_filters:
|
||||
label: "mylabel"
|
||||
register: result
|
||||
|
||||
- name: Get info on docker host and verbose list images
|
||||
docker_host_info:
|
||||
community.docker.docker_host_info:
|
||||
images: yes
|
||||
verbose_output: yes
|
||||
register: result
|
||||
|
||||
- name: Get info on docker host and used disk space
|
||||
docker_host_info:
|
||||
community.docker.docker_host_info:
|
||||
disk_usage: yes
|
||||
register: result
|
||||
|
||||
|
||||
@ -313,19 +313,19 @@ author:
|
||||
EXAMPLES = '''
|
||||
|
||||
- name: Pull an image
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: pacur/centos-7
|
||||
source: pull
|
||||
|
||||
- name: Tag and push to docker hub
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: pacur/centos-7:56
|
||||
repository: dcoppenhagan/myimage:7.56
|
||||
push: yes
|
||||
source: local
|
||||
|
||||
- name: Tag and push to local registry
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
# Image will be centos:7
|
||||
name: centos
|
||||
# Will be pushed to localhost:5000/centos:7
|
||||
@ -335,7 +335,7 @@ EXAMPLES = '''
|
||||
source: local
|
||||
|
||||
- name: Add tag latest to image
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: myimage:7.1.2
|
||||
repository: myimage:latest
|
||||
# As 'latest' usually already is present, we need to enable overwriting of existing tags:
|
||||
@ -343,13 +343,13 @@ EXAMPLES = '''
|
||||
source: local
|
||||
|
||||
- name: Remove image
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
state: absent
|
||||
name: registry.ansible.com/chouseknecht/sinatra
|
||||
tag: v1
|
||||
|
||||
- name: Build an image and push it to a private repo
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
build:
|
||||
path: ./sinatra
|
||||
name: registry.ansible.com/chouseknecht/sinatra
|
||||
@ -358,14 +358,14 @@ EXAMPLES = '''
|
||||
source: build
|
||||
|
||||
- name: Archive image
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: registry.ansible.com/chouseknecht/sinatra
|
||||
tag: v1
|
||||
archive_path: my_sinatra.tar
|
||||
source: local
|
||||
|
||||
- name: Load image from archive and push to a private registry
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: localhost:5000/myimages/sinatra
|
||||
tag: v1
|
||||
push: yes
|
||||
@ -373,7 +373,7 @@ EXAMPLES = '''
|
||||
source: load
|
||||
|
||||
- name: Build image and with build args
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: myimage
|
||||
build:
|
||||
path: /path/to/build/dir
|
||||
@ -383,7 +383,7 @@ EXAMPLES = '''
|
||||
source: build
|
||||
|
||||
- name: Build image using cache source
|
||||
docker_image:
|
||||
community.docker.docker_image:
|
||||
name: myimage:latest
|
||||
build:
|
||||
path: /path/to/build/dir
|
||||
|
||||
@ -51,11 +51,11 @@ author:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Inspect a single image
|
||||
docker_image_info:
|
||||
community.docker.docker_image_info:
|
||||
name: pacur/centos-7
|
||||
|
||||
- name: Inspect multiple images
|
||||
docker_image_info:
|
||||
community.docker.docker_image_info:
|
||||
name:
|
||||
- pacur/centos-7
|
||||
- sinatra
|
||||
|
||||
@ -86,25 +86,25 @@ author:
|
||||
EXAMPLES = '''
|
||||
|
||||
- name: Log into DockerHub
|
||||
docker_login:
|
||||
community.docker.docker_login:
|
||||
username: docker
|
||||
password: rekcod
|
||||
|
||||
- name: Log into private registry and force re-authorization
|
||||
docker_login:
|
||||
community.docker.docker_login:
|
||||
registry_url: your.private.registry.io
|
||||
username: yourself
|
||||
password: secrets3
|
||||
reauthorize: yes
|
||||
|
||||
- name: Log into DockerHub using a custom config file
|
||||
docker_login:
|
||||
community.docker.docker_login:
|
||||
username: docker
|
||||
password: rekcod
|
||||
config_path: /tmp/.mydockercfg
|
||||
|
||||
- name: Log out of DockerHub
|
||||
docker_login:
|
||||
community.docker.docker_login:
|
||||
state: absent
|
||||
'''
|
||||
|
||||
|
||||
@ -197,11 +197,11 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create a network
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_one
|
||||
|
||||
- name: Remove all but selected list of containers
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_one
|
||||
connected:
|
||||
- container_a
|
||||
@ -209,25 +209,25 @@ EXAMPLES = '''
|
||||
- container_c
|
||||
|
||||
- name: Remove a single container
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_one
|
||||
connected: "{{ fulllist|difference(['container_a']) }}"
|
||||
|
||||
- name: Add a container to a network, leaving existing containers connected
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_one
|
||||
connected:
|
||||
- container_a
|
||||
appends: yes
|
||||
|
||||
- name: Create a network with driver options
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_two
|
||||
driver_options:
|
||||
com.docker.network.bridge.name: net2
|
||||
|
||||
- name: Create a network with custom IPAM config
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_three
|
||||
ipam_config:
|
||||
- subnet: 172.3.27.0/24
|
||||
@ -238,21 +238,21 @@ EXAMPLES = '''
|
||||
host2: 172.3.27.4
|
||||
|
||||
- name: Create a network with labels
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_four
|
||||
labels:
|
||||
key1: value1
|
||||
key2: value2
|
||||
|
||||
- name: Create a network with IPv6 IPAM config
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_ipv6_one
|
||||
enable_ipv6: yes
|
||||
ipam_config:
|
||||
- subnet: fdd1:ac8c:0557:7ce1::/64
|
||||
|
||||
- name: Create a network with IPv6 and custom IPv4 IPAM config
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_ipv6_two
|
||||
enable_ipv6: yes
|
||||
ipam_config:
|
||||
@ -260,7 +260,7 @@ EXAMPLES = '''
|
||||
- subnet: fdd1:ac8c:0557:7ce2::/64
|
||||
|
||||
- name: Delete a network, disconnecting all containers
|
||||
docker_network:
|
||||
community.docker.docker_network:
|
||||
name: network_one
|
||||
state: absent
|
||||
force: yes
|
||||
|
||||
@ -41,7 +41,7 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get infos on network
|
||||
docker_network_info:
|
||||
community.docker.docker_network_info:
|
||||
name: mydata
|
||||
register: result
|
||||
|
||||
|
||||
@ -83,35 +83,35 @@ author:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Set node role
|
||||
docker_node:
|
||||
community.docker.docker_node:
|
||||
hostname: mynode
|
||||
role: manager
|
||||
|
||||
- name: Set node availability
|
||||
docker_node:
|
||||
community.docker.docker_node:
|
||||
hostname: mynode
|
||||
availability: drain
|
||||
|
||||
- name: Replace node labels with new labels
|
||||
docker_node:
|
||||
community.docker.docker_node:
|
||||
hostname: mynode
|
||||
labels:
|
||||
key: value
|
||||
labels_state: replace
|
||||
|
||||
- name: Merge node labels and new labels
|
||||
docker_node:
|
||||
community.docker.docker_node:
|
||||
hostname: mynode
|
||||
labels:
|
||||
key: value
|
||||
|
||||
- name: Remove all labels assigned to node
|
||||
docker_node:
|
||||
community.docker.docker_node:
|
||||
hostname: mynode
|
||||
labels_state: replace
|
||||
|
||||
- name: Remove selected labels from the node
|
||||
docker_node:
|
||||
community.docker.docker_node:
|
||||
hostname: mynode
|
||||
labels_to_remove:
|
||||
- key1
|
||||
|
||||
@ -51,23 +51,23 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get info on all nodes
|
||||
docker_node_info:
|
||||
community.docker.docker_node_info:
|
||||
register: result
|
||||
|
||||
- name: Get info on node
|
||||
docker_node_info:
|
||||
community.docker.docker_node_info:
|
||||
name: mynode
|
||||
register: result
|
||||
|
||||
- name: Get info on list of nodes
|
||||
docker_node_info:
|
||||
community.docker.docker_node_info:
|
||||
name:
|
||||
- mynode1
|
||||
- mynode2
|
||||
register: result
|
||||
|
||||
- name: Get info on host if it is Swarm Manager
|
||||
docker_node_info:
|
||||
community.docker.docker_node_info:
|
||||
self: true
|
||||
register: result
|
||||
'''
|
||||
|
||||
@ -87,14 +87,14 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Prune containers older than 24h
|
||||
docker_prune:
|
||||
community.docker.docker_prune:
|
||||
containers: yes
|
||||
containers_filters:
|
||||
# only consider containers created more than 24 hours ago
|
||||
until: 24h
|
||||
|
||||
- name: Prune everything
|
||||
docker_prune:
|
||||
community.docker.docker_prune:
|
||||
containers: yes
|
||||
images: yes
|
||||
networks: yes
|
||||
@ -102,7 +102,7 @@ EXAMPLES = '''
|
||||
builder_cache: yes
|
||||
|
||||
- name: Prune everything (including non-dangling images)
|
||||
docker_prune:
|
||||
community.docker.docker_prune:
|
||||
containers: yes
|
||||
images: yes
|
||||
images_filters:
|
||||
|
||||
@ -74,7 +74,7 @@ author:
|
||||
EXAMPLES = '''
|
||||
|
||||
- name: Create secret foo (from a file on the control machine)
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
# If the file is JSON or binary, Ansible might modify it (because
|
||||
# it is first decoded and later re-encoded). Base64-encoding the
|
||||
@ -84,7 +84,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Change the secret data
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -93,7 +93,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Add a new label
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -104,7 +104,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: No change
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -114,7 +114,7 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Update an existing label
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
labels:
|
||||
@ -123,14 +123,14 @@ EXAMPLES = '''
|
||||
state: present
|
||||
|
||||
- name: Force the removal/creation of the secret
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
data: Goodnight everyone!
|
||||
force: yes
|
||||
state: present
|
||||
|
||||
- name: Remove secret foo
|
||||
docker_secret:
|
||||
community.docker.docker_secret:
|
||||
name: foo
|
||||
state: absent
|
||||
'''
|
||||
|
||||
@ -96,14 +96,14 @@ stack_spec_diff:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Deploy stack from a compose file
|
||||
docker_stack:
|
||||
community.docker.docker_stack:
|
||||
state: present
|
||||
name: mystack
|
||||
compose:
|
||||
- /opt/docker-compose.yml
|
||||
|
||||
- name: Deploy stack from base compose file and override the web service
|
||||
docker_stack:
|
||||
community.docker.docker_stack:
|
||||
state: present
|
||||
name: mystack
|
||||
compose:
|
||||
@ -116,7 +116,7 @@ EXAMPLES = '''
|
||||
ENVVAR: envvar
|
||||
|
||||
- name: Remove stack
|
||||
docker_stack:
|
||||
community.docker.docker_stack:
|
||||
name: mystack
|
||||
state: absent
|
||||
'''
|
||||
|
||||
@ -190,37 +190,37 @@ author:
|
||||
EXAMPLES = '''
|
||||
|
||||
- name: Init a new swarm with default parameters
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: present
|
||||
|
||||
- name: Update swarm configuration
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: present
|
||||
election_tick: 5
|
||||
|
||||
- name: Add nodes
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: join
|
||||
advertise_addr: 192.168.1.2
|
||||
join_token: SWMTKN-1--xxxxx
|
||||
remote_addrs: [ '192.168.1.1:2377' ]
|
||||
|
||||
- name: Leave swarm for a node
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: absent
|
||||
|
||||
- name: Remove a swarm manager
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: absent
|
||||
force: true
|
||||
|
||||
- name: Remove node from swarm
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: remove
|
||||
node_id: mynode
|
||||
|
||||
- name: Inspect swarm
|
||||
docker_swarm:
|
||||
community.docker.docker_swarm:
|
||||
state: inspect
|
||||
register: swarm_info
|
||||
'''
|
||||
|
||||
@ -89,7 +89,7 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get info on Docker Swarm
|
||||
docker_swarm_info:
|
||||
community.docker.docker_swarm_info:
|
||||
ignore_errors: yes
|
||||
register: result
|
||||
|
||||
@ -103,18 +103,18 @@ EXAMPLES = '''
|
||||
- block:
|
||||
|
||||
- name: Get info on Docker Swarm and list of registered nodes
|
||||
docker_swarm_info:
|
||||
community.docker.docker_swarm_info:
|
||||
nodes: yes
|
||||
register: result
|
||||
|
||||
- name: Get info on Docker Swarm and extended list of registered nodes
|
||||
docker_swarm_info:
|
||||
community.docker.docker_swarm_info:
|
||||
nodes: yes
|
||||
verbose_output: yes
|
||||
register: result
|
||||
|
||||
- name: Get info on Docker Swarm and filtered list of registered nodes
|
||||
docker_swarm_info:
|
||||
community.docker.docker_swarm_info:
|
||||
nodes: yes
|
||||
nodes_filters:
|
||||
name: mynode
|
||||
@ -124,7 +124,7 @@ EXAMPLES = '''
|
||||
var: result.swarm_facts
|
||||
|
||||
- name: Get the swarm unlock key
|
||||
docker_swarm_info:
|
||||
community.docker.docker_swarm_info:
|
||||
unlock_key: yes
|
||||
register: result
|
||||
|
||||
|
||||
@ -891,7 +891,7 @@ rebuilt:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Set command and arguments
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
command: sleep
|
||||
@ -899,7 +899,7 @@ EXAMPLES = '''
|
||||
- "3600"
|
||||
|
||||
- name: Set a bind mount
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
mounts:
|
||||
@ -908,7 +908,7 @@ EXAMPLES = '''
|
||||
type: bind
|
||||
|
||||
- name: Set service labels
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
labels:
|
||||
@ -916,7 +916,7 @@ EXAMPLES = '''
|
||||
com.example.department: "Finance"
|
||||
|
||||
- name: Set environment variables
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
env:
|
||||
@ -927,7 +927,7 @@ EXAMPLES = '''
|
||||
- envs/apps/web.env
|
||||
|
||||
- name: Set fluentd logging
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
logging:
|
||||
@ -938,7 +938,7 @@ EXAMPLES = '''
|
||||
tag: myservice
|
||||
|
||||
- name: Set restart policies
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
restart_config:
|
||||
@ -948,7 +948,7 @@ EXAMPLES = '''
|
||||
window: 120s
|
||||
|
||||
- name: Set update config
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
update_config:
|
||||
@ -957,7 +957,7 @@ EXAMPLES = '''
|
||||
order: stop-first
|
||||
|
||||
- name: Set rollback config
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine
|
||||
update_config:
|
||||
@ -968,7 +968,7 @@ EXAMPLES = '''
|
||||
order: stop-first
|
||||
|
||||
- name: Set placement preferences
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine:edge
|
||||
placement:
|
||||
@ -979,7 +979,7 @@ EXAMPLES = '''
|
||||
- engine.labels.operatingsystem == ubuntu 14.04
|
||||
|
||||
- name: Set configs
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine:edge
|
||||
configs:
|
||||
@ -987,14 +987,14 @@ EXAMPLES = '''
|
||||
filename: "/tmp/config.txt"
|
||||
|
||||
- name: Set networks
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine:edge
|
||||
networks:
|
||||
- mynetwork
|
||||
|
||||
- name: Set networks as a dictionary
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine:edge
|
||||
networks:
|
||||
@ -1005,7 +1005,7 @@ EXAMPLES = '''
|
||||
foo: bar
|
||||
|
||||
- name: Set secrets
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine:edge
|
||||
secrets:
|
||||
@ -1013,7 +1013,7 @@ EXAMPLES = '''
|
||||
filename: "/run/secrets/secret.txt"
|
||||
|
||||
- name: Start service with healthcheck
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: nginx:1.13
|
||||
healthcheck:
|
||||
@ -1026,7 +1026,7 @@ EXAMPLES = '''
|
||||
start_period: 30s
|
||||
|
||||
- name: Configure service resources
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
image: alpine:edge
|
||||
reservations:
|
||||
@ -1037,7 +1037,7 @@ EXAMPLES = '''
|
||||
memory: 50M
|
||||
|
||||
- name: Remove service
|
||||
docker_swarm_service:
|
||||
community.docker.docker_swarm_service:
|
||||
name: myservice
|
||||
state: absent
|
||||
'''
|
||||
|
||||
@ -40,7 +40,7 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get info from a service
|
||||
docker_swarm_service_info:
|
||||
community.docker.docker_swarm_service_info:
|
||||
name: myservice
|
||||
register: result
|
||||
'''
|
||||
|
||||
@ -92,16 +92,16 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create a volume
|
||||
docker_volume:
|
||||
community.docker.docker_volume:
|
||||
name: volume_one
|
||||
|
||||
- name: Remove a volume
|
||||
docker_volume:
|
||||
community.docker.docker_volume:
|
||||
name: volume_one
|
||||
state: absent
|
||||
|
||||
- name: Create a volume with options
|
||||
docker_volume:
|
||||
community.docker.docker_volume:
|
||||
name: volume_two
|
||||
driver_options:
|
||||
type: btrfs
|
||||
|
||||
@ -37,7 +37,7 @@ requirements:
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get infos on volume
|
||||
docker_volume_info:
|
||||
community.docker.docker_volume_info:
|
||||
name: mydata
|
||||
register: result
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user