This configuration file contains metadata necessary to implement standard operations against the container. This includes the process to run, environment variables to inject, sandboxing features to use, etc.
The canonical schema is defined in this document, but there is a JSON Schema in schema/config-schema.json and Go bindings in specs-go/config.go.
Platform-specific configuration schema are defined in the platform-specific documents linked below.
For properties that are only defined for some platforms, the Go property has a platform tag listing those protocols (e.g. platform:"linux,solaris").
Below is a detailed description of each field defined in the configuration format and valid values are specified. Platform-specific fields are identified as such. For all platform-specific configuration values, the scope defined below in the Platform-specific configuration section applies.
ociVersion(string, REQUIRED) MUST be in SemVer v2.0.0 format and specifies the version of the Open Container Runtime Specification with which the bundle complies. The Open Container Runtime Specification follows semantic versioning and retains forward and backward compatibility within major versions. For example, if a configuration is compliant with version 1.1 of this specification, it is compatible with all runtimes that support any 1.1 or later release of this specification, but is not compatible with a runtime that supports 1.0 and not 1.1.
"ociVersion": "0.1.0"root (object, OPTIONAL) specifies the container's root filesystem.
On Windows, for Windows Server Containers, this field is REQUIRED.
For Hyper-V Containers, this field MUST NOT be set.
On all other platforms, this field is REQUIRED.
-
path(string, REQUIRED) Specifies the path to the root filesystem for the container.-
On Windows,
pathMUST be a volume GUID path. -
On POSIX platforms,
pathis either an absolute path or a relative path to the bundle. For example, with a bundle at/to/bundleand a root filesystem at/to/bundle/rootfs, thepathvalue can be either/to/bundle/rootfsorrootfs. The value SHOULD be the conventionalrootfs.
A directory MUST exist at the path declared by the field.
-
-
readonly(bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false.- On Windows, this field MUST be omitted or false.
"root": {
"path": "rootfs",
"readonly": true
}"root": {
"path": "\\\\?\\Volume{ec84d99e-3f02-11e7-ac6c-00155d7682cf}\\"
}mounts (array of objects, OPTIONAL) specifies additional mounts beyond root.
The runtime MUST mount entries in the listed order.
For Linux, the parameters are as documented in mount(2) system call man page.
For Solaris, the mount entry corresponds to the 'fs' resource in the zonecfg(1M) man page.
destination(string, REQUIRED) Destination of mount point: path inside container. This value MUST be an absolute path.- Windows: one mount destination MUST NOT be nested within another mount (e.g., c:\foo and c:\foo\bar).
- Solaris: corresponds to "dir" of the fs resource in zonecfg(1M).
source(string, OPTIONAL) A device name, but can also be a directory name or a dummy. Path values are either absolute or relative to the bundle.- Windows: a local directory on the filesystem of the container host. UNC paths and mapped drives are not supported.
- Solaris: corresponds to "special" of the fs resource in zonecfg(1M).
options(array of strings, OPTIONAL) Mount options of the filesystem to be used.- Linux: supported options are listed in the mount(8) man page. Note both filesystem-independent and filesystem-specific options are listed.
- Solaris: corresponds to "options" of the fs resource in zonecfg(1M).
- Windows: runtimes MUST support
ro, mounting the filesystem read-only whenrois given.
"mounts": [
{
"destination": "C:\\folder-inside-container",
"source": "C:\\folder-on-host",
"options": ["ro"]
}
]For POSIX platforms the mounts structure has the following fields:
type(string, OPTIONAL) The type of the filesystem to be mounted.- Linux: filesystem types supported by the kernel as listed in /proc/filesystems (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660").
- Solaris: corresponds to "type" of the fs resource in zonecfg(1M).
"mounts": [
{
"destination": "/tmp",
"type": "tmpfs",
"source": "tmpfs",
"options": ["nosuid","strictatime","mode=755","size=65536k"]
},
{
"destination": "/data",
"type": "bind",
"source": "/volumes/testing",
"options": ["rbind","rw"]
}
]"mounts": [
{
"destination": "/opt/local",
"type": "lofs",
"source": "/usr/local",
"options": ["ro","nodevices"]
},
{
"destination": "/opt/sfw",
"type": "lofs",
"source": "/opt/sfw"
}
]process (object, OPTIONAL) specifies the container process.
This property is REQUIRED when start is called.
terminal(bool, OPTIONAL) specifies whether a terminal is attached to the process, defaults to false. As an example, if set to true on Linux a pseudoterminal pair is allocated for the process and the pseudoterminal slave is duplicated on the process's standard streams.consoleSize(object, OPTIONAL) specifies the console size in characters of the terminal. Runtimes MUST ignoreconsoleSizeifterminalisfalseor unset.height(uint, REQUIRED)width(uint, REQUIRED)
cwd(string, REQUIRED) is the working directory that will be set for the executable. This value MUST be an absolute path.env(array of strings, OPTIONAL) with the same semantics as IEEE Std 1003.1-2008'senviron.args(array of strings, REQUIRED) with similar semantics to IEEE Std 1003.1-2008execvp's argv. This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics asexecvp's file.
For systems that support POSIX rlimits (for example Linux and Solaris), the process object supports the following process-specific properties:
-
rlimits(array of objects, OPTIONAL) allows setting resource limits for the process. Each entry has the following structure:-
type(string, REQUIRED) the platform resource being limited.- Linux: valid values are defined in the
getrlimit(2)man page, such asRLIMIT_MSGQUEUE. - Solaris: valid values are defined in the
getrlimit(3)man page, such asRLIMIT_CORE.
The runtime MUST generate an error for any values which cannot be mapped to a relevant kernel interface For each entry in
rlimits, agetrlimit(3)ontypeMUST succeed. For the following properties,rlimrefers to the status returned by thegetrlimit(3)call. - Linux: valid values are defined in the
-
soft(uint64, REQUIRED) the value of the limit enforced for the corresponding resource.rlim.rlim_curMUST match the configured value. -
hard(uint64, REQUIRED) the ceiling for the soft limit that could be set by an unprivileged process.rlim.rlim_maxMUST match the configured value. Only a privileged process (e.g. one with theCAP_SYS_RESOURCEcapability) can raise a hard limit.
If
rlimitscontains duplicated entries with sametype, the runtime MUST generate an error. -
For Linux-based systems, the process object supports the following process-specific properties.
-
apparmorProfile(string, OPTIONAL) specifies the name of the AppArmor profile for the process. For more information about AppArmor, see AppArmor documentation. -
capabilities(object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process. Valid values are defined in the capabilities(7) man page, such asCAP_CHOWN. Any value which cannot be mapped to a relevant kernel interface MUST cause an error.capabilitiescontains the following properties:effective(array of strings, OPTIONAL) theeffectivefield is an array of effective capabilities that are kept for the process.bounding(array of strings, OPTIONAL) theboundingfield is an array of bounding capabilities that are kept for the process.inheritable(array of strings, OPTIONAL) theinheritablefield is an array of inheritable capabilities that are kept for the process.permitted(array of strings, OPTIONAL) thepermittedfield is an array of permitted capabilities that are kept for the process.ambient(array of strings, OPTIONAL) theambientfield is an array of ambient capabilities that are kept for the process.
-
noNewPrivileges(bool, OPTIONAL) settingnoNewPrivilegesto true prevents the process from gaining additional privileges. As an example, theno_new_privsarticle in the kernel documentation has information on how this is achieved using aprctlsystem call on Linux. -
oomScoreAdj(int, OPTIONAL) adjusts the oom-killer score in[pid]/oom_score_adjfor the process's[pid]in a [proc pseudo-filesystem][procfs]. IfoomScoreAdjis set, the runtime MUST setoom_score_adjto the given value. IfoomScoreAdjis not set, the runtime MUST NOT change the value ofoom_score_adj.This is a per-process setting, where as
disableOOMKilleris scoped for a memory cgroup. For more information on how these two settings work together, see the memory cgroup documentation section 10. OOM Contol. -
selinuxLabel(string, OPTIONAL) specifies the SELinux label for the process. For more information about SELinux, see SELinux documentation.
The user for the process is a platform-specific structure that allows specific control over which user the process runs as.
For POSIX platforms the user structure has the following fields:
uid(int, REQUIRED) specifies the user ID in the container namespace.gid(int, REQUIRED) specifies the group ID in the container namespace.additionalGids(array of ints, OPTIONAL) specifies additional group IDs in the container namespace to be added to the process.
Note: symbolic name for uid and gid, such as uname and gname respectively, are left to upper levels to derive (i.e. /etc/passwd parsing, NSS, etc)
"process": {
"terminal": true,
"consoleSize": {
"height": 25,
"width": 80
},
"user": {
"uid": 1,
"gid": 1,
"additionalGids": [5, 6]
},
"env": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
"TERM=xterm"
],
"cwd": "/root",
"args": [
"sh"
],
"apparmorProfile": "acme_secure_profile",
"selinuxLabel": "system_u:system_r:svirt_lxc_net_t:s0:c124,c675",
"noNewPrivileges": true,
"capabilities": {
"bounding": [
"CAP_AUDIT_WRITE",
"CAP_KILL",
"CAP_NET_BIND_SERVICE"
],
"permitted": [
"CAP_AUDIT_WRITE",
"CAP_KILL",
"CAP_NET_BIND_SERVICE"
],
"inheritable": [
"CAP_AUDIT_WRITE",
"CAP_KILL",
"CAP_NET_BIND_SERVICE"
],
"effective": [
"CAP_AUDIT_WRITE",
"CAP_KILL"
],
"ambient": [
"CAP_NET_BIND_SERVICE"
]
},
"rlimits": [
{
"type": "RLIMIT_NOFILE",
"hard": 1024,
"soft": 1024
}
]
}"process": {
"terminal": true,
"consoleSize": {
"height": 25,
"width": 80
},
"user": {
"uid": 1,
"gid": 1,
"additionalGids": [2, 8]
},
"env": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
"TERM=xterm"
],
"cwd": "/root",
"args": [
"/usr/bin/bash"
]
}For Windows based systems the user structure has the following fields:
username(string, OPTIONAL) specifies the user name for the process.
"process": {
"terminal": true,
"user": {
"username": "containeradministrator"
},
"env": [
"VARIABLE=1"
],
"cwd": "c:\\foo",
"args": [
"someapp.exe",
]
}hostname(string, OPTIONAL) specifies the container's hostname as seen by processes running inside the container. On Linux, for example, this will change the hostname in the container UTS namespace. Depending on your namespace configuration, the container UTS namespace may be the runtime UTS namespace.
"hostname": "mrsdalloway"linux(object, OPTIONAL) Linux-specific configuration. This MAY be set if the target platform of this spec islinux.windows(object, OPTIONAL) Windows-specific configuration. This MUST be set if the target platform of this spec iswindows.solaris(object, OPTIONAL) Solaris-specific configuration. This MAY be set if the target platform of this spec issolaris.
{
"linux": {
"namespaces": [
{
"type": "pid"
}
]
}
}For POSIX platforms, the configuration structure supports hooks for configuring custom actions related to the lifecycle of the container.
hooks(object, OPTIONAL) MAY contain any of the following properties:prestart(array of objects, OPTIONAL) is an array of pre-start hooks. Entries in the array contain the following properties:path(string, REQUIRED) with similar semantics to [IEEE Std 1003.1-2008execv's path][ieee-1003.1-2008-functions-exec]. This specification extends the IEEE standard in thatpathMUST be absolute.args(array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2008execv's argv][ieee-1003.1-2008-functions-exec].env(array of strings, OPTIONAL) with the same semantics as IEEE Std 1003.1-2008'senviron.timeout(int, OPTIONAL) is the number of seconds before aborting the hook. If set,timeoutMUST be greater than zero.
poststart(array of objects, OPTIONAL) is an array of post-start hooks. Entries in the array have the same schema as pre-start entries.poststop(array of objects, OPTIONAL) is an array of post-stop hooks. Entries in the array have the same schema as pre-start entries.
Hooks allow users to specify programs to run before or after various lifecycle events. Hooks MUST be called in the listed order. The state of the container MUST be passed to hooks over stdin so that they may do work appropriate to the current state of the container.
The pre-start hooks MUST be called after the start operation is called but before the user-specified program command is executed.
On Linux, for example, they are called after the container namespaces are created, so they provide an opportunity to customize the container (e.g. the network namespace could be specified in this hook).
The post-start hooks MUST be called after the user-specified process is executed but before the start operation returns.
For example, this hook can notify the user that the container process is spawned.
The post-stop hooks MUST be called after the container is deleted but before the delete operation returns.
Cleanup or debugging functions are examples of such a hook.
"hooks": {
"prestart": [
{
"path": "/usr/bin/fix-mounts",
"args": ["fix-mounts", "arg1", "arg2"],
"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"]
}
]
}annotations (object, OPTIONAL) contains arbitrary metadata for the container.
This information MAY be structured or unstructured.
Annotations MUST be a key-value map.
If there are no annotations then this property MAY either be absent or an empty map.
Keys MUST be strings.
Keys MUST NOT be an empty string.
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.
Values MUST be strings.
Values MAY be an empty string.
"annotations": {
"com.example.gpu-cores": "2"
}Runtimes that are reading or processing this configuration file MUST NOT generate an error if they encounter an unknown property. Instead they MUST ignore unknown properties.
Runtimes that are reading or processing this configuration file MUST generate an error when invalid or unsupported values are encountered. Unless support for a valid value is explicitly required, runtimes MAY choose which subset of the valid values it will support.
Here is a full example config.json for reference.
{
"ociVersion": "0.5.0-dev",
"process": {
"terminal": true,
"user": {
"uid": 1,
"gid": 1,
"additionalGids": [
5,
6
]
},
"args": [
"sh"
],
"env": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
"TERM=xterm"
],
"cwd": "/",
"capabilities": {
"bounding": [
"CAP_AUDIT_WRITE",
"CAP_KILL",
"CAP_NET_BIND_SERVICE"
],
"permitted": [
"CAP_AUDIT_WRITE",
"CAP_KILL",
"CAP_NET_BIND_SERVICE"
],
"inheritable": [
"CAP_AUDIT_WRITE",
"CAP_KILL",
"CAP_NET_BIND_SERVICE"
],
"effective": [
"CAP_AUDIT_WRITE",
"CAP_KILL"
],
"ambient": [
"CAP_NET_BIND_SERVICE"
]
},
"rlimits": [
{
"type": "RLIMIT_CORE",
"hard": 1024,
"soft": 1024
},
{
"type": "RLIMIT_NOFILE",
"hard": 1024,
"soft": 1024
}
],
"apparmorProfile": "acme_secure_profile",
"oomScoreAdj": 100,
"selinuxLabel": "system_u:system_r:svirt_lxc_net_t:s0:c124,c675",
"noNewPrivileges": true
},
"root": {
"path": "rootfs",
"readonly": true
},
"hostname": "slartibartfast",
"mounts": [
{
"destination": "/proc",
"type": "proc",
"source": "proc"
},
{
"destination": "/dev",
"type": "tmpfs",
"source": "tmpfs",
"options": [
"nosuid",
"strictatime",
"mode=755",
"size=65536k"
]
},
{
"destination": "/dev/pts",
"type": "devpts",
"source": "devpts",
"options": [
"nosuid",
"noexec",
"newinstance",
"ptmxmode=0666",
"mode=0620",
"gid=5"
]
},
{
"destination": "/dev/shm",
"type": "tmpfs",
"source": "shm",
"options": [
"nosuid",
"noexec",
"nodev",
"mode=1777",
"size=65536k"
]
},
{
"destination": "/dev/mqueue",
"type": "mqueue",
"source": "mqueue",
"options": [
"nosuid",
"noexec",
"nodev"
]
},
{
"destination": "/sys",
"type": "sysfs",
"source": "sysfs",
"options": [
"nosuid",
"noexec",
"nodev"
]
},
{
"destination": "/sys/fs/cgroup",
"type": "cgroup",
"source": "cgroup",
"options": [
"nosuid",
"noexec",
"nodev",
"relatime",
"ro"
]
}
],
"hooks": {
"prestart": [
{
"path": "/usr/bin/fix-mounts",
"args": [
"fix-mounts",
"arg1",
"arg2"
],
"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
}
],
"uidMappings": [
{
"hostID": 1000,
"containerID": 0,
"size": 32000
}
],
"gidMappings": [
{
"hostID": 1000,
"containerID": 0,
"size": 32000
}
],
"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
}
],
"memory": {
"limit": 536870912,
"reservation": 536870912,
"swap": 536870912,
"kernel": -1,
"kernelTCP": -1,
"swappiness": 0,
"disableOOMKiller": false
},
"cpu": {
"shares": 1024,
"quota": 1000000,
"period": 500000,
"realtimeRuntime": 950000,
"realtimePeriod": 1000000,
"cpus": "2-3",
"mems": "0-7"
},
"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": {
"weight": 10,
"leafWeight": 10,
"weightDevice": [
{
"major": 8,
"minor": 0,
"weight": 500,
"leafWeight": 300
},
{
"major": 8,
"minor": 16,
"weight": 500
}
],
"throttleReadBpsDevice": [
{
"major": 8,
"minor": 0,
"rate": 600
}
],
"throttleWriteIOPSDevice": [
{
"major": 8,
"minor": 16,
"rate": 300
}
]
}
},
"rootfsPropagation": "slave",
"seccomp": {
"defaultAction": "SCMP_ACT_ALLOW",
"architectures": [
"SCMP_ARCH_X86",
"SCMP_ARCH_X32"
],
"syscalls": [
{
"names": [
"getcwd",
"chmod"
],
"action": "SCMP_ACT_ERRNO"
}
]
},
"namespaces": [
{
"type": "pid"
},
{
"type": "network"
},
{
"type": "ipc"
},
{
"type": "uts"
},
{
"type": "mount"
},
{
"type": "user"
},
{
"type": "cgroup"
}
],
"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"
],
"mountLabel": "system_u:object_r:svirt_sandbox_file_t:s0:c715,c811"
},
"annotations": {
"com.example.key1": "value1",
"com.example.key2": "value2"
}
}