cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated doc fragment to be consistent with the getting started guide.

Browse source
This commit is contained in:
chouseknecht 2016-04-27 04:02:15 -04:00
parent 7ed6270808
commit 92f058b1f5
1 changed files with 19 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
lib/ansible/utils/module_docs_fragments/docker.py
View file

@ -23,52 +23,55 @@ class ModuleDocFragment(object):
options: options:
docker_host: docker_host:
description: description:
- URL or Unix socket path used to connect to the Docker daemon. - "The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the
TCP connection string. For example, 'tcp://192.168.99.100:2376'. If TLS is used to encrypt the connection,
the module will automatically replace 'tcp' in the connection URL with 'https'."
required: false required: false
default: null default: "unix://var/run/docker.sock"
aliases: ['docker_url']
tls_hostname: tls_hostname:
description: description:
- If verifying the name of the host found in the TLS certs, provide the expected host name. - When verifying the authenticity of the Docker Host server, provide the expected name of the server.
default: null default: localhost
required: false required: false
api_version: api_version:
description: description:
- Version of the Docker API the client will use. - The version of the Docker API running on the Docker Host. Defaults to the latest version of the API
supported by docker-py.
required: false required: false
default: default provided by docker-py default: default provided by docker-py
timeout: timeout:
description: description:
- Amount of time in seconds to wait on response from the API. - The maximum amount of time in seconds to wait on a response from the API.
required: false required: false
default: null default: 60
cacert_path: cacert_path:
description: description:
- Path to the client TLS Certificate Authority .pem file. - Use a CA certificate when performing server verification by providing the path to a CA certificate file.
required: false required: false
default: null default: null
cert_path: cert_path:
description: description:
- Path to the client TLS certificate .pem file. - Path to the client's TLS certificate file.
required: false required: false
default: null default: null
key_path: key_path:
description: description:
- Path to the client .pem key file. - Path to the client's TLS key file.
required: false required: false
default: null default: null
ssl_version: ssl_version:
description: description:
- SSL version number to use for TLS encryption. - Provide a valid SSL version number. Default value determined by docker-py, currently 1.0.
required: false required: false
default: null default: "1.0"
tls: tls:
description: description:
- Use TLS encryption without verifying the host certificates. - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host
server.
default: false default: false
tls_verify: tls_verify:
description: description:
- Use TLS encryption and verify the host certificates. - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.
default: false default: false
notes: notes:
@ -77,4 +80,4 @@ notes:
DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped
with the product that sets up the environment. It will set these variables for you. See with the product that sets up the environment. It will set these variables for you. See
https://docker-py.readthedocs.org/en/stable/machine/ for more details. https://docker-py.readthedocs.org/en/stable/machine/ for more details.
''' '''