Skip to content

Commit 3f1b4c6

Browse files
committed
runtime-config: add example label before json exmaple
Signed-off-by: Gao feng <[email protected]>
1 parent 83e5943 commit 3f1b4c6

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

runtime-config-linux.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Each entry has a type field with possible values described below and an optional
99
If a path is specified, that particular file is used to join that type of namespace.
1010
Also, when a path is specified, a runtime MUST assume that the setup for that particular namespace has already been done and error out if the config specifies anything else related to that namespace.
1111

12+
*Example*
1213
```json
1314
"namespaces": [
1415
{
@@ -61,6 +62,7 @@ Next parameters can be specified:
6162
* **uid** - uid of device owner
6263
* **gid** - gid of device owner
6364

65+
*Example*
6466
```json
6567
"devices": [
6668
{
@@ -140,6 +142,7 @@ The Spec does not include naming schema for cgroups.
140142
The Spec does not support [split hierarchy](https://www.kernel.org/doc/Documentation/cgroups/unified-hierarchy.txt).
141143
The cgroups will be created if they don't exist.
142144

145+
*Example*
143146
```json
144147
"cgroupsPath": "/myRuntime/myContainer"
145148
```
@@ -152,12 +155,14 @@ For example, to run a new process in an existing container without updating limi
152155

153156
#### Disable out-of-memory killer
154157

158+
*Example*
155159
```json
156160
"disableOOMKiller": false
157161
```
158162

159163
#### Memory
160164

165+
*Example*
161166
```json
162167
"memory": {
163168
"limit": 0,
@@ -170,6 +175,7 @@ For example, to run a new process in an existing container without updating limi
170175

171176
#### CPU
172177

178+
*Example*
173179
```json
174180
"cpu": {
175181
"shares": 0,
@@ -206,6 +212,7 @@ The following parameters can be specified to setup the block io controller:
206212

207213
###### Example
208214

215+
*Example*
209216
```json
210217
"blockIO": {
211218
"blkioWeight": 0,
@@ -242,6 +249,7 @@ The following parameters can be specified to setup the block io controller:
242249

243250
#### Huge page limits
244251

252+
*Example*
245253
```json
246254
"hugepageLimits": [
247255
{
@@ -253,6 +261,7 @@ The following parameters can be specified to setup the block io controller:
253261

254262
#### Network
255263

264+
*Example*
256265
```json
257266
"network": {
258267
"classId": "ClassId",
@@ -274,6 +283,7 @@ The following parameters can be specified to setup the block io controller:
274283
sysctl allows kernel parameters to be modified at runtime for the container.
275284
For more information, see [the man page](http://man7.org/linux/man-pages/man8/sysctl.8.html)
276285

286+
*Example*
277287
```json
278288
"sysctl": {
279289
"net.ipv4.ip_forward": "1",
@@ -301,6 +311,7 @@ The kernel enforces the `soft` limit for a resource while the `hard` limit acts
301311

302312
SELinux process label specifies the label with which the processes in a container are run.
303313
For more information about SELinux, see [Selinux documentation](http://selinuxproject.org/page/Main_Page)
314+
*Example*
304315
```json
305316
"selinuxProcessLabel": "system_u:system_r:svirt_lxc_net_t:s0:c124,c675"
306317
```
@@ -310,6 +321,7 @@ For more information about SELinux, see [Selinux documentation](http://selinuxp
310321
Apparmor profile specifies the name of the apparmor profile that will be used for the container.
311322
For more information about Apparmor, see [Apparmor documentation](https://wiki.ubuntu.com/AppArmor)
312323

324+
*Example*
313325
```json
314326
"apparmorProfile": "acme_secure_profile"
315327
```
@@ -351,6 +363,7 @@ Operator Constants:
351363
* `SCMP_CMP_GT`
352364
* `SCMP_CMP_MASKED_EQ`
353365

366+
*Example*
354367
```json
355368
"seccomp": {
356369
"defaultAction": "SCMP_ACT_ALLOW",
@@ -372,6 +385,7 @@ rootfsPropagation sets the rootfs's mount propagation.
372385
Its value is either slave, private, or shared.
373386
[The kernel doc](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) has more information about mount propagation.
374387

388+
*Example*
375389
```json
376390
"rootfsPropagation": "slave",
377391
```

0 commit comments

Comments
 (0)