ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-28 03:00:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Change command line parameters to parameters.

Browse source
This commit is contained in:
chouseknecht 2016-04-27 03:34:20 -04:00
parent 07f6df3624
commit 20c2c1a771
No known key found for this signature in database
GPG key ID: 78F1698C5705A81B
1 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docsite/rst/guide_docker.rst
View file

@ -42,16 +42,16 @@ installed on the host running Ansible. You will need to have >= 1.7.0 installed.
Connecting to the Docker API Connecting to the Docker API
---------------------------- ----------------------------
You can connect to a local or remote API using command line parameters passed to each task or by setting environment You can connect to a local or remote API using parameters passed to each task or by setting environment variables.
variables. The order of precedence is command line parameters and then environment variables. If neither a command line The order of precedence is command line parameters and then environment variables. If neither a command line
option for a environment variable is found, then a default value will be used. The default values are provided under option for a environment variable is found, then a default value will be used. The default values are provided under
`Command Line Parameters`_ `Parameters`_
Command Line Parameters Parameters
....................... ..........
Control how modules connect to the Docker API by passing the following options to a task: Control how modules connect to the Docker API by passing the following parameters:
docker_host docker_host
The URL or Unix socket path used to connect to the Docker API. Defaults to ``unix://var/run/docker.sock``. The URL or Unix socket path used to connect to the Docker API. Defaults to ``unix://var/run/docker.sock``.
@ -167,7 +167,7 @@ examples to get you started:
- debug: msg="Container - {{ inventory_hostname }}" - debug: msg="Container - {{ inventory_hostname }}"
Configuration Configuration
.............. .............
You can control the behavior of the inventory script by defining environment variables, or You can control the behavior of the inventory script by defining environment variables, or
creating a docker.yml file (sample provided in ansible/contrib/inventory). The order of precedence is the docker.yml creating a docker.yml file (sample provided in ansible/contrib/inventory). The order of precedence is the docker.yml
file and then environment variables. file and then environment variables.
@ -233,10 +233,12 @@ You can also override the default name of the script by defining DOCKER_CONFIG_F
Here's what you can define in docker_inventory.yml: Here's what you can define in docker_inventory.yml:
* defaults: Defines a default connection. Defaults will be taken from this and applied to any values not provided defaults
Defines a default connection. Defaults will be taken from this and applied to any values not provided
for a host defined in the hosts list. for a host defined in the hosts list.
* hosts: If you wish to get inventory from more than one Docker host, define a hosts list. hosts
If you wish to get inventory from more than one Docker host, define a hosts list.
For the default host and each host in the hosts list define the following attributes: For the default host and each host in the hosts list define the following attributes: