mirror of
https://github.com/docker/cli.git
synced 2026-08-24 10:05:37 -05:00
man: remove deprecated "--kernel-memory" flag
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
@@ -50,7 +50,6 @@ docker-run - Create and run a new container from an image
|
||||
[**--ip6**[=*IPv6-ADDRESS*]]
|
||||
[**--ipc**[=*IPC*]]
|
||||
[**--isolation**[=*default*]]
|
||||
[**--kernel-memory**[=*KERNEL-MEMORY*]]
|
||||
[**-l**|**--label**[=*[]*]]
|
||||
[**--label-file**[=*[]*]]
|
||||
[**--link**[=*[]*]]
|
||||
@@ -410,15 +409,6 @@ is `hyperv`. Linux only supports `default`.
|
||||
**-l**, **--label** *key*=*value*
|
||||
Set metadata on the container (for example, **--label com.example.key=value**).
|
||||
|
||||
**--kernel-memory**=*number*[*S*]
|
||||
Kernel memory limit; *S* is an optional suffix which can be one of **b**, **k**, **m**, or **g**.
|
||||
|
||||
Constrains the kernel memory available to a container. If a limit of 0
|
||||
is specified (not using **--kernel-memory**), the container's kernel memory
|
||||
is not limited. If you specify a limit, it may be rounded up to a multiple
|
||||
of the operating system's page size and the value can be very large,
|
||||
millions of trillions.
|
||||
|
||||
**--label-file**=[]
|
||||
Read in a line delimited file of labels
|
||||
|
||||
|
||||
@@ -4,25 +4,11 @@ resources from their Docker host. With a single command, you can place
|
||||
limits on a single container or on many. To specify more than one container,
|
||||
provide space-separated list of container names or IDs.
|
||||
|
||||
With the exception of the **--kernel-memory** option, you can specify these
|
||||
options on a running or a stopped container. On kernel version older than
|
||||
4.6, You can only update **--kernel-memory** on a stopped container or on
|
||||
a running container with kernel memory initialized.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
## kernel-memory
|
||||
|
||||
Kernel memory limit (format: `<number>[<unit>]`, where unit = b, k, m or g)
|
||||
|
||||
Note that on kernel version older than 4.6, you can not update kernel memory on
|
||||
a running container if the container is started without kernel memory initialized,
|
||||
in this case, it can only be updated after it's stopped. The new setting takes
|
||||
effect when the container is started.
|
||||
|
||||
## memory
|
||||
|
||||
Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
|
||||
Memory limit (format: `<number>[<unit>]`, where unit = b, k, m or g)
|
||||
|
||||
Note that the memory should be smaller than the already set swap memory limit.
|
||||
If you want update a memory limit bigger than the already set swap memory limit,
|
||||
@@ -52,41 +38,6 @@ To update multiple resource configurations for multiple containers:
|
||||
$ docker container update --cpu-shares 512 -m 300M abebf7571666 hopeful_morse
|
||||
```
|
||||
|
||||
### Update a container's kernel memory constraints
|
||||
|
||||
You can update a container's kernel memory limit using the **--kernel-memory**
|
||||
option. On kernel version older than 4.6, this option can be updated on a
|
||||
running container only if the container was started with **--kernel-memory**.
|
||||
If the container was started *without* **--kernel-memory** you need to stop
|
||||
the container before updating kernel memory.
|
||||
|
||||
NOTE: The **--kernel-memory** option has been deprecated since Docker 20.10.
|
||||
|
||||
For example, if you started a container with this command:
|
||||
|
||||
```console
|
||||
$ docker run -dit --name test --kernel-memory 50M ubuntu bash
|
||||
```
|
||||
|
||||
You can update kernel memory while the container is running:
|
||||
|
||||
```console
|
||||
$ docker container update --kernel-memory 80M test
|
||||
```
|
||||
|
||||
If you started a container *without* kernel memory initialized:
|
||||
|
||||
```console
|
||||
$ docker run -dit --name test2 --memory 300M ubuntu bash
|
||||
```
|
||||
|
||||
Update kernel memory of running container `test2` will fail. You need to stop
|
||||
the container before updating the **--kernel-memory** setting. The next time you
|
||||
start it, the container uses the new value.
|
||||
|
||||
Kernel version newer than (include) 4.6 does not have this limitation, you
|
||||
can use `--kernel-memory` the same way as other options.
|
||||
|
||||
### Update a container's restart policy
|
||||
|
||||
You can change a container's restart policy on a running container. The new
|
||||
|
||||
Reference in New Issue
Block a user