Skip to content

Commit fb20f00

Browse files
authored
Merge pull request #5366 from dvdksn/27x_f1befabe9f1c979d94c39eeb7020e106b3c1e6a6
[27.x backport] use gh alert syntax for callouts
2 parents cabd410 + 2d7b899 commit fb20f00

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+101
-193
lines changed

docs/deprecated.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,7 @@ Docker API v1.42 and up now ignores this option when set. Older versions of the
562562
API continue to accept the option, but depending on the OCI runtime used, may
563563
take no effect.
564564

565-
> **Note**
566-
>
565+
> [!NOTE]
567566
> While not deprecated (yet) in Docker, the OCI runtime specification also
568567
> deprecated the `memory.kmem.tcp.limit_in_bytes` option. When using `runc` as
569568
> runtime, this option takes no effect. The linux kernel did not explicitly

docs/extend/index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ plugins using Docker Engine.
1616
For information about legacy (non-managed) plugins, refer to
1717
[Understand legacy Docker Engine plugins](legacy_plugins.md).
1818

19-
> **Note**
20-
>
19+
> [!NOTE]
2120
> Docker Engine managed plugins are currently not supported on Windows daemons.
2221
2322
## Installing and using a plugin
@@ -38,8 +37,7 @@ operation, such as creating a volume.
3837
In the following example, you install the `sshfs` plugin, verify that it is
3938
enabled, and use it to create a volume.
4039

41-
> **Note**
42-
>
40+
> [!NOTE]
4341
> This example is intended for instructional purposes only. Once the volume is
4442
> created, your SSH password to the remote host is exposed as plaintext when
4543
> inspecting the volume. Delete the volume as soon as you are done with the
@@ -126,8 +124,7 @@ commands and options, see the
126124
The `rootfs` directory represents the root filesystem of the plugin. In this
127125
example, it was created from a Dockerfile:
128126

129-
> **Note**
130-
>
127+
> [!NOTE]
131128
> The `/run/docker/plugins` directory is mandatory inside of the
132129
> plugin's filesystem for Docker to communicate with the plugin.
133130

