cri-o/vendor/github.com/opencontainers/runtime-spec/config-windows.md
Mrunal Patel 24df2538db Update runtime-spec to v1.0.0.rc5
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-04-12 19:15:53 -07:00

2.8 KiB

Windows-specific Container Configuration

This document describes the schema for the Windows-specific section of the container configuration. The Windows container specification uses APIs provided by the Windows Host Compute Service (HCS) to fulfill the spec.

Resources

You can configure a container's resource limits via the OPTIONAL resources field of the Windows configuration.

Memory

memory is an OPTIONAL configuration for the container's memory usage.

The following parameters can be specified:

  • limit (uint64, OPTIONAL) - sets limit of memory usage in bytes.

  • reservation (uint64, OPTIONAL) - sets the guaranteed minimum amount of memory for a container in bytes.

Example

    "windows": {
        "resources": {
            "memory": {
                "limit": 2097152,
                "reservation": 524288
            }
        }
    }

CPU

cpu is an OPTIONAL configuration for the container's CPU usage.

The following parameters can be specified:

  • count (uint64, OPTIONAL) - specifies the number of CPUs available to the container.

  • shares (uint16, OPTIONAL) - specifies the relative weight to other containers with CPU shares. The range is from 1 to 10000.

  • percent (uint, OPTIONAL) - specifies the percentage of available CPUs usable by the container.

Example

    "windows": {
        "resources": {
            "cpu": {
                "percent": 50
            }
        }
    }

Storage

storage is an OPTIONAL configuration for the container's storage usage.

The following parameters can be specified:

  • iops (uint64, OPTIONAL) - specifies the maximum IO operations per second for the system drive of the container.

  • bps (uint64, OPTIONAL) - specifies the maximum bytes per second for the system drive of the container.

  • sandboxSize (uint64, OPTIONAL) - specifies the minimum size of the system drive in bytes.

Example

    "windows": {
        "resources": {
            "storage": {
                "iops": 50
            }
        }
    }

Network

network is an OPTIONAL configuration for the container's network usage.

The following parameters can be specified:

  • egressBandwidth (uint64, OPTIONAL) - specified the maximum egress bandwidth in bytes per second for the container.

Example

    "windows": {
        "resources": {
            "network": {
                "egressBandwidth": 1048577
            }
        }
   }