diff --git a/docs/reference/commandline/container_restart.md b/docs/reference/commandline/container_restart.md index 9a988599b7..5331ede6df 100644 --- a/docs/reference/commandline/container_restart.md +++ b/docs/reference/commandline/container_restart.md @@ -42,7 +42,7 @@ container, `SIGTERM` is used as default. ### Stop container with timeout (-t, --timeout) The `--timeout` flag sets the number of seconds to wait for the container -to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal. +to stop after sending the pre-defined (see [`--signal`](#signal)) system call signal. If the container does not exit after the timeout elapses, it's forcibly killed with a `SIGKILL` signal. diff --git a/docs/reference/commandline/network_ls.md b/docs/reference/commandline/network_ls.md index 31e1501ac6..ff3b4001cc 100644 --- a/docs/reference/commandline/network_ls.md +++ b/docs/reference/commandline/network_ls.md @@ -13,7 +13,7 @@ List networks |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-trunc` | `bool` | | Do not truncate the output | +| [`--no-trunc`](#no-trunc) | `bool` | | Do not truncate the output | | `-q`, `--quiet` | `bool` | | Only display network IDs | @@ -37,6 +37,8 @@ cf03ee007fb4 host host local 78b03ee04fc4 multi-host overlay swarm ``` +### List networks without truncating the ID column (--no-trun) + Use the `--no-trunc` option to display the full network id: ```console diff --git a/docs/reference/commandline/swarm_join-token.md b/docs/reference/commandline/swarm_join-token.md index 745d752ce4..660f363052 100644 --- a/docs/reference/commandline/swarm_join-token.md +++ b/docs/reference/commandline/swarm_join-token.md @@ -5,10 +5,10 @@ Manage join tokens ### Options -| Name | Type | Default | Description | -|:----------------|:-------|:--------|:-------------------| -| `-q`, `--quiet` | `bool` | | Only display token | -| `--rotate` | `bool` | | Rotate join token | +| Name | Type | Default | Description | +|:------------------------------------|:-------|:--------|:-------------------| +| [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display token | +| [`--rotate`](#rotate) | `bool` | | Rotate join token | @@ -77,7 +77,7 @@ $ docker swarm join-token -q worker SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t ``` -### `--rotate` +### `--rotate` Because tokens allow new nodes to join the swarm, you should keep them secret. Be particularly careful with manager tokens since they allow new manager nodes @@ -96,7 +96,7 @@ Rotating a join-token means that no new nodes will be able to join the swarm using the old token. Rotation does not affect existing nodes in the swarm because the join token is only used for authorizing new nodes joining the swarm. -### `--quiet` +### `--quiet` Only print the token. Do not print a complete command for joining. diff --git a/docs/reference/commandline/swarm_join.md b/docs/reference/commandline/swarm_join.md index bad97c7338..2c784d4afa 100644 --- a/docs/reference/commandline/swarm_join.md +++ b/docs/reference/commandline/swarm_join.md @@ -5,13 +5,13 @@ Join a swarm as a node and/or manager ### Options -| Name | Type | Default | Description | -|:-------------------|:------------|:---------------|:------------------------------------------------------------------------------| -| `--advertise-addr` | `string` | | Advertised address (format: `[:port]`) | -| `--availability` | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) | -| `--data-path-addr` | `string` | | Address or interface to use for data path traffic (format: ``) | -| `--listen-addr` | `node-addr` | `0.0.0.0:2377` | Listen address (format: `[:port]`) | -| `--token` | `string` | | Token for entry into the swarm | +| Name | Type | Default | Description | +|:--------------------------------------|:------------|:---------------|:------------------------------------------------------------------------------| +| [`--advertise-addr`](#advertise-addr) | `string` | | Advertised address (format: `[:port]`) | +| [`--availability`](#availability) | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) | +| [`--data-path-addr`](#data-path-addr) | `string` | | Address or interface to use for data path traffic (format: ``) | +| [`--listen-addr`](#listen-addr) | `node-addr` | `0.0.0.0:2377` | Listen address (format: `[:port]`) | +| [`--token`](#token) | `string` | | Token for entry into the swarm | @@ -57,7 +57,7 @@ dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active Reachable dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader ``` -### `--listen-addr value` +### `--listen-addr value` If the node is a manager, it will listen for inbound swarm manager traffic on this address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a @@ -68,7 +68,7 @@ name, the default port 2377 will be used. This flag is generally not necessary when joining an existing swarm. -### `--advertise-addr value` +### `--advertise-addr value` This flag specifies the address that will be advertised to other members of the swarm for API access. If unspecified, Docker will check if the system has a @@ -88,7 +88,7 @@ you're joining new nodes through a load balancer, you should use this flag to ensure the node advertises its IP address and not the IP address of the load balancer. -### `--data-path-addr` +### `--data-path-addr` This flag specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. @@ -97,11 +97,11 @@ management traffic of the cluster. If unspecified, Docker will use the same IP address or interface that is used for the advertise address. -### `--token string` +### `--token string` Secret value required for nodes to join the swarm -### `--availability` +### `--availability` This flag specifies the availability of the node at the time the node joins a master. Possible availability values are `active`, `pause`, or `drain`. diff --git a/docs/reference/commandline/swarm_unlock-key.md b/docs/reference/commandline/swarm_unlock-key.md index aaf6abb911..6f6f7844aa 100644 --- a/docs/reference/commandline/swarm_unlock-key.md +++ b/docs/reference/commandline/swarm_unlock-key.md @@ -5,10 +5,10 @@ Manage the unlock key ### Options -| Name | Type | Default | Description | -|:----------------|:-------|:--------|:-------------------| -| `-q`, `--quiet` | `bool` | | Only display token | -| `--rotate` | `bool` | | Rotate unlock key | +| Name | Type | Default | Description | +|:------------------------------------|:-------|:--------|:-------------------| +| [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display token | +| [`--rotate`](#rotate) | `bool` | | Rotate unlock key | @@ -67,12 +67,12 @@ $ docker swarm unlock-key -q SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8 ``` -### `--rotate` +### `--rotate` This flag rotates the unlock key, replacing it with a new randomly-generated key. The old unlock key will no longer be accepted. -### `--quiet` +### `--quiet` Only print the unlock key, without instructions.