1berry/docker-cli
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5859 from thaJeztah/fix_docs

Browse Source 
docs: minor fixes and touch-ups for anchor links
This commit is contained in:
Sebastiaan van Stijn 2025-02-24 12:05:34 +01:00 committed by GitHub
commit 656523e20d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/commandline/container_restart.md
View File

@ -42,7 +42,7 @@ container, `SIGTERM` is used as default.
### <a name="timeout"></a> Stop container with timeout (-t, --timeout) ### <a name="timeout"></a> Stop container with timeout (-t, --timeout)
The `--timeout` flag sets the number of seconds to wait for the container 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 If the container does not exit after the timeout elapses, it's forcibly killed
with a `SIGKILL` signal. with a `SIGKILL` signal.

4
docs/reference/commandline/network_ls.md
View File

@ -13,7 +13,7 @@ List networks
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) | | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) |
| [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>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 | | `-q`, `--quiet` | `bool` | | Only display network IDs |
@ -37,6 +37,8 @@ cf03ee007fb4 host host local
78b03ee04fc4 multi-host overlay swarm 78b03ee04fc4 multi-host overlay swarm
``` ```
### <a name="no-trunc"></a> List networks without truncating the ID column (--no-trun)
Use the `--no-trunc` option to display the full network id: Use the `--no-trunc` option to display the full network id:
```console ```console

12
docs/reference/commandline/swarm_join-token.md
View File

@ -5,10 +5,10 @@ Manage join tokens
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:----------------|:-------|:--------|:-------------------| |:------------------------------------|:-------|:--------|:-------------------|
| `-q`, `--quiet` | `bool` | | Only display token | | [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display token |
| `--rotate` | `bool` | | Rotate join token | | [`--rotate`](#rotate) | `bool` | | Rotate join token |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->
@ -77,7 +77,7 @@ $ docker swarm join-token -q worker
SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t
``` ```
### `--rotate` ### <a name="rotate"></a> `--rotate`
Because tokens allow new nodes to join the swarm, you should keep them secret. 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 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 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. because the join token is only used for authorizing new nodes joining the swarm.
### `--quiet` ### <a name="quiet"></a> `--quiet`
Only print the token. Do not print a complete command for joining. Only print the token. Do not print a complete command for joining.

24
docs/reference/commandline/swarm_join.md
View File

@ -5,13 +5,13 @@ Join a swarm as a node and/or manager
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:-------------------|:------------|:---------------|:------------------------------------------------------------------------------| |:--------------------------------------|:------------|:---------------|:------------------------------------------------------------------------------|
| `--advertise-addr` | `string` | | Advertised address (format: `<ip\|interface>[:port]`) | | [`--advertise-addr`](#advertise-addr) | `string` | | Advertised address (format: `<ip\|interface>[:port]`) |
| `--availability` | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) | | [`--availability`](#availability) | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) |
| `--data-path-addr` | `string` | | Address or interface to use for data path traffic (format: `<ip\|interface>`) | | [`--data-path-addr`](#data-path-addr) | `string` | | Address or interface to use for data path traffic (format: `<ip\|interface>`) |
| `--listen-addr` | `node-addr` | `0.0.0.0:2377` | Listen address (format: `<ip\|interface>[:port]`) | | [`--listen-addr`](#listen-addr) | `node-addr` | `0.0.0.0:2377` | Listen address (format: `<ip\|interface>[:port]`) |
| `--token` | `string` | | Token for entry into the swarm | | [`--token`](#token) | `string` | | Token for entry into the swarm |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->
@ -57,7 +57,7 @@ dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active Reachable
dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader
``` ```
### `--listen-addr value` ### <a name="listen-addr"></a> `--listen-addr value`
If the node is a manager, it will listen for inbound swarm manager traffic on this 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 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. This flag is generally not necessary when joining an existing swarm.
### `--advertise-addr value` ### <a name="advertise-addr"></a> `--advertise-addr value`
This flag specifies the address that will be advertised to other members of the 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 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 ensure the node advertises its IP address and not the IP address of the load
balancer. balancer.
### `--data-path-addr` ### <a name="data-path-addr"></a> `--data-path-addr`
This flag specifies the address that global scope network drivers will publish towards 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. 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 If unspecified, Docker will use the same IP address or interface that is used for the
advertise address. advertise address.
### `--token string` ### <a name="token"></a> `--token string`
Secret value required for nodes to join the swarm Secret value required for nodes to join the swarm
### `--availability` ### <a name="availability"></a> `--availability`
This flag specifies the availability of the node at the time the node joins a master. This flag specifies the availability of the node at the time the node joins a master.
Possible availability values are `active`, `pause`, or `drain`. Possible availability values are `active`, `pause`, or `drain`.

12
docs/reference/commandline/swarm_unlock-key.md
View File

@ -5,10 +5,10 @@ Manage the unlock key
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:----------------|:-------|:--------|:-------------------| |:------------------------------------|:-------|:--------|:-------------------|
| `-q`, `--quiet` | `bool` | | Only display token | | [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display token |
| `--rotate` | `bool` | | Rotate unlock key | | [`--rotate`](#rotate) | `bool` | | Rotate unlock key |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->
@ -67,12 +67,12 @@ $ docker swarm unlock-key -q
SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8 SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8
``` ```
### `--rotate` ### <a name="rotate"></a> `--rotate`
This flag rotates the unlock key, replacing it with a new randomly-generated This flag rotates the unlock key, replacing it with a new randomly-generated
key. The old unlock key will no longer be accepted. key. The old unlock key will no longer be accepted.
### `--quiet` ### <a name="quiet"></a> `--quiet`
Only print the unlock key, without instructions. Only print the unlock key, without instructions.