Skip to content

Instantly share code, notes, and snippets.

@vbatts

vbatts/godoc.txt

Created September 14, 2015 17:29
Show Gist options
  • Save vbatts/6f4893578c4b139d7fb6 to your computer and use it in GitHub Desktop.
Save vbatts/6f4893578c4b139d7fb6 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
godoc.txt
/home/vbatts/opt/bin/godoc
PACKAGE DOCUMENTATION
package oci
import "."
Package oci is a generated protocol buffer package.
package oci.config.bundle;
It is generated from these files:
config.proto
It has these top-level messages:
Spec
LinuxSpec
LinuxConfig
Platform
Process
User
Root
MountPoint
Package oci is a generated protocol buffer package.
It is generated from these files:
config_linux.proto
It has these top-level messages:
Package oci is a generated protocol buffer package.
package oci.config.runtime;
It is generated from these files:
runtime_config.proto
It has these top-level messages:
RuntimeSpec
LinuxRuntimeSpec
MountFieldEntry
Mount
Hook
Hooks
Package oci is a generated protocol buffer package.
It is generated from these files:
runtime_config_linux.proto
It has these top-level messages:
DefaultState
LinuxRuntime
IDMapping
Rlimit
StringStringEntry
Resources
Memory
CPU
Pids
BlockIO
HugepageLimit
Network
InterfacePriority
Namespace
Device
Seccomp
Syscall
Arg
CONSTANTS
const Default_DefaultState_Directory string = "/run/opencontainer/containers"
VARIABLES
var E_AdditionalGids = &proto.ExtensionDesc{
ExtendedType: (*oci1.User)(nil),
ExtensionType: ([]int32)(nil),
Field: 103,
Name: "oci.additional_gids",
Tag: "varint,103,rep,name=additional_gids",
}
var E_Gid = &proto.ExtensionDesc{
ExtendedType: (*oci1.User)(nil),
ExtensionType: (*int32)(nil),
Field: 102,
Name: "oci.gid",
Tag: "varint,102,opt,name=gid",
}
var E_Uid = &proto.ExtensionDesc{
ExtendedType: (*oci1.User)(nil),
ExtensionType: (*int32)(nil),
Field: 101,
Name: "oci.uid",
Tag: "varint,101,opt,name=uid",
}
var PlatformType_name = map[int32]string{
0: "UNKNOWN",
1: "LINUX",
}
var PlatformType_value = map[string]int32{
"UNKNOWN": 0,
"LINUX": 1,
}
TYPES
type Arg struct {
Index *uint32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
Value *uint64 `protobuf:"varint,2,opt,name=value" json:"value,omitempty"`
ValueTwo *uint64 `protobuf:"varint,3,opt,name=value_two" json:"value_two,omitempty"`
// Op is the operator string
Op *string `protobuf:"bytes,4,opt,name=op" json:"op,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Arg used for matching specific syscall arguments in Seccomp
func (m *Arg) GetIndex() uint32
func (m *Arg) GetOp() string
func (m *Arg) GetValue() uint64
func (m *Arg) GetValueTwo() uint64
func (*Arg) ProtoMessage()
func (m *Arg) Reset()
func (m *Arg) String() string
type BlockIO struct {
// Specifies per cgroup weight, range is from 10 to 1000
Weight *int64 `protobuf:"varint,1,opt,name=weight" json:"weight,omitempty"`
// Weight per cgroup per device, can override BlkioWeight
WeightDevice *string `protobuf:"bytes,2,opt,name=weight_device" json:"weight_device,omitempty"`
// IO read rate limit per cgroup per device, bytes per second
ThrottleReadBpsDevice *string `protobuf:"bytes,3,opt,name=throttle_read_bps_device" json:"throttle_read_bps_device,omitempty"`
// IO write rate limit per cgroup per divice, bytes per second
ThrottleWriteBpsDevice *string `protobuf:"bytes,4,opt,name=throttle_write_bps_device" json:"throttle_write_bps_device,omitempty"`
// IO read rate limit per cgroup per device, IO per second
ThrottleReadIopsDevice *string `protobuf:"bytes,5,opt,name=throttle_read_iops_device" json:"throttle_read_iops_device,omitempty"`
// IO write rate limit per cgroup per device, IO per second
ThrottleWriteIopsDevice *string `protobuf:"bytes,6,opt,name=throttle_write_iops_device" json:"throttle_write_iops_device,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
BlockIO for Linux cgroup 'blockio' resource management
func (m *BlockIO) GetThrottleReadBpsDevice() string
func (m *BlockIO) GetThrottleReadIopsDevice() string
func (m *BlockIO) GetThrottleWriteBpsDevice() string
func (m *BlockIO) GetThrottleWriteIopsDevice() string
func (m *BlockIO) GetWeight() int64
func (m *BlockIO) GetWeightDevice() string
func (*BlockIO) ProtoMessage()
func (m *BlockIO) Reset()
func (m *BlockIO) String() string
type CPU struct {
// CPU shares (relative weight vs. other cgroups with cpu shares)
Shares *int64 `protobuf:"varint,1,opt,name=shares" json:"shares,omitempty"`
// CPU hardcap limit (in usecs). Allowed cpu time in a given period
Quota *int64 `protobuf:"varint,2,opt,name=quota" json:"quota,omitempty"`
// CPU period to be used for hardcapping (in usecs). 0 to use system default
Period *int64 `protobuf:"varint,3,opt,name=period" json:"period,omitempty"`
// How many time CPU will use in realtime scheduling (in usecs)
RealtimeRuntime *int64 `protobuf:"varint,4,opt,name=realtime_runtime" json:"realtime_runtime,omitempty"`
// CPU period to be used for realtime scheduling (in usecs)
RealtimePeriod *int64 `protobuf:"varint,5,opt,name=realtime_period" json:"realtime_period,omitempty"`
// CPU to use within the cpuset
Cpus *string `protobuf:"bytes,6,opt,name=cpus" json:"cpus,omitempty"`
// MEM to use within the cpuset
Mems *string `protobuf:"bytes,7,opt,name=mems" json:"mems,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
CPU for Linux cgroup 'cpu' resource management
func (m *CPU) GetCpus() string
func (m *CPU) GetMems() string
func (m *CPU) GetPeriod() int64
func (m *CPU) GetQuota() int64
func (m *CPU) GetRealtimePeriod() int64
func (m *CPU) GetRealtimeRuntime() int64
func (m *CPU) GetShares() int64
func (*CPU) ProtoMessage()
func (m *CPU) Reset()
func (m *CPU) String() string
type DefaultState struct {
// TODO(vbatts) not as elegant in some ways, but there is not a concept of const here
Directory *string `protobuf:"bytes,1,opt,name=directory,def=/run/opencontainer/containers" json:"directory,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
LinuxStateDirectory holds the container's state information
func (m *DefaultState) GetDirectory() string
func (*DefaultState) ProtoMessage()
func (m *DefaultState) Reset()
func (m *DefaultState) String() string
type Device struct {
// Path to the device.
Path *string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
// Device type, block, char, etc.
// TODO(vbatts) ensure int32 is fine here, instead of golang's rune
Type *int32 `protobuf:"varint,2,opt,name=type" json:"type,omitempty"`
// Major is the device's major number.
Major *int64 `protobuf:"varint,3,opt,name=major" json:"major,omitempty"`
// Minor is the device's minor number.
Minor *int64 `protobuf:"varint,4,opt,name=minor" json:"minor,omitempty"`
// Cgroup permissions format, rwm.
Permissions *string `protobuf:"bytes,5,opt,name=permissions" json:"permissions,omitempty"`
// FileMode permission bits for the device.
// TODO(vbatts) os.FileMode is an octal uint32
FileMode *uint32 `protobuf:"varint,6,opt,name=file_mode" json:"file_mode,omitempty"`
// Uid of the device.
Uid *uint32 `protobuf:"varint,7,opt,name=uid" json:"uid,omitempty"`
// Gid of the device.
Gid *uint32 `protobuf:"varint,8,opt,name=gid" json:"gid,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Device represents the information on a Linux special device file
func (m *Device) GetFileMode() uint32
func (m *Device) GetGid() uint32
func (m *Device) GetMajor() int64
func (m *Device) GetMinor() int64
func (m *Device) GetPath() string
func (m *Device) GetPermissions() string
func (m *Device) GetType() int32
func (m *Device) GetUid() uint32
func (*Device) ProtoMessage()
func (m *Device) Reset()
func (m *Device) String() string
type Hook struct {
Path *string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
Args []string `protobuf:"bytes,2,rep,name=args" json:"args,omitempty"`
Env []string `protobuf:"bytes,3,rep,name=env" json:"env,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Hook specifies a command that is run at a particular event in the
lifecycle of a container
func (m *Hook) GetArgs() []string
func (m *Hook) GetEnv() []string
func (m *Hook) GetPath() string
func (*Hook) ProtoMessage()
func (m *Hook) Reset()
func (m *Hook) String() string
type Hooks struct {
// Prestart is a list of hooks to be run before the container process is executed.
// On Linux, they are run after the container namespaces are created.
Prestart []*Hook `protobuf:"bytes,1,rep,name=prestart" json:"prestart,omitempty"`
// Poststop is a list of hooks to be run after the container process exits.
Poststop []*Hook `protobuf:"bytes,2,rep,name=poststop" json:"poststop,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Hooks for container setup and teardown
func (m *Hooks) GetPoststop() []*Hook
func (m *Hooks) GetPrestart() []*Hook
func (*Hooks) ProtoMessage()
func (m *Hooks) Reset()
func (m *Hooks) String() string
type HugepageLimit struct {
Pagesize *string `protobuf:"bytes,1,opt,name=pagesize" json:"pagesize,omitempty"`
Limit *int32 `protobuf:"varint,2,opt,name=limit" json:"limit,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
HugepageLimit structure corresponds to limiting kernel hugepages
func (m *HugepageLimit) GetLimit() int32
func (m *HugepageLimit) GetPagesize() string
func (*HugepageLimit) ProtoMessage()
func (m *HugepageLimit) Reset()
func (m *HugepageLimit) String() string
type IDMapping struct {
// HostID is the UID/GID of the host user or group
HostId *int32 `protobuf:"varint,1,opt,name=host_id" json:"host_id,omitempty"`
// ContainerID is the UID/GID of the container's user or group
ContainerId *int32 `protobuf:"varint,2,opt,name=container_id" json:"container_id,omitempty"`
// Size is the length of the range of IDs mapped between the two namespaces
Size *int32 `protobuf:"varint,3,opt,name=size" json:"size,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
IDMapping specifies UID/GID mappings
func (m *IDMapping) GetContainerId() int32
func (m *IDMapping) GetHostId() int32
func (m *IDMapping) GetSize() int32
func (*IDMapping) ProtoMessage()
func (m *IDMapping) Reset()
func (m *IDMapping) String() string
type InterfacePriority struct {
// Name is the name of the network interface
Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// Priority for the interface
Priority *int64 `protobuf:"varint,2,opt,name=priority" json:"priority,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
InterfacePriority for network interfaces
func (m *InterfacePriority) GetName() string
func (m *InterfacePriority) GetPriority() int64
func (*InterfacePriority) ProtoMessage()
func (m *InterfacePriority) Reset()
func (m *InterfacePriority) String() string
type LinuxConfig struct {
// Capabilities are linux capabilities that are kept for the container.
Capabilities []string `protobuf:"bytes,1,rep,name=capabilities" json:"capabilities,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
LinuxConfig contains platform specific configuration for linux based
containers.
func (m *LinuxConfig) GetCapabilities() []string
func (*LinuxConfig) ProtoMessage()
func (m *LinuxConfig) Reset()
func (m *LinuxConfig) String() string
type LinuxRuntime struct {
// UidMapping specifies user mappings for supporting user namespaces on linux.
UidMapping []*IDMapping `protobuf:"bytes,1,rep,name=uid_mapping" json:"uid_mapping,omitempty"`
// GidMapping specifies group mappings for supporting user namespaces on linux.
GidMapping []*IDMapping `protobuf:"bytes,2,rep,name=gid_mapping" json:"gid_mapping,omitempty"`
// Rlimits specifies rlimit options to apply to the container's process.
Rlimits []*Rlimit `protobuf:"bytes,3,rep,name=rlimits" json:"rlimits,omitempty"`
// Sysctl are a set of key value pairs that are set for the container on start
Sysctl []*StringStringEntry `protobuf:"bytes,4,rep,name=sysctl" json:"sysctl,omitempty"`
// Resources contain cgroup information for handling resource constraints
// for the container
Resources *Resources `protobuf:"bytes,5,opt,name=resources" json:"resources,omitempty"`
// CgroupsPath specifies the path to cgroups that are created and/or joined by the container.
// The path is expected to be relative to the cgroups mountpoint.
// If resources are specified, the cgroups at CgroupsPath will be updated based on resources.
CgroupsPath *string `protobuf:"bytes,6,opt,name=cgroups_path" json:"cgroups_path,omitempty"`
// Namespaces contains the namespaces that are created and/or joined by the container
Namespaces []*Namespace `protobuf:"bytes,7,rep,name=namespaces" json:"namespaces,omitempty"`
// Devices are a list of device nodes that are created and enabled for the container
Devices []*Device `protobuf:"bytes,8,rep,name=devices" json:"devices,omitempty"`
// ApparmorProfile specified the apparmor profile for the container.
ApparmorProfile *string `protobuf:"bytes,9,opt,name=apparmor_profile" json:"apparmor_profile,omitempty"`
// SelinuxProcessLabel specifies the selinux context that the container process is run as.
SelinuxProcessLabel *string `protobuf:"bytes,10,opt,name=selinux_process_label" json:"selinux_process_label,omitempty"`
// Seccomp specifies the seccomp security settings for the container.
Seccomp *Seccomp `protobuf:"bytes,11,opt,name=seccomp" json:"seccomp,omitempty"`
// RootfsPropagation is the rootfs mount propagation mode for the container
RootfsPropagation *string `protobuf:"bytes,12,opt,name=rootfs_propagation" json:"rootfs_propagation,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
LinuxRuntime hosts the Linux-only runtime information
func (m *LinuxRuntime) GetApparmorProfile() string
func (m *LinuxRuntime) GetCgroupsPath() string
func (m *LinuxRuntime) GetDevices() []*Device
func (m *LinuxRuntime) GetGidMapping() []*IDMapping
func (m *LinuxRuntime) GetNamespaces() []*Namespace
func (m *LinuxRuntime) GetResources() *Resources
func (m *LinuxRuntime) GetRlimits() []*Rlimit
func (m *LinuxRuntime) GetRootfsPropagation() string
func (m *LinuxRuntime) GetSeccomp() *Seccomp
func (m *LinuxRuntime) GetSelinuxProcessLabel() string
func (m *LinuxRuntime) GetSysctl() []*StringStringEntry
func (m *LinuxRuntime) GetUidMapping() []*IDMapping
func (*LinuxRuntime) ProtoMessage()
func (m *LinuxRuntime) Reset()
func (m *LinuxRuntime) String() string
type LinuxRuntimeSpec struct {
RuntimeSpec *RuntimeSpec `protobuf:"bytes,1,opt,name=runtime_spec" json:"runtime_spec,omitempty"`
// LinuxRuntime is platform specific configuration for linux based containers.
Linux *oci1.LinuxRuntime `protobuf:"bytes,2,opt,name=linux" json:"linux,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
LinuxRuntimeSpec is the full specification for linux containers.
func (m *LinuxRuntimeSpec) GetLinux() *oci1.LinuxRuntime
func (m *LinuxRuntimeSpec) GetRuntimeSpec() *RuntimeSpec
func (*LinuxRuntimeSpec) ProtoMessage()
func (m *LinuxRuntimeSpec) Reset()
func (m *LinuxRuntimeSpec) String() string
type LinuxSpec struct {
Spec *Spec `protobuf:"bytes,1,opt,name=spec" json:"spec,omitempty"`
// LinuxConfig is platform specific configuration for linux based
// containers.
LinuxConfig *LinuxConfig `protobuf:"bytes,2,opt,name=linux_config" json:"linux_config,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
LinuxSpec is the full specification for linux containers.
func (m *LinuxSpec) GetLinuxConfig() *LinuxConfig
func (m *LinuxSpec) GetSpec() *Spec
func (*LinuxSpec) ProtoMessage()
func (m *LinuxSpec) Reset()
func (m *LinuxSpec) String() string
type Memory struct {
// Memory limit (in bytes)
Limit *int64 `protobuf:"varint,1,opt,name=limit" json:"limit,omitempty"`
// Memory reservation or soft_limit (in bytes)
Reservation *int64 `protobuf:"varint,2,opt,name=reservation" json:"reservation,omitempty"`
// Total memory usage (memory + swap); set `-1' to disable swap
Swap *int64 `protobuf:"varint,3,opt,name=swap" json:"swap,omitempty"`
// Kernel memory limit (in bytes)
Kernel *int64 `protobuf:"varint,4,opt,name=kernel" json:"kernel,omitempty"`
// How aggressive the kernel will swap memory pages. Range from 0 to 100. Set -1 to use system default
Swappiness *int64 `protobuf:"varint,5,opt,name=Swappiness" json:"Swappiness,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Memory for Linux cgroup 'memory' resource management
func (m *Memory) GetKernel() int64
func (m *Memory) GetLimit() int64
func (m *Memory) GetReservation() int64
func (m *Memory) GetSwap() int64
func (m *Memory) GetSwappiness() int64
func (*Memory) ProtoMessage()
func (m *Memory) Reset()
func (m *Memory) String() string
type Mount struct {
// Type specifies the mount kind.
Type *string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=source" json:"source,omitempty"`
// Options are fstab style mount options.
Options []string `protobuf:"bytes,3,rep,name=options" json:"options,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Mount specifies a mount for a container
func (m *Mount) GetOptions() []string
func (m *Mount) GetSource() string
func (m *Mount) GetType() string
func (*Mount) ProtoMessage()
func (m *Mount) Reset()
func (m *Mount) String() string
type MountFieldEntry struct {
Key *string `protobuf:"bytes,1,req,name=key" json:"key,omitempty"`
Value *Mount `protobuf:"bytes,2,req,name=value" json:"value,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
MountFieldEntry is more backwards compatible protobuf associative map
(than map<string, Mount>)
func (m *MountFieldEntry) GetKey() string
func (m *MountFieldEntry) GetValue() *Mount
func (*MountFieldEntry) ProtoMessage()
func (m *MountFieldEntry) Reset()
func (m *MountFieldEntry) String() string
type MountPoint struct {
// Name is a unique descriptive identifier for this mount point.
Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// Path specifies the path of the mount. The path and child directories
// MUST exist, a runtime MUST NOT create directories automatically to a
// mount point.
Path *string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
MountPoint describes a directory that may be fullfilled by a mount in
the runtime.json.
func (m *MountPoint) GetName() string
func (m *MountPoint) GetPath() string
func (*MountPoint) ProtoMessage()
func (m *MountPoint) Reset()
func (m *MountPoint) String() string
type Namespace struct {
// Type is the type of Linux namespace
Type *string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
// Path is a path to an existing namespace persisted on disk that can be joined
// and is of the same type
Path *string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Namespace is the configuration for a linux namespace
func (m *Namespace) GetPath() string
func (m *Namespace) GetType() string
func (*Namespace) ProtoMessage()
func (m *Namespace) Reset()
func (m *Namespace) String() string
type Network struct {
// Set class identifier for container's network packets
ClassId *string `protobuf:"bytes,1,opt,name=class_id" json:"class_id,omitempty"`
// Set priority of network traffic for container
Priorities []*InterfacePriority `protobuf:"bytes,2,rep,name=priorities" json:"priorities,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Network identification and priority configuration
func (m *Network) GetClassId() string
func (m *Network) GetPriorities() []*InterfacePriority
func (*Network) ProtoMessage()
func (m *Network) Reset()
func (m *Network) String() string
type Pids struct {
// Maximum number of PIDs. A value < 0 implies "no limit".
Limit *int64 `protobuf:"varint,1,opt,name=limit" json:"limit,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Pids for Linux cgroup 'pids' resource management (Linux 4.3)
func (m *Pids) GetLimit() int64
func (*Pids) ProtoMessage()
func (m *Pids) Reset()
func (m *Pids) String() string
type Platform struct {
// OS is the operating system.
Os *string `protobuf:"bytes,1,opt,name=os" json:"os,omitempty"`
// Arch is the architecture
Arch *string `protobuf:"bytes,2,opt,name=arch" json:"arch,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Platform specifies OS and arch information for the host system that the
container is created for.
func (m *Platform) GetArch() string
func (m *Platform) GetOs() string
func (*Platform) ProtoMessage()
func (m *Platform) Reset()
func (m *Platform) String() string
type PlatformType int32
const (
PlatformType_UNKNOWN PlatformType = 0
PlatformType_LINUX PlatformType = 1
)
func (x PlatformType) Enum() *PlatformType
func (x PlatformType) String() string
func (x *PlatformType) UnmarshalJSON(data []byte) error
type Process struct {
// Terminal creates an interactive terminal for the container.
Terminal *bool `protobuf:"varint,1,opt,name=terminal" json:"terminal,omitempty"`
// User specifies user information for the process.
User *User `protobuf:"bytes,2,opt,name=user" json:"user,omitempty"`
// Args specifies the binary and arguments for the application to
// execute.
Args []string `protobuf:"bytes,3,rep,name=args" json:"args,omitempty"`
// Env populates the process environment for the process.
Env []string `protobuf:"bytes,4,rep,name=env" json:"env,omitempty"`
// Cwd is the current working directory for the process and must be
// relative to the container's root.
Cwd *string `protobuf:"bytes,5,opt,name=cwd" json:"cwd,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Process contains information to start a specific application inside the
container.
func (m *Process) GetArgs() []string
func (m *Process) GetCwd() string
func (m *Process) GetEnv() []string
func (m *Process) GetTerminal() bool
func (m *Process) GetUser() *User
func (*Process) ProtoMessage()
func (m *Process) Reset()
func (m *Process) String() string
type Resources struct {
// DisableOOMKiller disables the OOM killer for out of memory conditions
DisableOomKiller *bool `protobuf:"varint,1,opt,name=disable_oom_killer" json:"disable_oom_killer,omitempty"`
// Memory restriction configuration
Memory *Memory `protobuf:"bytes,2,opt,name=memory" json:"memory,omitempty"`
// CPU resource restriction configuration
Cpu *CPU `protobuf:"bytes,3,opt,name=cpu" json:"cpu,omitempty"`
// Task resource restriction configuration.
Pids *Pids `protobuf:"bytes,4,opt,name=pids" json:"pids,omitempty"`
// BlockIO restriction configuration
BlockIo *BlockIO `protobuf:"bytes,5,opt,name=block_io" json:"block_io,omitempty"`
// Hugetlb limit (in bytes)
HugepageLimits []*HugepageLimit `protobuf:"bytes,6,rep,name=hugepage_limits" json:"hugepage_limits,omitempty"`
// Network restriction configuration
Network *Network `protobuf:"bytes,7,opt,name=network" json:"network,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Resources has container runtime resource constraints
func (m *Resources) GetBlockIo() *BlockIO
func (m *Resources) GetCpu() *CPU
func (m *Resources) GetDisableOomKiller() bool
func (m *Resources) GetHugepageLimits() []*HugepageLimit
func (m *Resources) GetMemory() *Memory
func (m *Resources) GetNetwork() *Network
func (m *Resources) GetPids() *Pids
func (*Resources) ProtoMessage()
func (m *Resources) Reset()
func (m *Resources) String() string
type Rlimit struct {
// Type of the rlimit to set
Type *string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
// Hard is the hard limit for the specified type
Hard *uint64 `protobuf:"varint,2,opt,name=hard" json:"hard,omitempty"`
// Soft is the soft limit for the specified type
Soft *uint64 `protobuf:"varint,3,opt,name=soft" json:"soft,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Rlimit type and restrictions
func (m *Rlimit) GetHard() uint64
func (m *Rlimit) GetSoft() uint64
func (m *Rlimit) GetType() string
func (*Rlimit) ProtoMessage()
func (m *Rlimit) Reset()
func (m *Rlimit) String() string
type Root struct {
// Path is the absolute path to the container's root filesystem.
Path *string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
// Readonly makes the root filesystem for the container readonly before
// the process is executed.
Readonly *bool `protobuf:"varint,2,opt,name=readonly" json:"readonly,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Root contains information about the container's root filesystem on the
host.
func (m *Root) GetPath() string
func (m *Root) GetReadonly() bool
func (*Root) ProtoMessage()
func (m *Root) Reset()
func (m *Root) String() string
type RuntimeSpec struct {
// Mounts is a mapping of names to mount configurations.
// Which mounts will be mounted and where should be chosen with MountPoints
// in Spec.
Mounts []*MountFieldEntry `protobuf:"bytes,1,rep,name=mounts" json:"mounts,omitempty"`
// Hooks are the commands run at various lifecycle events of the container.
Hooks *Hooks `protobuf:"bytes,2,opt,name=hooks" json:"hooks,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
RuntimeSpec is the generic runtime state information on a running
container
func (m *RuntimeSpec) GetHooks() *Hooks
func (m *RuntimeSpec) GetMounts() []*MountFieldEntry
func (*RuntimeSpec) ProtoMessage()
func (m *RuntimeSpec) Reset()
func (m *RuntimeSpec) String() string
type Seccomp struct {
// TODO(vbatts) string instead of "Action" type
DefaultAction *string `protobuf:"bytes,1,opt,name=default_action" json:"default_action,omitempty"`
Syscalls []*Syscall `protobuf:"bytes,2,rep,name=syscalls" json:"syscalls,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Seccomp represents syscall restrictions
func (m *Seccomp) GetDefaultAction() string
func (m *Seccomp) GetSyscalls() []*Syscall
func (*Seccomp) ProtoMessage()
func (m *Seccomp) Reset()
func (m *Seccomp) String() string
type Spec struct {
// Version is the version of the specification that is supported.
Version *string `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"`
// Platform is the host information for OS and Arch.
Platform *Platform `protobuf:"bytes,2,opt,name=platform" json:"platform,omitempty"`
// Process is the container's main process.
Process *Process `protobuf:"bytes,3,opt,name=process" json:"process,omitempty"`
// Root is the root information for the container's filesystem.
Root *Root `protobuf:"bytes,4,opt,name=root" json:"root,omitempty"`
// Hostname is the container's host name.
Hostname *string `protobuf:"bytes,5,opt,name=hostname" json:"hostname,omitempty"`
// Mounts profile configuration for adding mounts to the container's
// filesystem.
Mounts []*MountPoint `protobuf:"bytes,6,rep,name=mounts" json:"mounts,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Spec is the base configuration for the container. It specifies platform
independent configuration.
func (m *Spec) GetHostname() string
func (m *Spec) GetMounts() []*MountPoint
func (m *Spec) GetPlatform() *Platform
func (m *Spec) GetProcess() *Process
func (m *Spec) GetRoot() *Root
func (m *Spec) GetVersion() string
func (*Spec) ProtoMessage()
func (m *Spec) Reset()
func (m *Spec) String() string
type StringStringEntry struct {
Key *string `protobuf:"bytes,1,req,name=key" json:"key,omitempty"`
Value *string `protobuf:"bytes,2,req,name=value" json:"value,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
StringStringEntry is more backwards compatible protobuf associative map
(than map<string, Mount>)
func (m *StringStringEntry) GetKey() string
func (m *StringStringEntry) GetValue() string
func (*StringStringEntry) ProtoMessage()
func (m *StringStringEntry) Reset()
func (m *StringStringEntry) String() string
type Syscall struct {
Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
Action *string `protobuf:"bytes,2,opt,name=action" json:"action,omitempty"`
Args []*Arg `protobuf:"bytes,3,rep,name=args" json:"args,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
Syscall is used to match a syscall in Seccomp
func (m *Syscall) GetAction() string
func (m *Syscall) GetArgs() []*Arg
func (m *Syscall) GetName() string
func (*Syscall) ProtoMessage()
func (m *Syscall) Reset()
func (m *Syscall) String() string
type User struct {
// Type so that receivers of this message can `switch` for the fields
// expected
Type *PlatformType `protobuf:"varint,1,opt,name=type,enum=oci.PlatformType" json:"type,omitempty"`
XXX_extensions map[int32]proto.Extension `json:"-"`
XXX_unrecognized []byte `json:"-"`
}
User specifies user information for the process.
func (m *User) ExtensionMap() map[int32]proto.Extension
func (*User) ExtensionRangeArray() []proto.ExtensionRange
func (m *User) GetType() PlatformType
func (*User) ProtoMessage()
func (m *User) Reset()
func (m *User) String() string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment