Skip to content

Latest commit

 

History

History
344 lines (292 loc) · 11 KB

runtime-config-linux.md

File metadata and controls

344 lines (292 loc) · 11 KB

Namespaces

A namespace wraps a global system resource in an abstraction that makes it appear to the processes within the namespace that they have their own isolated instance of the global resource. Changes to the global resource are visible to other processes that are members of the namespace, but are invisible to other processes. For more information, see the man page.

Namespaces are specified in the spec as an array of entries. Each entry has a type field with possible values described below and an optional path element. 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.

    "namespaces": [
        {
            "type": "pid",
            "path": "/proc/1234/ns/pid"
        },
        {
            "type": "network",
            "path": "/var/run/netns/neta"
        },
        {
            "type": "mount"
        },
        {
            "type": "ipc"
        },
        {
            "type": "uts"
        },
        {
            "type": "user"
        }
    ]

Namespace types

  • pid processes inside the container will only be able to see other processes inside the same container.
  • network the container will have its own network stack.
  • mount the container will have an isolated mount table.
  • ipc processes inside the container will only be able to communicate to other processes inside the same container via system level IPC.
  • uts the container will be able to have its own hostname and domain name.
  • user the container will be able to remap user and group IDs from the host to local users and groups within the container.

Devices

Devices is an array specifying the list of devices to be created in the container. Next parameters can be specified:

  • type - type of device: c, b, u or p. More info in man mknod
  • path - full path to device inside container
  • major, minor - major, minor numbers for device. More info in man mknod. There is special value: -1, which means * for device cgroup setup.
  • permissions - cgroup permissions for device. A composition of r (read), w (write), and m (mknod).
  • fileMode - file mode for device file
  • uid - uid of device owner
  • gid - gid of device owner
   "devices": [
        {
            "path": "/dev/random",
            "type": "c",
            "major": 1,
            "minor": 8,
            "permissions": "rwm",
            "fileMode": 0666,
            "uid": 0,
            "gid": 0
        },
        {
            "path": "/dev/urandom",
            "type": "c",
            "major": 1,
            "minor": 9,
            "permissions": "rwm",
            "fileMode": 0666,
            "uid": 0,
            "gid": 0
        },
        {
            "path": "/dev/null",
            "type": "c",
            "major": 1,
            "minor": 3,
            "permissions": "rwm",
            "fileMode": 0666,
            "uid": 0,
            "gid": 0
        },
        {
            "path": "/dev/zero",
            "type": "c",
            "major": 1,
            "minor": 5,
            "permissions": "rwm",
            "fileMode": 0666,
            "uid": 0,
            "gid": 0
        },
        {
            "path": "/dev/tty",
            "type": "c",
            "major": 5,
            "minor": 0,
            "permissions": "rwm",
            "fileMode": 0666,
            "uid": 0,
            "gid": 0
        },
        {
            "path": "/dev/full",
            "type": "c",
            "major": 1,
            "minor": 7,
            "permissions": "rwm",
            "fileMode": 0666,
            "uid": 0,
            "gid": 0
        }
    ]

Control groups

Also known as cgroups, they are used to restrict resource usage for a container and handle device access. cgroups provide controls to restrict cpu, memory, IO, pids and network for the container. For more information, see the kernel cgroups documentation.

The path to the cgroups can be specified in the Spec via cgroupsPath. cgroupsPath is expected to be relative to the cgroups mount point. If not specified, cgroups will be created under '/'. Implementations of the Spec can choose to name cgroups in any manner. The Spec does not include naming schema for cgroups. The Spec does not support split hierarchy. The cgroups will be created if they don't exist.

   "cgroupsPath": "/myRuntime/myContainer"

cgroupsPath can be used to either control the cgroups hierarchy for containers or to run a new process in an existing container.

You can configure a container's cgroups via the resources field of the Linux configuration. Do not specify resources unless limits have to be updated. For example, to run a new process in an existing container without updating limits, resources need not be specified.

Disable out-of-memory killer

    "disableOOMKiller": false

