Skip to content

Commit

Permalink
Merge pull request opencontainers#370 from vbatts/json_schema_and_exa…
Browse files Browse the repository at this point in the history 
…mples

Json schema and examples
  • Loading branch information
Mrunal Patel committed Apr 12, 2016
2 parents d445f0c + d4e7326 commit 6734c7a
Show file tree
Hide file tree
Showing 5 changed files with 272 additions and 78 deletions.
30 changes: 15 additions & 15 deletions config-linux.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ For more information on how these two settings work together, see [the memory cg
###### Example

```json
"oomScoreAdj": 0
"oomScoreAdj": 100
```

#### Memory
Expand All @@ -251,9 +251,9 @@ For more information, see [the memory cgroup man page][cgroup-v1-memory].

The following parameters can be specified to setup the controller:

* **`limit`** *(uint64, optional)* - sets limit of memory usage
* **`limit`** *(uint64, optional)* - sets limit of memory usage in bytes

* **`reservation`** *(uint64, optional)* - sets soft limit of memory usage
* **`reservation`** *(uint64, optional)* - sets soft limit of memory usage in bytes

* **`swap`** *(uint64, optional)* - sets limit of memory+Swap usage

Expand All @@ -267,9 +267,9 @@ The following parameters can be specified to setup the controller:

```json
"memory": {
"limit": 0,
"reservation": 0,
"swap": 0,
"limit": 536870912,
"reservation": 536870912,
"swap": 536870912,
"kernel": 0,
"kernelTCP": 0,
"swappiness": 0
Expand Down Expand Up @@ -301,13 +301,13 @@ The following parameters can be specified to setup the controller:

```json
"cpu": {
"shares": 0,
"quota": 0,
"period": 0,
"realtimeRuntime": 0,
"realtimePeriod": 0,
"cpus": "",
"mems": ""
"shares": 1024,
"quota": 1000000,
"period": 500000,
"realtimeRuntime": 950000,
"realtimePeriod": 1000000,
"cpus": "2-3",
"mems": "0-7"
}
```

Expand Down Expand Up @@ -337,8 +337,8 @@ The following parameters can be specified to setup the controller:

```json
"blockIO": {
"blkioWeight": 0,
"blkioLeafWeight": 0,
"blkioWeight": 10,
"blkioLeafWeight": 10,
"blkioWeightDevice": [
{
"major": 8,
Expand Down
198 changes: 191 additions & 7 deletions config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ If a hook returns a non-zero exit code, then an error is logged and the remainin
],
"poststart": [
{
"path": "/usr/bin/notify-start"
"path": "/usr/bin/notify-start",
"timeout": 5
}
],
Expand Down Expand Up @@ -269,7 +269,7 @@ Here is a full example `config.json` for reference.

```json
{
"ociVersion": "0.3.0",
"ociVersion": "0.5.0-dev",
"platform": {
"os": "linux",
"arch": "amd64"
Expand All @@ -284,6 +284,20 @@ Here is a full example `config.json` for reference.
6
]
},
"uidMappings": [
{
"hostID": 1000,
"containerID": 0,
"size": 32000
}
],
"gidMappings": [
{
"hostID": 1000,
"containerID": 0,
"size": 32000
}
],
"args": [
"sh"
],
Expand All @@ -298,14 +312,20 @@ Here is a full example `config.json` for reference.
"CAP_NET_BIND_SERVICE"
],
"rlimits": [
{
"type": "RLIMIT_CORE",
"hard": 1024,
"soft": 1024
},
{
"type": "RLIMIT_NOFILE",
"hard": 1024,
"soft": 1024
}
],
"apparmorProfile": "",
"selinuxLabel": ""
"apparmorProfile": "acme_secure_profile",
"selinuxLabel": "system_u:system_r:svirt_lxc_net_t:s0:c124,c675",
"noNewPrivileges": true
},
"root": {
"path": "rootfs",
Expand Down Expand Up @@ -390,20 +410,166 @@ Here is a full example `config.json` for reference.
"hooks": {
"prestart": [
{
"path": "/usr/bin/uptime",
"path": "/usr/bin/fix-mounts",
"args": [
"/usr/bin/uptime"
"fix-mounts",
"arg1",
"arg2"
],
"env": []
"env": [
"key1=value1"
]
},
{
"path": "/usr/bin/setup-network"
}
],
"poststart": [
{
"path": "/usr/bin/notify-start",
"timeout": 5
}
],
"poststop": [
{
"path": "/usr/sbin/cleanup.sh",
"args": [
"cleanup.sh",
"-f"
]
}
]
},
"linux": {
"devices": [
{
"path": "/dev/fuse",
"type": "c",
"major": 10,
"minor": 229,
"fileMode": 438,
"uid": 0,
"gid": 0
},
{
"path": "/dev/sda",
"type": "b",
"major": 8,
"minor": 0,
"fileMode": 432,
"uid": 0,
"gid": 0
}
],
"sysctl": {
"net.ipv4.ip_forward": "1",
"net.core.somaxconn": "256"
},
"cgroupsPath": "/myRuntime/myContainer",
"resources": {
"network": {
"classID": 1048577,
"priorities": [
{
"name": "eth0",
"priority": 500
},
{
"name": "eth1",
"priority": 1000
}
]
},
"pids": {
"limit": 32771
},
"hugepageLimits": [
{
"pageSize": "2MB",
"limit": 9223372036854772000
}
],
"oomScoreAdj": 100,
"memory": {
"limit": 536870912,
"reservation": 536870912,
"swap": 536870912,
"kernel": 0,
"kernelTCP": 0,
"swappiness": 0
},
"cpu": {
"shares": 1024,
"quota": 1000000,
"period": 500000,
"realtimeRuntime": 950000,
"realtimePeriod": 1000000,
"cpus": "2-3",
"mems": "0-7"
},
"disableOOMKiller": false,
"devices": [
{
"allow": false,
"access": "rwm"
},
{
"allow": true,
"type": "c",
"major": 10,
"minor": 229,
"access": "rw"
},
{
"allow": true,
"type": "b",
"major": 8,
"minor": 0,
"access": "r"
}
],
"blockIO": {
"blkioWeight": 10,
"blkioLeafWeight": 10,
"blkioWeightDevice": [
{
"major": 8,
"minor": 0,
"weight": 500,
"leafWeight": 300
},
{
"major": 8,
"minor": 16,
"weight": 500
}
],
"blkioThrottleReadBpsDevice": [
{
"major": 8,
"minor": 0,
"rate": 600
}
],
"blkioThrottleWriteIOPSDevice": [
{
"major": 8,
"minor": 16,
"rate": 300
}
]
}
},
"rootfsPropagation": "slave",
"seccomp": {
"defaultAction": "SCMP_ACT_ALLOW",
"architectures": [
"SCMP_ARCH_X86"
],
"syscalls": [
{
"name": "getcwd",
"action": "SCMP_ACT_ERRNO"
}
]
},
Expand All @@ -423,7 +589,25 @@ Here is a full example `config.json` for reference.
{
"type": "mount"
}
],
"maskedPaths": [
"/proc/kcore",
"/proc/latency_stats",
"/proc/timer_stats",
"/proc/sched_debug"
],
"readonlyPaths": [
"/proc/asound",
"/proc/bus",
"/proc/fs",
"/proc/irq",
"/proc/sys",
"/proc/sysrq-trigger"
]
},
"annotations": {
"key1": "value1",
"key2": "value2"
}
}
```
Expand Down
4 changes: 3 additions & 1 deletion schema/defs-linux.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@
"type": "string"
},
"FileType": {
"type": "integer"
"description": "Type of a block or special character device",
"type": "string",
"pattern": "^[cbup]$"
},
"Device": {
"properties": {
Expand Down
Loading

0 comments on commit 6734c7a

Please sign in to comment.