archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve documentation on remote_addrs. (#52893)

Browse Source 
(cherry picked from commit 3c39fe5871)
pull/53192/head
Felix Fontein 7 years ago committed by Toshio Kuratomi
parent 23d9efc1f3
commit 7a9e7daf44
1 changed files with 132 additions and 113 deletions
Show Stats Download Patch File Download Diff File

245
lib/ansible/modules/cloud/docker/docker_swarm.py
Unescape Escape View File

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

Write Preview
Loading…
Cancel
Save