Skip to content

Commit 25f44dd

Browse files
author
Ma Shimiao
committed
config-linux: fix format and definitely require value of masked and readonly paths
Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
1 parent 1c7c27d commit 25f44dd

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

config-linux.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ There is a limit of 5 mappings which is the Linux kernel hard limit.
9999

100100
## Devices
101101

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.
103103
The runtime may supply them however it likes (with [mknod][mknod.2], by bind mounting from the runtime mount namespace, etc.).
104104

105105
The following parameters can be specified:
@@ -199,7 +199,7 @@ However, a runtime MAY attach the container process to additional cgroup control
199199

200200
#### Device whitelist
201201

202-
**`devices`** (array, OPTIONAL) configures the [device whitelist][cgroup-v1-devices].
202+
**`devices`** (array of objects, OPTIONAL) configures the [device whitelist][cgroup-v1-devices].
203203
The runtime MUST apply entries in the listed order.
204204

205205
The following parameters can be specified:
@@ -270,7 +270,7 @@ For more information on how these two settings work together, see [the memory cg
270270

271271
#### Memory
272272

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.
274274
For more information, see [the memory cgroup man page][cgroup-v1-memory].
275275

276276
The following parameters can be specified to setup the controller:
@@ -302,7 +302,7 @@ The following parameters can be specified to setup the controller:
302302

303303
#### CPU
304304

305-
`cpu` represents the cgroup subsystems `cpu` and `cpusets`.
305+
**`cpu`** (object, OPTIONAL) represents the cgroup subsystems `cpu` and `cpusets`.
306306
For more information, see [the cpusets cgroup man page][cgroup-v1-cpusets].
307307

308308
The following parameters can be specified to setup the controller:
@@ -337,7 +337,7 @@ The following parameters can be specified to setup the controller:
337337

338338
#### Block IO Controller
339339

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.
341341
For more information, see [the kernel cgroups documentation about blkio][cgroup-v1-blkio].
342342

343343
The following parameters can be specified to setup the controller:
@@ -395,11 +395,11 @@ The following parameters can be specified to setup the controller:
395395

396396
#### Huge page limits
397397

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
399399
HugeTLB usage per control group and enforces the controller limit during page fault.
400400
For more information, see the [kernel cgroups documentation about HugeTLB][cgroup-v1-hugetlb].
401401

402-
`hugepageLimits` is an array of entries, each having the following structure:
402+
Each entry has the following structure:
403403

404404
* **`pageSize`** *(string, REQUIRED)* - hugepage size
405405

@@ -418,7 +418,7 @@ For more information, see the [kernel cgroups documentation about HugeTLB][cgrou
418418

419419
#### Network
420420

421-
`network` represents the cgroup subsystems `net_cls` and `net_prio`.
421+
**`network`** (object, OPTIONAL) represents the cgroup subsystems `net_cls` and `net_prio`.
422422
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].
423423

424424
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
450450

451451
#### PIDs
452452

453-
`pids` represents the cgroup subsystem `pids`.
453+
**`pids`** (object, OPTIONAL) represents the cgroup subsystem `pids`.
454454
For more information, see [the pids cgroup man page][cgroup-v1-pids].
455455

456456
The following parameters can be specified to setup the controller:
@@ -467,7 +467,7 @@ The following parameters can be specified to setup the controller:
467467

468468
## Sysctl
469469

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.
471471
For more information, see [the man page](http://man7.org/linux/man-pages/man8/sysctl.8.html)
472472

473473
###### Example
@@ -540,7 +540,7 @@ Operator Constants:
540540

541541
## Rootfs Mount Propagation
542542

543-
`rootfsPropagation` sets the rootfs's mount propagation.
543+
**`rootfsPropagation`** (string, OPTIONAL) sets the rootfs's mount propagation.
544544
Its value is either slave, private, or shared.
545545
[The kernel doc](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) has more information about mount propagation.
546546

@@ -552,7 +552,8 @@ Its value is either slave, private, or shared.
552552

553553
## Masked Paths
554554

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].
556557

557558
###### Example
558559

@@ -564,7 +565,8 @@ Its value is either slave, private, or shared.
564565

565566
## Readonly Paths
566567

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].
568570

569571
###### Example
570572

@@ -576,14 +578,15 @@ Its value is either slave, private, or shared.
576578

577579
## Mount Label
578580

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.
580582

581583
###### Example
582584

583585
```json
584586
"mountLabel": "system_u:object_r:svirt_sandbox_file_t:s0:c715,c811"
585587
```
586588

589+
[container-namespace]: glossary.md#container_namespace
587590
[cgroup-v1]: https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
588591
[cgroup-v1-blkio]: https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
589592
[cgroup-v1-cpusets]: https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt

0 commit comments

Comments
 (0)