Skip to content

Commit f977b92

Browse files
sarahsanders-dockerthaJeztah
authored andcommitted
Fix missing link from Configure node healthcheck heading
Update name to dispatcher-heartbeat Signed-off-by: Sarah Sanders <[email protected]> Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 1dcfd23 commit f977b92

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/reference/commandline/swarm_init.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ Initialize a swarm
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:--------------------------------------------|:--------------|:---------------|:-----------------------------------------------------------------------------------------------------------------------------|
10-
| [`--advertise-addr`](#advertise-addr) | `string` | | Advertised address (format: `<ip\|interface>[:port]`) |
11-
| [`--autolock`](#autolock) | `bool` | | Enable manager autolocking (requiring an unlock key to start a stopped manager) |
12-
| [`--availability`](#availability) | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) |
13-
| `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) |
14-
| [`--data-path-addr`](#data-path-addr) | `string` | | Address or interface to use for data path traffic (format: `<ip\|interface>`) |
15-
| [`--data-path-port`](#data-path-port) | `uint32` | `0` | Port number to use for data path traffic (1024 - 49151). If no value is set or is set to 0, the default port (4789) is used. |
16-
| [`--default-addr-pool`](#default-addr-pool) | `ipNetSlice` | | default address pool in CIDR format |
17-
| `--default-addr-pool-mask-length` | `uint32` | `24` | default address pool subnet mask length |
18-
| `--dispatcher-heartbeat` | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) |
19-
| [`--external-ca`](#external-ca) | `external-ca` | | Specifications of one or more certificate signing endpoints |
20-
| [`--force-new-cluster`](#force-new-cluster) | `bool` | | Force create a new cluster from current state |
21-
| [`--listen-addr`](#listen-addr) | `node-addr` | `0.0.0.0:2377` | Listen address (format: `<ip\|interface>[:port]`) |
22-
| [`--max-snapshots`](#max-snapshots) | `uint64` | `0` | Number of additional Raft snapshots to retain |
23-
| [`--snapshot-interval`](#snapshot-interval) | `uint64` | `10000` | Number of log entries between Raft snapshots |
24-
| `--task-history-limit` | `int64` | `5` | Task history retention limit |
8+
| Name | Type | Default | Description |
9+
|:--------------------------------------------------|:--------------|:---------------|:-----------------------------------------------------------------------------------------------------------------------------|
10+
| [`--advertise-addr`](#advertise-addr) | `string` | | Advertised address (format: `<ip\|interface>[:port]`) |
11+
| [`--autolock`](#autolock) | `bool` | | Enable manager autolocking (requiring an unlock key to start a stopped manager) |
12+
| [`--availability`](#availability) | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) |
13+
| `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) |
14+
| [`--data-path-addr`](#data-path-addr) | `string` | | Address or interface to use for data path traffic (format: `<ip\|interface>`) |
15+
| [`--data-path-port`](#data-path-port) | `uint32` | `0` | Port number to use for data path traffic (1024 - 49151). If no value is set or is set to 0, the default port (4789) is used. |
16+
| [`--default-addr-pool`](#default-addr-pool) | `ipNetSlice` | | default address pool in CIDR format |
17+
| `--default-addr-pool-mask-length` | `uint32` | `24` | default address pool subnet mask length |
18+
| [`--dispatcher-heartbeat`](#dispatcher-heartbeat) | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) |
19+
| [`--external-ca`](#external-ca) | `external-ca` | | Specifications of one or more certificate signing endpoints |
20+
| [`--force-new-cluster`](#force-new-cluster) | `bool` | | Force create a new cluster from current state |
21+
| [`--listen-addr`](#listen-addr) | `node-addr` | `0.0.0.0:2377` | Listen address (format: `<ip\|interface>[:port]`) |
22+
| [`--max-snapshots`](#max-snapshots) | `uint64` | `0` | Number of additional Raft snapshots to retain |
23+
| [`--snapshot-interval`](#snapshot-interval) | `uint64` | `10000` | Number of log entries between Raft snapshots |
24+
| `--task-history-limit` | `int64` | `5` | Task history retention limit |
2525

2626

2727
<!---MARKER_GEN_END-->
@@ -64,7 +64,7 @@ You can disable autolock by running `docker swarm update --autolock=false`.
6464
After disabling it, the encryption key is no longer required to start the
6565
manager, and it will start up on its own without user intervention.
6666

67-
### <a name=""></a> Configure node healthcheck frequency (--dispatcher-heartbeat)
67+
### <a name="dispatcher-heartbeat"></a> Configure node healthcheck frequency (--dispatcher-heartbeat)
6868

6969
The `--dispatcher-heartbeat` flag sets the frequency at which nodes are told to
7070
report their health.

0 commit comments

Comments
 (0)