docs/extend/plugins_authorization.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ Authorization plugins must follow the rules described in [Docker Plugin API](plu
4343
Each plugin must reside within directories described under the
4444
[Plugin discovery](plugin_api.md#plugin-discovery) section.
4545

46-
> **Note**
47-
>
46+
> [!NOTE]
4847
> The abbreviations `AuthZ` and `AuthN` mean authorization and authentication
4948
> respectively.
5049

docs/extend/plugins_metrics.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ Docker exposes internal metrics based on the Prometheus format. Metrics plugins
88
enable accessing these metrics in a consistent way by providing a Unix
99
socket at a predefined path where the plugin can scrape the metrics.
1010

11-
> **Note**
12-
>
11+
> [!NOTE]
1312
> While the plugin interface for metrics is non-experimental, the naming of the
1413
> metrics and metric labels is still considered experimental and may change in a
1514
> future version.

docs/extend/plugins_volume.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,7 @@ provide the Docker Daemon with writeable paths on the host filesystem. The Docke
8080
daemon provides these paths to containers to consume. The Docker daemon makes
8181
the volumes available by bind-mounting the provided paths into the containers.
8282

83-
> **Note**
84-
>
83+
> [!NOTE]
8584
> Volume plugins should *not* write data to the `/var/lib/docker/` directory,
8685
> including `/var/lib/docker/volumes`. The `/var/lib/docker/` directory is
8786
> reserved for Docker.

docs/reference/commandline/config_create.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ Creates a config using standard input or from a file for the config content.
1919

2020
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2121

22-
> **Note**
23-
>
22+
> [!NOTE]
2423
> This is a cluster management command, and must be executed on a Swarm
2524
> manager node. To learn about managers and workers, refer to the
2625
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the

docs/reference/commandline/config_inspect.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ describes all the details of the format.
2525

2626
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2727

28-
> **Note**
29-
>
28+
> [!NOTE]
3029
> This is a cluster management command, and must be executed on a Swarm
3130
> manager node. To learn about managers and workers, refer to the
3231
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the

docs/reference/commandline/config_ls.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Run this command on a manager node to list the configs in the Swarm.
2424

2525
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2626

27-
> **Note**
28-
>
27+
> [!NOTE]
2928
> This is a cluster management command, and must be executed on a Swarm
3029
> manager node. To learn about managers and workers, refer to the
3130
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the

docs/reference/commandline/config_rm.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ Removes the specified configs from the Swarm.
1616

1717
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
1818

19-
> **Note**
20-
>
19+
> [!NOTE]
2120
> This is a cluster management command, and must be executed on a Swarm
2221
> manager node. To learn about managers and workers, refer to the
2322
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
@@ -32,8 +31,7 @@ $ docker config rm my_config
3231
sapth4csdo5b6wz2p5uimh5xg
3332
```
3433

35-
> **Warning**
36-
>
34+
> [!WARNING]
3735
> This command doesn't ask for confirmation before removing a config.
3836
{ .warning }
3937

docs/reference/commandline/container_attach.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ Use `docker attach` to attach your terminal's standard input, output, and error
2525
ID or name. This lets you view its output or control it interactively, as
2626
though the commands were running directly in your terminal.
2727

28-
> **Note**
29-
>
28+
> [!NOTE]
3029
> The `attach` command displays the output of the container's `ENTRYPOINT` and
3130
> `CMD` process. This can appear as if the attach command is hung when in fact
3231
> the process may simply not be writing any output at that time.
@@ -39,8 +38,7 @@ container. If `--sig-proxy` is true (the default),`CTRL-c` sends a `SIGINT` to
3938
the container. If the container was run with `-i` and `-t`, you can detach from
4039
a container and leave it running using the `CTRL-p CTRL-q` key sequence.
4140

42-
> **Note**
43-
>
41+
> [!NOTE]
4442
> A process running as PID 1 inside a container is treated specially by
4543
> Linux: it ignores any signal with the default action. So, the process
4644
> doesn't terminate on `SIGINT` or `SIGTERM` unless it's coded to do so.

docs/reference/commandline/container_kill.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ set through `--signal` may be non-terminal, depending on the container's main
3333
process. For example, the `SIGHUP` signal in most cases will be non-terminal,
3434
and the container will continue running after receiving the signal.
3535

36-
> **Note**
37-
>
36+
> [!NOTE]
3837
> `ENTRYPOINT` and `CMD` in the *shell* form run as a child process of
3938
> `/bin/sh -c`, which does not pass signals. This means that the executable is
4039
> not the container’s PID 1 and does not receive Unix signals.

docs/reference/commandline/container_run.md

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,7 @@ running processes in that namespace. By default, all containers, including
291291
those with `--network=host`, have their own UTS namespace. Setting `--uts` to
292292
`host` results in the container using the same UTS namespace as the host.
293293

294-
> **Note**
295-
>
294+
> [!NOTE]
296295
> Docker disallows combining the `--hostname` and `--domainname` flags with
297296
> `--uts=host`. This is to prevent containers running in the host's UTS
298297
> namespace from attempting to change the hosts' configuration.
@@ -350,8 +349,7 @@ In other words, the container can then do almost everything that the host can
350349
do. This flag exists to allow special use-cases, like running Docker within
351350
Docker.
352351

353-
> **Warning**
354-
>
352+
> [!WARNING]
355353
> Use the `--privileged` flag with caution.
356354
> A container with `--privileged` is not a securely sandboxed process.
357355
> Containers in this mode can get a root shell on the host
@@ -533,8 +531,7 @@ host. You can also specify `udp` and `sctp` ports. The [Networking overview
533531
page](https://docs.docker.com/network/) explains in detail how to publish ports
534532
with Docker.
535533

536-
> **Note**
537-
>
534+
> [!NOTE]
538535
> If you don't specify an IP address (i.e., `-p 80:80` instead of `-p
539536
> 127.0.0.1:80:80`) when publishing a container's ports, Docker publishes the
540537
> port on all interfaces (address `0.0.0.0`) by default. These ports are
@@ -715,8 +712,7 @@ or name. For `overlay` networks or custom plugins that support multi-host
715712
connectivity, containers connected to the same multi-host network but launched
716713
from different Engines can also communicate in this way.
717714

718-
> **Note**
719-
>
715+
> [!NOTE]
720716
> The default bridge network only allows containers to communicate with each other using
721717
> internal IP addresses. User-created bridge networks provide DNS resolution between
722718
> containers using container names.
@@ -784,8 +780,7 @@ $ docker network create --subnet 192.0.2.0/24 my-net
784780
$ docker run -itd --network=name=my-net,\"driver-opt=com.docker.network.endpoint.sysctls=net.ipv4.conf.IFNAME.log_martians=1,net.ipv4.conf.IFNAME.forwarding=0\",ip=192.0.2.42 busybox
785781
```
786782

787-
> **Note**
788-
>
783+
> [!NOTE]
789784
> Network drivers may restrict the sysctl settings that can be modified and, to protect
790785
> the operation of the network, new restrictions may be added in the future.
791786
@@ -912,8 +907,7 @@ $ docker run --device=/dev/sda:/dev/xvdc:m --rm -it ubuntu fdisk /dev/xvdc
912907
fdisk: unable to open /dev/xvdc: Operation not permitted
913908
```
914909

915-
> **Note**
916-
>
910+
> [!NOTE]
917911
> The `--device` option cannot be safely used with ephemeral devices. You shouldn't
918912
> add block devices that may be removed to untrusted containers with `--device`.
919913
@@ -935,15 +929,13 @@ ports on the host visible in the container.
935929
PS C:\> docker run --device=class/86E0D1E0-8089-11D0-9CE4-08003E301F73 mcr.microsoft.com/windows/servercore:ltsc2019
936930
```
937931

938-
> **Note**
939-
>
932+
> [!NOTE]
940933
> The `--device` option is only supported on process-isolated Windows containers,
941934
> and produces an error if the container isolation is `hyperv`.
942935
943936
#### CDI devices
944937

945-
> **Note**
946-
>
938+
> [!NOTE]
947939
> The CDI feature is experimental, and potentially subject to change.
948940
> CDI is currently only supported for Linux containers.
949941
@@ -1010,8 +1002,7 @@ ID once the container has finished running.
10101002
$ cat somefile | docker run -i -a stdin mybuilder dobuild
10111003
```
10121004

1013-
> **Note**
1014-
>
1005+
> [!NOTE]
10151006
> A process running as PID 1 inside a container is treated specially by
10161007
> Linux: it ignores any signal with the default action. So, the process
10171008
> doesn't terminate on `SIGINT` or `SIGTERM` unless it's coded to do so.
@@ -1124,16 +1115,16 @@ $ docker run -d --device-cgroup-rule='c 42:* rmw' --name my-container my-image
11241115
Then, a user could ask `udev` to execute a script that would `docker exec my-container mknod newDevX c 42 <minor>`
11251116
the required device when it is added.
11261117

1127-
> **Note**: You still need to explicitly add initially present devices to the
1118+
> [!NOTE]
1119+
> You still need to explicitly add initially present devices to the
11281120
> `docker run` / `docker create` command.
11291121
11301122
### <a name="gpus"></a> Access an NVIDIA GPU
11311123

11321124
The `--gpus` flag allows you to access NVIDIA GPU resources. First you need to
11331125
install the [nvidia-container-runtime](https://nvidia.github.io/nvidia-container-runtime/).
11341126

1135-
> **Note**
1136-
>
1127+
> [!NOTE]
11371128
> You can also specify a GPU as a CDI device with the `--device` flag, see
11381129
> [CDI devices](#cdi-devices).
11391130
@@ -1246,8 +1237,7 @@ the container and remove the file system when the container exits, use the
12461237
--rm=false: Automatically remove the container when it exits
12471238
```
12481239

1249-
> **Note**
1250-
>
1240+
> [!NOTE]
12511241
> If you set the `--rm` flag, Docker also removes the anonymous volumes
12521242
> associated with the container when the container is removed. This is similar
12531243
> to running `docker rm -v my-container`. Only volumes that are specified
@@ -1345,14 +1335,12 @@ $ docker run --ulimit nofile=1024:1024 --rm debian sh -c "ulimit -n"
13451335
1024
13461336
```
13471337

1348-
> **Note**
1349-
>
1338+
> [!NOTE]
13501339
> If you don't provide a hard limit value, Docker uses the soft limit value
13511340
> for both values. If you don't provide any values, they are inherited from
13521341
> the default `ulimits` set on the daemon.
13531342
1354-
> **Note**
1355-
>
1343+
> [!NOTE]
13561344
> The `as` option is deprecated.
13571345
> In other words, the following script is not supported:
13581346
>
@@ -1417,8 +1405,7 @@ the same content between containers.
14171405
$ docker run --security-opt label=level:s0:c100,c200 -it fedora bash
14181406
```
14191407

1420-
> **Note**
1421-
>
1408+
> [!NOTE]
14221409
> Automatic translation of MLS labels isn't supported.
14231410
14241411
To disable the security labeling for a container entirely, you can use
@@ -1436,8 +1423,7 @@ that's only allowed to listen on Apache ports:
14361423
$ docker run --security-opt label=type:svirt_apache_t -it ubuntu bash
14371424
```
14381425

1439-
> **Note**
1440-
>
1426+
> [!NOTE]
14411427
> You would have to write policy defining a `svirt_apache_t` type.
14421428
14431429
To prevent your container processes from gaining additional privileges, you can
@@ -1558,8 +1544,7 @@ network namespace, run this command:
15581544
$ docker run --sysctl net.ipv4.ip_forward=1 someimage
15591545
```
15601546

1561-
> **Note**
1562-
>
1547+
> [!NOTE]
15631548
> Not all sysctls are namespaced. Docker does not support changing sysctls
15641549
> inside of a container that also modify the host system. As the kernel
15651550
> evolves we expect to see more sysctls become namespaced.

docs/reference/commandline/container_stats.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ containers do not return any data.
2929
If you need more detailed information about a container's resource usage, use
3030
the `/containers/(id)/stats` API endpoint.
3131

32-
> **Note**
33-
>
32+
> [!NOTE]
3433
> On Linux, the Docker CLI reports memory usage by subtracting cache usage from
3534
> the total memory usage. The API does not perform such a calculation but rather
3635
> provides the total memory usage and the amount from the cache so that clients
@@ -41,8 +40,7 @@ the `/containers/(id)/stats` API endpoint.
4140
> field. On cgroup v2 hosts, the cache usage is defined as the value of
4241
> `inactive_file` field.
4342
44-
> **Note**
45-
>
43+
> [!NOTE]
4644
> The `PIDS` column contains the number of processes and kernel threads created
4745
> by that container. Threads is the term used by Linux kernel. Other equivalent
4846
> terms are "lightweight process" or "kernel task", etc. A large number in the

docs/reference/commandline/container_update.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ options on a running or a stopped container. On kernel version older than
4242
4.6, you can only update `--kernel-memory` on a stopped container or on
4343
a running container with kernel memory initialized.
4444

45-
> **Warning**
46-
>
45+
> [!WARNING]
4746
> The `docker update` and `docker container update` commands are not supported
4847
> for Windows containers.
4948
{ .warning }
@@ -78,8 +77,7 @@ running container only if the container was started with `--kernel-memory`.
7877
If the container was started without `--kernel-memory` you need to stop
7978
the container before updating kernel memory.
8079

81-
> **Note**
82-
>
80+
> [!NOTE]
8381
> The `--kernel-memory` option has been deprecated since Docker 20.10.
8482
8583
For example, if you started a container with this command:

docs/reference/commandline/container_wait.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ Block until one or more containers stop, then print their exit codes
1010

1111
<!---MARKER_GEN_END-->
1212

13-
> **Note**
14-
>
13+
> [!NOTE]
1514
> `docker wait` returns `0` when run against a container which had already
1615
> exited before the `docker wait` command was run.
1716

0 commit comments

Comments
 (0)