From 72df1960e153f7841957ac74f80208a7fe6327b9 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 23 Nov 2023 14:17:19 +0100 Subject: [PATCH] docs: move --cgroup-parent to docker run reference Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/reference/commandline/run.md | 9 ++++++++- docs/reference/run.md | 7 ------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 445111bd98..1100aa4ece 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -18,7 +18,7 @@ Create and run a new container from an image | `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) | | `--cap-add` | `list` | | Add Linux capabilities | | `--cap-drop` | `list` | | Drop Linux capabilities | -| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | +| [`--cgroup-parent`](#cgroup-parent) | `string` | | Optional parent cgroup for the container | | `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
default-cgroupns-mode option on the daemon (default) | | [`--cidfile`](#cidfile) | `string` | | Write the container ID to the file | | `--cpu-count` | `int64` | `0` | CPU count (Windows only) | @@ -949,6 +949,13 @@ You can use the `-t` flag without `-i` flag. This still allocates a pseudo-TTY to the container, but with no way of writing to `STDIN`. The only time this might be useful is if the output of the container requires a TTY environment. +## Specify custom cgroups + +Using the `--cgroup-parent` flag, you can pass a specific cgroup to run a +container in. This allows you to create and manage cgroups on their own. You can +define custom resources for those cgroups and put containers under a common +parent group. + ### Using dynamically created devices (--device-cgroup-rule) Docker assigns devices available to a container at creation time. The diff --git a/docs/reference/run.md b/docs/reference/run.md index 52a99eb611..0653c26c5e 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -241,13 +241,6 @@ $ echo $? 3 ``` -## Specify custom cgroups - -Using the `--cgroup-parent` flag, you can pass a specific cgroup to run a -container in. This allows you to create and manage cgroups on their own. You can -define custom resources for those cgroups and put containers under a common -parent group. - ## Runtime constraints on resources The operator can also adjust the performance parameters of the