runtime-config: add example label before json exmaple

Signed-off-by: Gao feng <omarapazanadi@gmail.com>
opencontainers · Oct 9, 2015 · 3f1b4c6 · 3f1b4c6
1 parent 83e5943
commit 3f1b4c6
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/runtime-config-linux.md b/runtime-config-linux.md
@@ -9,6 +9,7 @@ Each entry has a type field with possible values described below and an optional
 If a path is specified, that particular file is used to join that type of namespace.
 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.
 
+*Example*
 ```json
     "namespaces": [
         {
@@ -61,6 +62,7 @@ Next parameters can be specified:
 * **uid** - uid of device owner
 * **gid** - gid of device owner
 
+*Example*
 ```json
    "devices": [
         {
@@ -140,6 +142,7 @@ The Spec does not include naming schema for cgroups.
 The Spec does not support [split hierarchy](https://www.kernel.org/doc/Documentation/cgroups/unified-hierarchy.txt).
 The cgroups will be created if they don't exist.
 
+*Example*
 ```json
    "cgroupsPath": "/myRuntime/myContainer"
 ```
@@ -152,12 +155,14 @@ For example, to run a new process in an existing container without updating limi
 
 #### Disable out-of-memory killer
 
+*Example*
 ```json
     "disableOOMKiller": false
 ```
 
 #### Memory
 
+*Example*
 ```json
     "memory": {
         "limit": 0,
@@ -170,6 +175,7 @@ For example, to run a new process in an existing container without updating limi
 
 #### CPU
 
+*Example*
 ```json
     "cpu": {
         "shares": 0,
@@ -206,6 +212,7 @@ The following parameters can be specified to setup the block io controller:
 
 ###### Example
 
+*Example*
 ```json
     "blockIO": {
         "blkioWeight": 0,
@@ -242,6 +249,7 @@ The following parameters can be specified to setup the block io controller:
 
 #### Huge page limits
 
+*Example*
 ```json
    "hugepageLimits": [
         {
@@ -253,6 +261,7 @@ The following parameters can be specified to setup the block io controller:
 
 #### Network
 
+*Example*
 ```json
    "network": {
         "classId": "ClassId",
@@ -274,6 +283,7 @@ The following parameters can be specified to setup the block io controller:
 sysctl allows kernel parameters to be modified at runtime for the container.
 For more information, see [the man page](http://man7.org/linux/man-pages/man8/sysctl.8.html)
 
+*Example*
 ```json
    "sysctl": {
         "net.ipv4.ip_forward": "1",
@@ -301,6 +311,7 @@ The kernel enforces the `soft` limit for a resource while the `hard` limit acts
 
 SELinux process label specifies the label with which the processes in a container are run.
 For more information about SELinux, see  [Selinux documentation](http://selinuxproject.org/page/Main_Page)
+*Example*
 ```json
    "selinuxProcessLabel": "system_u:system_r:svirt_lxc_net_t:s0:c124,c675"
 ```
@@ -310,6 +321,7 @@ For more information about SELinux, see  [Selinux documentation](http://selinuxp
 Apparmor profile specifies the name of the apparmor profile that will be used for the container.
 For more information about Apparmor, see [Apparmor documentation](https://wiki.ubuntu.com/AppArmor)
 
+*Example*
 ```json
    "apparmorProfile": "acme_secure_profile"
 ```
@@ -351,6 +363,7 @@ Operator Constants:
 * `SCMP_CMP_GT`
 * `SCMP_CMP_MASKED_EQ`
 
+*Example*
 ```json
    "seccomp": {
        "defaultAction": "SCMP_ACT_ALLOW",
@@ -372,6 +385,7 @@ rootfsPropagation sets the rootfs's mount propagation.
 Its value is either slave, private, or shared.
 [The kernel doc](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) has more information about mount propagation.
 
+*Example*
 ```json
     "rootfsPropagation": "slave",
 ```