Skip to content

Commit 77336de

Browse files
committed
Add documentation for Intel RDT support
Signed-off-by: Wolfgang Pross <[email protected]>
1 parent 24b2f82 commit 77336de

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
####> This option file is used in:
2+
####> podman create, run
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
#### **--rdt-class**=*intel-rdt-class-of-service*
6+
7+
Rdt-class sets the class of service (CLOS or COS) for the container to run in. Based on the Cache Allocation Technology (CAT) feature that is part of Intel's Resource Director Technology (RDT) feature set, all processes of the container will run within the pre-configured COS, that represents a part of the cache. The COS has to be created and configured by means of a pseudo file system (usually mounted at `/sys/fs/resctrl`) that the resctrl kernel driver provides. Assigning the container to a COS requires root privileges and thus doesn't work in a rootless environment. Currently the feature is only supported using `runc` as a runtime. See <https://docs.kernel.org/arch/x86/resctrl.html> for more details on how to create a COS before a container can be assigned to it.

docs/source/markdown/podman-create.1.md.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,8 @@ by having one container bind to localhost in the pod, and another connect to tha
304304

305305
Suppress output information when pulling images
306306

307+
@@option rdt-class
308+
307309
@@option read-only
308310

309311
@@option read-only-tmpfs

docs/source/markdown/podman-run.1.md.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,8 @@ by having one container bind to localhost in the pod, and another connect to tha
330330

331331
Suppress output information when pulling images
332332

333+
@@option rdt-class
334+
333335
@@option read-only
334336

335337
@@option read-only-tmpfs

0 commit comments

Comments
 (0)