185 lines
7.1 KiB
Go
185 lines
7.1 KiB
Go
package windowsoci
|
|
|
|
// This file contains the Windows spec for a container. At the time of
|
|
// writing, Windows does not have a spec defined in opencontainers/specs,
|
|
// hence this is an interim workaround. TODO Windows: FIXME @jhowardmsft
|
|
|
|
import "fmt"
|
|
|
|
// WindowsSpec is the full specification for Windows containers.
|
|
type WindowsSpec struct {
|
|
Spec
|
|
|
|
// Windows is platform specific configuration for Windows based containers.
|
|
Windows Windows `json:"windows"`
|
|
}
|
|
|
|
// Spec is the base configuration for the container. It specifies platform
|
|
// independent configuration. This information must be included when the
|
|
// bundle is packaged for distribution.
|
|
type Spec struct {
|
|
|
|
// Version is the version of the specification that is supported.
|
|
Version string `json:"ociVersion"`
|
|
// Platform is the host information for OS and Arch.
|
|
Platform Platform `json:"platform"`
|
|
// Process is the container's main process.
|
|
Process Process `json:"process"`
|
|
// Root is the root information for the container's filesystem.
|
|
Root Root `json:"root"`
|
|
// Hostname is the container's host name.
|
|
Hostname string `json:"hostname,omitempty"`
|
|
// Mounts profiles configuration for adding mounts to the container's filesystem.
|
|
Mounts []Mount `json:"mounts"`
|
|
}
|
|
|
|
// Windows contains platform specific configuration for Windows based containers.
|
|
type Windows struct {
|
|
// Resources contains information for handling resource constraints for the container
|
|
Resources *Resources `json:"resources,omitempty"`
|
|
// Networking contains the platform specific network settings for the container.
|
|
Networking *Networking `json:"networking,omitempty"`
|
|
// LayerFolder is the path to the current layer folder
|
|
LayerFolder string `json:"layer_folder,omitempty"`
|
|
// Layer paths of the parent layers
|
|
LayerPaths []string `json:"layer_paths,omitempty"`
|
|
// HvRuntime contains settings specific to Hyper-V containers, omitted if not using Hyper-V isolation
|
|
HvRuntime *HvRuntime `json:"hv_runtime,omitempty"`
|
|
}
|
|
|
|
// Process contains information to start a specific application inside the container.
|
|
type Process struct {
|
|
// Terminal indicates if stderr should NOT be attached for the container.
|
|
Terminal bool `json:"terminal"`
|
|
// ConsoleSize contains the initial h,w of the console size
|
|
InitialConsoleSize [2]int `json:"-"`
|
|
// User specifies user information for the process.
|
|
User User `json:"user"`
|
|
// Args specifies the binary and arguments for the application to execute.
|
|
Args []string `json:"args"`
|
|
// Env populates the process environment for the process.
|
|
Env []string `json:"env,omitempty"`
|
|
// Cwd is the current working directory for the process and must be
|
|
// relative to the container's root.
|
|
Cwd string `json:"cwd"`
|
|
}
|
|
|
|
// User specifies specific user (and group) information for the container process.
|
|
type User struct {
|
|
// UID is the user id.
|
|
UID uint32 `json:"uid" platform:"linux,solaris"`
|
|
// GID is the group id.
|
|
GID uint32 `json:"gid" platform:"linux,solaris"`
|
|
// AdditionalGids are additional group ids set for the container's process.
|
|
AdditionalGids []uint32 `json:"additionalGids,omitempty" platform:"linux,solaris"`
|
|
// Username is the user name.
|
|
Username string `json:"username,omitempty" platform:"windows"`
|
|
}
|
|
|
|
// Root contains information about the container's root filesystem on the host.
|
|
type Root struct {
|
|
// Path is the absolute path to the container's root filesystem.
|
|
Path string `json:"path"`
|
|
// Readonly makes the root filesystem for the container readonly before the process is executed.
|
|
Readonly bool `json:"readonly"`
|
|
}
|
|
|
|
// Platform specifies OS and arch information for the host system that the container
|
|
// is created for.
|
|
type Platform struct {
|
|
// OS is the operating system.
|
|
OS string `json:"os"`
|
|
// Arch is the architecture
|
|
Arch string `json:"arch"`
|
|
// OSVersion is the version of the operating system.
|
|
OSVersion string `json:"os.version,omitempty"`
|
|
}
|
|
|
|
// Mount specifies a mount for a container.
|
|
type Mount struct {
|
|
// Destination is the path where the mount will be placed relative to the container's root. The path and child directories MUST exist, a runtime MUST NOT create directories automatically to a mount point.
|
|
Destination string `json:"destination"`
|
|
// Type specifies the mount kind.
|
|
Type string `json:"type"`
|
|
// Source specifies the source path of the mount. In the case of bind mounts on
|
|
// Linux based systems this would be the file on the host.
|
|
Source string `json:"source"`
|
|
// Options are fstab style mount options.
|
|
Options []string `json:"options,omitempty"`
|
|
}
|
|
|
|
// HvRuntime contains settings specific to Hyper-V containers
|
|
type HvRuntime struct {
|
|
// ImagePath is the path to the Utility VM image for this container
|
|
ImagePath string `json:"image_path,omitempty"`
|
|
}
|
|
|
|
// Networking contains the platform specific network settings for the container
|
|
type Networking struct {
|
|
// List of endpoints to be attached to the container
|
|
EndpointList []string `json:"endpoints,omitempty"`
|
|
}
|
|
|
|
// Storage contains storage resource management settings
|
|
type Storage 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 indicates the size to expand the system drive to if it is currently smaller
|
|
SandboxSize *uint64 `json:"sandbox_size,omitempty"`
|
|
}
|
|
|
|
// Memory contains memory settings for the container
|
|
type Memory struct {
|
|
// Memory limit (in bytes).
|
|
Limit *int64 `json:"limit,omitempty"`
|
|
// Memory reservation (in bytes).
|
|
Reservation *uint64 `json:"reservation,omitempty"`
|
|
}
|
|
|
|
// CPU contains information for cpu resource management
|
|
type CPU struct {
|
|
// Number of CPUs available to the container. This is an appoximation for Windows Server Containers.
|
|
Count *uint64 `json:"count,omitempty"`
|
|
// CPU shares (relative weight (ratio) vs. 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 *int64 `json:"percent,omitempty"`
|
|
}
|
|
|
|
// Network contains network resource management information
|
|
type Network struct {
|
|
// Bandwidth is the maximum egress bandwidth in bytes per second
|
|
Bandwidth *uint64 `json:"bandwidth,omitempty"`
|
|
}
|
|
|
|
// Resources has container runtime resource constraints
|
|
// TODO Windows containerd. This structure needs ratifying with the old resources
|
|
// structure used on Windows and the latest OCI spec.
|
|
type Resources struct {
|
|
// Memory restriction configuration
|
|
Memory *Memory `json:"memory,omitempty"`
|
|
// CPU resource restriction configuration
|
|
CPU *CPU `json:"cpu,omitempty"`
|
|
// Storage restriction configuration
|
|
Storage *Storage `json:"storage,omitempty"`
|
|
// Network restriction configuration
|
|
Network *Network `json:"network,omitempty"`
|
|
}
|
|
|
|
const (
|
|
// VersionMajor is for an API incompatible changes
|
|
VersionMajor = 0
|
|
// VersionMinor is for functionality in a backwards-compatible manner
|
|
VersionMinor = 3
|
|
// VersionPatch is for backwards-compatible bug fixes
|
|
VersionPatch = 0
|
|
|
|
// VersionDev indicates development branch. Releases will be empty string.
|
|
VersionDev = ""
|
|
)
|
|
|
|
// Version is the specification version that the package types support.
|
|
var Version = fmt.Sprintf("%d.%d.%d%s (Windows)", VersionMajor, VersionMinor, VersionPatch, VersionDev)
|