Improve documentation on remote_addrs. (#52893)

(cherry picked from commit 3c39fe5871)
pull/53192/head
Felix Fontein 7 years ago committed by Toshio Kuratomi
parent 23d9efc1f3
commit 7a9e7daf44

@ -29,6 +29,7 @@ options:
the port number from the listen address is used. the port number from the listen address is used.
- If C(advertise_addr) is not specified, it will be automatically - If C(advertise_addr) is not specified, it will be automatically
detected when possible. detected when possible.
type: str
listen_addr: listen_addr:
description: description:
- Listen address used for inter-manager communication. - Listen address used for inter-manager communication.
@ -37,13 +38,14 @@ options:
like C(eth0:4567). like C(eth0:4567).
- If the port number is omitted, the default swarm listening port - If the port number is omitted, the default swarm listening port
is used. is used.
type: str
default: 0.0.0.0:2377 default: 0.0.0.0:2377
force: force:
description: description:
- Use with state C(present) to force creating a new Swarm, even if already part of one. - Use with state C(present) to force creating a new Swarm, even if already part of one.
- Use with state C(absent) to Leave the swarm even if this node is a manager. - Use with state C(absent) to Leave the swarm even if this node is a manager.
type: bool type: bool
default: 'no' default: no
state: state:
description: description:
- Set to C(present), to create/update a new cluster. - Set to C(present), to create/update a new cluster.
@ -51,7 +53,8 @@ options:
- Set to C(absent), to leave an existing cluster. - Set to C(absent), to leave an existing cluster.
- Set to C(remove), to remove an absent node from the cluster. - Set to C(remove), to remove an absent node from the cluster.
- Set to C(inspect) to display swarm informations. - Set to C(inspect) to display swarm informations.
required: true type: str
required: yes
default: present default: present
choices: choices:
- present - present
@ -63,62 +66,78 @@ options:
description: description:
- Swarm id of the node to remove. - Swarm id of the node to remove.
- Used with I(state=remove). - Used with I(state=remove).
type: str
join_token: join_token:
description: description:
- Swarm token used to join a swarm cluster. - Swarm token used to join a swarm cluster.
- Used with I(state=join). - Used with I(state=join).
type: str
remote_addrs: remote_addrs:
description: description:
- Remote address of a manager to connect to. - Remote address of one or more manager nodes of an existing Swarm to connect to.
- Used with I(state=join). - Used with I(state=join).
type: list
task_history_retention_limit: task_history_retention_limit:
description: description:
- Maximum number of tasks history stored. - Maximum number of tasks history stored.
- Docker default value is C(5). - Docker default value is C(5).
type: int
snapshot_interval: snapshot_interval:
description: description:
- Number of logs entries between snapshot. - Number of logs entries between snapshot.
- Docker default value is C(10000). - Docker default value is C(10000).
type: int
keep_old_snapshots: keep_old_snapshots:
description: description:
- Number of snapshots to keep beyond the current snapshot. - Number of snapshots to keep beyond the current snapshot.
- Docker default value is C(0). - Docker default value is C(0).
type: int
log_entries_for_slow_followers: log_entries_for_slow_followers:
description: description:
- Number of log entries to keep around to sync up slow followers after a snapshot is created. - Number of log entries to keep around to sync up slow followers after a snapshot is created.
type: int
heartbeat_tick: heartbeat_tick:
description: description:
- Amount of ticks (in seconds) between each heartbeat. - Amount of ticks (in seconds) between each heartbeat.
- Docker default value is C(1s). - Docker default value is C(1s).
type: int
election_tick: election_tick:
description: description:
- Amount of ticks (in seconds) needed without a leader to trigger a new election. - Amount of ticks (in seconds) needed without a leader to trigger a new election.
- Docker default value is C(10s). - Docker default value is C(10s).
type: int
dispatcher_heartbeat_period: dispatcher_heartbeat_period:
description: description:
- The delay for an agent to send a heartbeat to the dispatcher. - The delay for an agent to send a heartbeat to the dispatcher.
- Docker default value is C(5s). - Docker default value is C(5s).
type: int
node_cert_expiry: node_cert_expiry:
description: description:
- Automatic expiry for nodes certificates. - Automatic expiry for nodes certificates.
- Docker default value is C(3months). - Docker default value is C(3months).
type: int
name: name:
description: description:
- The name of the swarm. - The name of the swarm.
type: str
labels: labels:
description: description:
- User-defined key/value metadata. - User-defined key/value metadata.
type: dict
signing_ca_cert: signing_ca_cert:
description: description:
- The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. - The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format.
type: path
signing_ca_key: signing_ca_key:
description: description:
- The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. - The desired signing CA key for all swarm node TLS leaf certificates, in PEM format.
type: path
ca_force_rotate: ca_force_rotate:
description: description:
- An integer whose purpose is to force swarm to generate a new signing CA certificate and key, - An integer whose purpose is to force swarm to generate a new signing CA certificate and key,
if none have been specified. if none have been specified.
- Docker default value is C(0). - Docker default value is C(0).
type: int
autolock_managers: autolock_managers:
description: description:
- If set, generate a key and use it to lock data stored on the managers. - If set, generate a key and use it to lock data stored on the managers.
@ -127,11 +146,11 @@ options:
rotate_worker_token: rotate_worker_token:
description: Rotate the worker join token. description: Rotate the worker join token.
type: bool type: bool
default: 'no' default: no
rotate_manager_token: rotate_manager_token:
description: Rotate the manager join token. description: Rotate the manager join token.
type: bool type: bool
default: 'no' default: no
extends_documentation_fragment: extends_documentation_fragment:
- docker - docker
requirements: requirements:

Loading…
Cancel
Save