Add support for Windows-based containers

Signed-off-by: John Howard <[email protected]>

Author: John Howard

README.md

@@ -20,6 +20,7 @@ Table of Contents
   - [General Configuration](config.md)
   - [Linux-specific Configuration](config-linux.md)
   - [Solaris-specific Configuration](config-solaris.md)
+  - [Windows-specific Configuration](config-windows.md)
 - [Glossary](glossary.md)
 
 In the specifications in the above table of contents, the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
@@ -30,6 +31,7 @@ An implementation is compliant for a given CPU architecture if it satisfies all
 Protocols defined by this specification are:
 * Linux containers: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
 * Solaris containers: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
+* Windows containers: [runtime.md](runtime.md), [config.md](config.md), and [config-windows.md](config-windows.md).
 
 # Use Cases
 

config-windows.md

@@ -0,0 +1,83 @@
+# Windows-specific Container Configuration
+
+This document describes the schema for the [Windows-specific section](config.md#platform-specific-configuration) of the [container configuration](config.md).
+The Windows container specification uses APIs provided by the Windows Host Compute Service (HCS) to fulfill the spec.
+
+You can configure a container's resource limits via the `resources` field of the Windows configuration.
+Do not specify `resources` unless required.
+
+
+#### 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 soft limit of memory usage in bytes
+
+###### Example
+
+```json
+    "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`** *(uint64, 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
+
+```json
+    "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 Iops 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 size to expand the system drive of the container to if it is currently smaller.
+
+###### Example
+
+```json
+    "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
+
+```json
+   "network": {
+        "egressBandwidth": 1048577
+   }
+```

config.md

@@ -256,6 +256,8 @@ For Windows based systems the user structure has the following fields:
   This SHOULD only be set if **`platform.os`** is `linux`.
 * **`solaris`** (object, optional) [Solaris-specific configuration](config-solaris.md).
   This SHOULD only be set if **`platform.os`** is `solaris`.
+* **`windows`** (object, optional) [Windows-specific configuration](config-windows.md).
+  This SHOULD only be set if **`platform.os`** is `windows`.
 
 ### Example (Linux)
 

specs-go/config.go

@@ -25,6 +25,8 @@ type Spec struct {
 	Linux *Linux `json:"linux,omitempty" platform:"linux"`
 	// Solaris is platform specific configuration for Solaris containers.
 	Solaris *Solaris `json:"solaris,omitempty" platform:"solaris"`
+	// Windows is platform specific configuration for Windows based containers, including Hyper-V containers.
+	Windows *Windows `json:"windows,omitempty" platform:"windows"`
 }
 
 // Process contains information to start a specific application inside the container.
@@ -406,6 +408,58 @@ type Anet struct {
 	Macaddress string `json:"macAddress,omitempty"`
 }
 
+// Windows defines the runtime configuration for Windows based containers, including Hyper-V containers.
+type Windows struct {
+	// Resources contains information for handling resource constraints for the container.
+	Resources *WindowsResources `json:"resources,omitempty"`
+}
+
+// WindowsResources has container runtime resource constraints for containers running on Windows.
+type WindowsResources struct {
+	// Memory restriction configuration.
+	Memory *WindowsMemoryResources `json:"memory,omitempty"`
+	// CPU resource restriction configuration.
+	CPU *WindowsCPUResources `json:"cpu,omitempty"`
+	// Storage restriction configuration.
+	Storage *WindowsStorageResources `json:"storage,omitempty"`
+	// Network restriction configuration.
+	Network *WindowsNetworkResources `json:"network,omitempty"`
+}
+
+// WindowsMemoryResources contains memory resource management settings.
+type WindowsMemoryResources struct {
+	// Memory limit in bytes.
+	Limit *uint64 `json:"limit,omitempty"`
+	// Memory reservation in bytes.
+	Reservation *uint64 `json:"reservation,omitempty"`
+}
+
+// WindowsCPUResources contains CPU resource management settings.
+type WindowsCPUResources struct {
+	// Number of CPUs available to the container.
+	Count *uint64 `json:"count,omitempty"`
+	// CPU shares (relative weight to other containers with cpu shares). Range is from 1 to 10000.
+	Shares *uint64 `json:"shares,omitempty"`
+	// Percent of available CPUs usable by the container.
+	Percent *uint `json:"percent,omitempty"`
+}
+
+// WindowsStorageResources contains storage resource management settings.
+type WindowsStorageResources struct {
+	// Specifies maximum Iops for the system drive.
+	Iops *uint64 `json:"iops,omitempty"`
+	// Specifies maximum bytes per second for the system drive.
+	Bps *uint64 `json:"bps,omitempty"`
+	// Sandbox size specifies the minimum size of the system drive in bytes.
+	SandboxSize *uint64 `json:"sandboxSize,omitempty"`
+}
+
+// WindowsNetworkResources contains network resource management settings.
+type WindowsNetworkResources struct {
+	// EgressBandwidth is the maximum egress bandwidth in bytes per second.
+	EgressBandwidth *uint64 `json:"egressBandwidth,omitempty"`
+}
+
 // Arch used for additional architectures
 type Arch string