@@ -99,7 +99,7 @@ There is a limit of 5 mappings which is the Linux kernel hard limit.
99
99
100
100
## Devices
101
101
102
- ** ` devices ` ** (array, OPTIONAL) lists devices that MUST be available in the container.
102
+ ** ` devices ` ** (array of objects , OPTIONAL) lists devices that MUST be available in the container.
103
103
The runtime may supply them however it likes (with [ mknod] [ mknod.2 ] , by bind mounting from the runtime mount namespace, etc.).
104
104
105
105
The following parameters can be specified:
@@ -199,7 +199,7 @@ However, a runtime MAY attach the container process to additional cgroup control
199
199
200
200
#### Device whitelist
201
201
202
- ** ` devices ` ** (array, OPTIONAL) configures the [ device whitelist] [ cgroup-v1-devices ] .
202
+ ** ` devices ` ** (array of objects , OPTIONAL) configures the [ device whitelist] [ cgroup-v1-devices ] .
203
203
The runtime MUST apply entries in the listed order.
204
204
205
205
The following parameters can be specified:
@@ -270,7 +270,7 @@ For more information on how these two settings work together, see [the memory cg
270
270
271
271
#### Memory
272
272
273
- ` memory ` represents the cgroup subsystem ` memory ` and it's used to set limits on the container's memory usage.
273
+ ** ` memory ` ** (object, OPTIONAL) represents the cgroup subsystem ` memory ` and it's used to set limits on the container's memory usage.
274
274
For more information, see [ the memory cgroup man page] [ cgroup-v1-memory ] .
275
275
276
276
The following parameters can be specified to setup the controller:
@@ -302,7 +302,7 @@ The following parameters can be specified to setup the controller:
302
302
303
303
#### CPU
304
304
305
- ` cpu ` represents the cgroup subsystems ` cpu ` and ` cpusets ` .
305
+ ** ` cpu ` ** (object, OPTIONAL) represents the cgroup subsystems ` cpu ` and ` cpusets ` .
306
306
For more information, see [ the cpusets cgroup man page] [ cgroup-v1-cpusets ] .
307
307
308
308
The following parameters can be specified to setup the controller:
@@ -337,7 +337,7 @@ The following parameters can be specified to setup the controller:
337
337
338
338
#### Block IO Controller
339
339
340
- ` blockIO ` represents the cgroup subsystem ` blkio ` which implements the block io controller.
340
+ ** ` blockIO ` ** (object, OPTIONAL) represents the cgroup subsystem ` blkio ` which implements the block io controller.
341
341
For more information, see [ the kernel cgroups documentation about blkio] [ cgroup-v1-blkio ] .
342
342
343
343
The following parameters can be specified to setup the controller:
@@ -395,11 +395,11 @@ The following parameters can be specified to setup the controller:
395
395
396
396
#### Huge page limits
397
397
398
- ` hugepageLimits ` represents the ` hugetlb ` controller which allows to limit the
398
+ ** ` hugepageLimits ` ** (array of objects, OPTIONAL) represents the ` hugetlb ` controller which allows to limit the
399
399
HugeTLB usage per control group and enforces the controller limit during page fault.
400
400
For more information, see the [ kernel cgroups documentation about HugeTLB] [ cgroup-v1-hugetlb ] .
401
401
402
- ` hugepageLimits ` is an array of entries, each having the following structure:
402
+ Each entry has the following structure:
403
403
404
404
* ** ` pageSize ` ** * (string, REQUIRED)* - hugepage size
405
405
@@ -418,7 +418,7 @@ For more information, see the [kernel cgroups documentation about HugeTLB][cgrou
418
418
419
419
#### Network
420
420
421
- ` network ` represents the cgroup subsystems ` net_cls ` and ` net_prio ` .
421
+ ** ` network ` ** (object, OPTIONAL) represents the cgroup subsystems ` net_cls ` and ` net_prio ` .
422
422
For more information, see [ the net\_ cls cgroup man page] [ cgroup-v1-net-cls ] and [ the net\_ prio cgroup man page] [ cgroup-v1-net-prio ] .
423
423
424
424
The following parameters can be specified to setup these cgroup controllers:
@@ -450,7 +450,7 @@ processes in the group and egressing the system on various interfaces. The follo
450
450
451
451
#### PIDs
452
452
453
- ` pids ` represents the cgroup subsystem ` pids ` .
453
+ ** ` pids ` ** (object, OPTIONAL) represents the cgroup subsystem ` pids ` .
454
454
For more information, see [ the pids cgroup man page] [ cgroup-v1-pids ] .
455
455
456
456
The following parameters can be specified to setup the controller:
@@ -467,7 +467,7 @@ The following parameters can be specified to setup the controller:
467
467
468
468
## Sysctl
469
469
470
- ` sysctl ` allows kernel parameters to be modified at runtime for the container.
470
+ ** ` sysctl ` ** (object, OPTIONAL) allows kernel parameters to be modified at runtime for the container.
471
471
For more information, see [ the man page] ( http://man7.org/linux/man-pages/man8/sysctl.8.html )
472
472
473
473
###### Example
@@ -540,7 +540,7 @@ Operator Constants:
540
540
541
541
## Rootfs Mount Propagation
542
542
543
- ` rootfsPropagation ` sets the rootfs's mount propagation.
543
+ ** ` rootfsPropagation ` ** (string, OPTIONAL) sets the rootfs's mount propagation.
544
544
Its value is either slave, private, or shared.
545
545
[ The kernel doc] ( https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt ) has more information about mount propagation.
546
546
@@ -552,7 +552,8 @@ Its value is either slave, private, or shared.
552
552
553
553
## Masked Paths
554
554
555
- ` maskedPaths ` will mask over the provided paths inside the container so that they cannot be read.
555
+ ** ` maskedPaths ` ** (array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read.
556
+ The values MUST be absolute paths in the [ container namespace] [ container-namespace ] .
556
557
557
558
###### Example
558
559
@@ -564,7 +565,8 @@ Its value is either slave, private, or shared.
564
565
565
566
## Readonly Paths
566
567
567
- ` readonlyPaths ` will set the provided paths as readonly inside the container.
568
+ ** ` readonlyPaths ` ** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container.
569
+ The values MUST be absolute paths in the [ container namespace] [ container-namespace ] .
568
570
569
571
###### Example
570
572
@@ -576,14 +578,15 @@ Its value is either slave, private, or shared.
576
578
577
579
## Mount Label
578
580
579
- ` mountLabel ` will set the Selinux context for the mounts in the container.
581
+ ** ` mountLabel ` ** (string, OPTIONAL) will set the Selinux context for the mounts in the container.
580
582
581
583
###### Example
582
584
583
585
``` json
584
586
"mountLabel" : " system_u:object_r:svirt_sandbox_file_t:s0:c715,c811"
585
587
```
586
588
589
+ [ container-namespace ] : glossary.md#container_namespace
587
590
[ cgroup-v1 ] : https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
588
591
[ cgroup-v1-blkio ] : https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
589
592
[ cgroup-v1-cpusets ] : https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt
0 commit comments