Memory

    "memory": {
        "limit": 0,
        "reservation": 0,
        "swap": 0,
        "kernel": 0,
        "swappiness": -1
    }

CPU

    "cpu": {
        "shares": 0,
        "quota": 0,
        "period": 0,
        "realtimeRuntime": 0,
        "realtimePeriod": 0,
        "cpus": "",
        "mems": ""
    }

Block IO Controller

blockIO represents the cgroup subsystem blkio which implements the block io controller. For more information, see the kernel cgroups documentation about blkio.

The following parameters can be specified to setup the block io controller:

  • blkioWeight (uint16, optional) - specifies per-cgroup weight. This is default weight of the group on all devices until and unless overridden by per-device rules. The range is from 10 to 1000.

  • blkioLeafWeight (uint16, optional) - equivalents of blkioWeight for the purpose of deciding how much weight tasks in the given cgroup has while competing with the cgroup's child cgroups. The range is from 10 to 1000.

  • blkioWeightDevice (array, optional) - specifies the list of devices which will be bandwidth rate limited. The following parameters can be specified per-device:

    • major, minor (int64, required) - major, minor numbers for device. More info in man mknod.
    • weight (uint16, optional) - bandwidth rate for the device, range is from 10 to 1000.
    • leafWeight (uint16, optional) - bandwidth rate for the device while competing with the cgroup's child cgroups, range is from 10 to 1000, cfq scheduler only.

    You must specify at least one of weight or leafWeight in a given entry, and can specify both.

  • blkioThrottleReadBpsDevice, blkioThrottleWriteBpsDevice, blkioThrottleReadIOPSDevice, blkioThrottleWriteIOPSDevice (array, optional) - specify the list of devices which will be IO rate limited. The following parameters can be specified per-device:

    • major, minor (int64, required) - major, minor numbers for device. More info in man mknod.
    • rate (uint64, required) - IO rate limit for the device
Example
    "blockIO": {
        "blkioWeight": 0,
        "blkioLeafWeight": 0,
        "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
            }
        ]
    }

Huge page limits

   "hugepageLimits": [
        {
            "pageSize": "2MB",
            "limit": 9223372036854771712
        }
   ]

Network

   "network": {
        "classId": "ClassId",
        "priorities": [
            {
                "name": "eth0",
                "priority": 500
            },
            {
                "name": "eth1",
                "priority": 1000
            }
        ]
   }

Sysctl

sysctl allows kernel parameters to be modified at runtime for the container. For more information, see the man page

   "sysctl": {
        "net.ipv4.ip_forward": "1",
        "net.core.somaxconn": "256"
   }

Rlimits

rlimits allow setting resource limits. type is a string with a value from those defined in the man page. The kernel enforces the soft limit for a resource while the hard limit acts as a ceiling for that value that could be set by an unprivileged process.

   "rlimits": [
        {
            "type": "RLIMIT_NPROC",
            "soft": 1024,
            "hard": 102400
        }
   ]

SELinux process label

SELinux process label specifies the label with which the processes in a container are run. For more information about SELinux, see Selinux documentation

   "selinuxProcessLabel": "system_u:system_r:svirt_lxc_net_t:s0:c124,c675"

Apparmor profile

Apparmor profile specifies the name of the apparmor profile that will be used for the container. For more information about Apparmor, see Apparmor documentation

   "apparmorProfile": "acme_secure_profile"

seccomp

Seccomp provides application sandboxing mechanism in the Linux kernel. Seccomp configuration allows one to configure actions to take for matched syscalls and furthermore also allows matching on values passed as arguments to syscalls. For more information about Seccomp, see Seccomp kernel documentation The actions and operators are strings that match the definitions in seccomp.h from libseccomp and are translated to corresponding values.

   "seccomp": {
       "defaultAction": "SCMP_ACT_ALLOW",
       "syscalls": [
           {
               "name": "getcwd",
               "action": "SCMP_ACT_ERRNO"
           }
       ]
   }

Rootfs Mount Propagation

rootfsPropagation sets the rootfs's mount propagation. Its value is either slave, private, or shared. The kernel doc has more information about mount propagation.

    "rootfsPropagation": "slave",