...

Package options

import "github.com/Microsoft/hcsshim/cmd/containerd-shim-runhcs-v1/options"
Overview
Index

Overview ▾

Index ▾

Variables
type Options
    func (*Options) Descriptor() ([]byte, []int)
    func (m *Options) Marshal() (dAtA []byte, err error)
    func (m *Options) MarshalTo(dAtA []byte) (int, error)
    func (m *Options) MarshalToSizedBuffer(dAtA []byte) (int, error)
    func (*Options) ProtoMessage()
    func (m *Options) Reset()
    func (m *Options) Size() (n int)
    func (this *Options) String() string
    func (m *Options) Unmarshal(dAtA []byte) error
    func (m *Options) XXX_DiscardUnknown()
    func (m *Options) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
    func (m *Options) XXX_Merge(src proto.Message)
    func (m *Options) XXX_Size() int
    func (m *Options) XXX_Unmarshal(b []byte) error
type Options_DebugType
    func (Options_DebugType) EnumDescriptor() ([]byte, []int)
    func (x Options_DebugType) String() string
type Options_SandboxIsolation
    func (Options_SandboxIsolation) EnumDescriptor() ([]byte, []int)
    func (x Options_SandboxIsolation) String() string
type ProcessDetails
    func (*ProcessDetails) Descriptor() ([]byte, []int)
    func (m *ProcessDetails) Marshal() (dAtA []byte, err error)
    func (m *ProcessDetails) MarshalTo(dAtA []byte) (int, error)
    func (m *ProcessDetails) MarshalToSizedBuffer(dAtA []byte) (int, error)
    func (*ProcessDetails) ProtoMessage()
    func (m *ProcessDetails) Reset()
    func (m *ProcessDetails) Size() (n int)
    func (this *ProcessDetails) String() string
    func (m *ProcessDetails) Unmarshal(dAtA []byte) error
    func (m *ProcessDetails) XXX_DiscardUnknown()
    func (m *ProcessDetails) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
    func (m *ProcessDetails) XXX_Merge(src proto.Message)
    func (m *ProcessDetails) XXX_Size() int
    func (m *ProcessDetails) XXX_Unmarshal(b []byte) error

Package files

doc.go runhcs.pb.go

Variables

var (
    ErrInvalidLengthRunhcs        = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowRunhcs          = fmt.Errorf("proto: integer overflow")
    ErrUnexpectedEndOfGroupRunhcs = fmt.Errorf("proto: unexpected end of group")
)
var Options_DebugType_name = map[int32]string{
    0: "NPIPE",
    1: "FILE",
    2: "ETW",
}
var Options_DebugType_value = map[string]int32{
    "NPIPE": 0,
    "FILE":  1,
    "ETW":   2,
}
var Options_SandboxIsolation_name = map[int32]string{
    0: "PROCESS",
    1: "HYPERVISOR",
}
var Options_SandboxIsolation_value = map[string]int32{
    "PROCESS":    0,
    "HYPERVISOR": 1,
}

type Options

Options are the set of customizations that can be passed at Create time.

type Options struct {
    // Enable debug tracing (sets the logrus log level to debug). This may be deprecated in the future, prefer
    // log_level as this will override debug if both of them are set.
    Debug bool `protobuf:"varint,1,opt,name=debug,proto3" json:"debug,omitempty"`
    // debug tracing output type
    DebugType Options_DebugType `protobuf:"varint,2,opt,name=debug_type,json=debugType,proto3,enum=containerd.runhcs.v1.Options_DebugType" json:"debug_type,omitempty"`
    // registry key root for storage of the runhcs container state
    RegistryRoot string `protobuf:"bytes,3,opt,name=registry_root,json=registryRoot,proto3" json:"registry_root,omitempty"`
    // sandbox_image is the image to use for the sandbox that matches the
    // sandbox_platform.
    SandboxImage string `protobuf:"bytes,4,opt,name=sandbox_image,json=sandboxImage,proto3" json:"sandbox_image,omitempty"`
    // sandbox_platform is a CRI setting that specifies the platform
    // architecture for all sandbox's in this runtime. Values are
    // 'windows/amd64' and 'linux/amd64'.
    SandboxPlatform string `protobuf:"bytes,5,opt,name=sandbox_platform,json=sandboxPlatform,proto3" json:"sandbox_platform,omitempty"`
    // sandbox_isolation is a CRI setting that specifies the isolation level of
    // the sandbox. For Windows runtime PROCESS and HYPERVISOR are valid. For
    // LCOW only HYPERVISOR is valid and default if omitted.
    SandboxIsolation Options_SandboxIsolation `protobuf:"varint,6,opt,name=sandbox_isolation,json=sandboxIsolation,proto3,enum=containerd.runhcs.v1.Options_SandboxIsolation" json:"sandbox_isolation,omitempty"`
    // boot_files_root_path is the path to the directory containing the LCOW
    // kernel and root FS files.
    BootFilesRootPath string `protobuf:"bytes,7,opt,name=boot_files_root_path,json=bootFilesRootPath,proto3" json:"boot_files_root_path,omitempty"`
    // vm_processor_count is the default number of processors to create for the
    // hypervisor isolated utility vm.
    //
    // The platform default if omitted is 2, unless the host only has a single
    // core in which case it is 1.
    VmProcessorCount int32 `protobuf:"varint,8,opt,name=vm_processor_count,json=vmProcessorCount,proto3" json:"vm_processor_count,omitempty"`
    // vm_memory_size_in_mb is the default amount of memory to assign to the
    // hypervisor isolated utility vm.
    //
    // The platform default is 1024MB if omitted.
    VmMemorySizeInMb int32 `protobuf:"varint,9,opt,name=vm_memory_size_in_mb,json=vmMemorySizeInMb,proto3" json:"vm_memory_size_in_mb,omitempty"`
    // GPUVHDPath is the path to the gpu vhd to add to the uvm
    // when a container requests a gpu
    GPUVHDPath string `protobuf:"bytes,10,opt,name=GPUVHDPath,proto3" json:"GPUVHDPath,omitempty"`
    // scale_cpu_limits_to_sandbox indicates that container CPU limits should
    // be adjusted to account for the difference in number of cores between the
    // host and UVM.
    ScaleCpuLimitsToSandbox bool `protobuf:"varint,11,opt,name=scale_cpu_limits_to_sandbox,json=scaleCpuLimitsToSandbox,proto3" json:"scale_cpu_limits_to_sandbox,omitempty"`
    // default_container_scratch_size_in_gb is the default scratch size (sandbox.vhdx)
    // to be used for containers. Every container will get a sandbox of `size_in_gb` assigned
    // instead of the default of 20GB.
    DefaultContainerScratchSizeInGb int32 `protobuf:"varint,12,opt,name=default_container_scratch_size_in_gb,json=defaultContainerScratchSizeInGb,proto3" json:"default_container_scratch_size_in_gb,omitempty"`
    // default_vm_scratch_size_in_gb is the default scratch size (sandbox.vhdx)
    // to be used for the UVM. This only applies to WCOW as LCOW doesn't mount a scratch
    // specifically for the UVM.
    DefaultVmScratchSizeInGb int32 `protobuf:"varint,13,opt,name=default_vm_scratch_size_in_gb,json=defaultVmScratchSizeInGb,proto3" json:"default_vm_scratch_size_in_gb,omitempty"`
    // share_scratch specifies if we'd like to reuse scratch space between multiple containers.
    // This currently only affects LCOW. The sandbox containers scratch space is re-used for all
    // subsequent containers launched in the pod.
    ShareScratch bool `protobuf:"varint,14,opt,name=share_scratch,json=shareScratch,proto3" json:"share_scratch,omitempty"`
    // NCProxyAddr is the address of the network configuration proxy service. If omitted
    // the network is setup locally.
    NCProxyAddr string `protobuf:"bytes,15,opt,name=NCProxyAddr,proto3" json:"NCProxyAddr,omitempty"`
    // log_level specifies the logrus log level for the shim. Supported values are a string representation of the
    // logrus log levels: "trace", "debug", "info", "warn", "error", "fatal", "panic". This setting will override
    // the `debug` field if both are specified, unless the level specified is also "debug", as these are equivalent.
    LogLevel string `protobuf:"bytes,16,opt,name=log_level,json=logLevel,proto3" json:"log_level,omitempty"`
    // io_retry_timeout_in_sec is the timeout in seconds for how long to try and reconnect to an upstream IO provider if a connection is lost.
    // The typical example is if Containerd has restarted but is expected to come back online. A 0 for this field is interpreted as an infinite
    // timeout.
    IoRetryTimeoutInSec int32 `protobuf:"varint,17,opt,name=io_retry_timeout_in_sec,json=ioRetryTimeoutInSec,proto3" json:"io_retry_timeout_in_sec,omitempty"`
    // default_container_annotations specifies a set of annotations that should be set for every workload container
    DefaultContainerAnnotations map[string]string `protobuf:"bytes,18,rep,name=default_container_annotations,json=defaultContainerAnnotations,proto3" json:"default_container_annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // no_inherit_host_timezone specifies to skip inheriting the hosts time zone for WCOW UVMs and instead default to
    // UTC.
    NoInheritHostTimezone bool `protobuf:"varint,19,opt,name=no_inherit_host_timezone,json=noInheritHostTimezone,proto3" json:"no_inherit_host_timezone,omitempty"`
    // scrub_logs enables removing environment variables and other potentially sensitive information from logs
    ScrubLogs            bool     `protobuf:"varint,20,opt,name=scrub_logs,json=scrubLogs,proto3" json:"scrub_logs,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*Options) Descriptor

func (*Options) Descriptor() ([]byte, []int)

func (*Options) Marshal

func (m *Options) Marshal() (dAtA []byte, err error)

func (*Options) MarshalTo

func (m *Options) MarshalTo(dAtA []byte) (int, error)

func (*Options) MarshalToSizedBuffer

func (m *Options) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Options) ProtoMessage

func (*Options) ProtoMessage()

func (*Options) Reset

func (m *Options) Reset()

func (*Options) Size

func (m *Options) Size() (n int)

func (*Options) String

func (this *Options) String() string

func (*Options) Unmarshal

func (m *Options) Unmarshal(dAtA []byte) error

func (*Options) XXX_DiscardUnknown

func (m *Options) XXX_DiscardUnknown()

func (*Options) XXX_Marshal

func (m *Options) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Options) XXX_Merge

func (m *Options) XXX_Merge(src proto.Message)

func (*Options) XXX_Size

func (m *Options) XXX_Size() int

func (*Options) XXX_Unmarshal

func (m *Options) XXX_Unmarshal(b []byte) error

type Options_DebugType

type Options_DebugType int32
const (
    Options_NPIPE Options_DebugType = 0
    Options_FILE  Options_DebugType = 1
    Options_ETW   Options_DebugType = 2
)

func (Options_DebugType) EnumDescriptor

func (Options_DebugType) EnumDescriptor() ([]byte, []int)

func (Options_DebugType) String

func (x Options_DebugType) String() string

type Options_SandboxIsolation

type Options_SandboxIsolation int32
const (
    Options_PROCESS    Options_SandboxIsolation = 0
    Options_HYPERVISOR Options_SandboxIsolation = 1
)

func (Options_SandboxIsolation) EnumDescriptor

func (Options_SandboxIsolation) EnumDescriptor() ([]byte, []int)

func (Options_SandboxIsolation) String

func (x Options_SandboxIsolation) String() string

type ProcessDetails

ProcessDetails contains additional information about a process. This is the additional info returned in the Pids query.

type ProcessDetails struct {
    ImageName                    string    `protobuf:"bytes,1,opt,name=image_name,json=imageName,proto3" json:"image_name,omitempty"`
    CreatedAt                    time.Time `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3,stdtime" json:"created_at"`
    KernelTime_100Ns             uint64    `protobuf:"varint,3,opt,name=kernel_time_100_ns,json=kernelTime100Ns,proto3" json:"kernel_time_100_ns,omitempty"`
    MemoryCommitBytes            uint64    `protobuf:"varint,4,opt,name=memory_commit_bytes,json=memoryCommitBytes,proto3" json:"memory_commit_bytes,omitempty"`
    MemoryWorkingSetPrivateBytes uint64    `protobuf:"varint,5,opt,name=memory_working_set_private_bytes,json=memoryWorkingSetPrivateBytes,proto3" json:"memory_working_set_private_bytes,omitempty"`
    MemoryWorkingSetSharedBytes  uint64    `protobuf:"varint,6,opt,name=memory_working_set_shared_bytes,json=memoryWorkingSetSharedBytes,proto3" json:"memory_working_set_shared_bytes,omitempty"`
    ProcessID                    uint32    `protobuf:"varint,7,opt,name=process_id,json=processId,proto3" json:"process_id,omitempty"`
    UserTime_100Ns               uint64    `protobuf:"varint,8,opt,name=user_time_100_ns,json=userTime100Ns,proto3" json:"user_time_100_ns,omitempty"`
    ExecID                       string    `protobuf:"bytes,9,opt,name=exec_id,json=execId,proto3" json:"exec_id,omitempty"`
    XXX_NoUnkeyedLiteral         struct{}  `json:"-"`
    XXX_unrecognized             []byte    `json:"-"`
    XXX_sizecache                int32     `json:"-"`
}

func (*ProcessDetails) Descriptor

func (*ProcessDetails) Descriptor() ([]byte, []int)

func (*ProcessDetails) Marshal

func (m *ProcessDetails) Marshal() (dAtA []byte, err error)

func (*ProcessDetails) MarshalTo

func (m *ProcessDetails) MarshalTo(dAtA []byte) (int, error)

func (*ProcessDetails) MarshalToSizedBuffer

func (m *ProcessDetails) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProcessDetails) ProtoMessage

func (*ProcessDetails) ProtoMessage()

func (*ProcessDetails) Reset

func (m *ProcessDetails) Reset()

func (*ProcessDetails) Size

func (m *ProcessDetails) Size() (n int)

func (*ProcessDetails) String

func (this *ProcessDetails) String() string

func (*ProcessDetails) Unmarshal

func (m *ProcessDetails) Unmarshal(dAtA []byte) error

func (*ProcessDetails) XXX_DiscardUnknown

func (m *ProcessDetails) XXX_DiscardUnknown()

func (*ProcessDetails) XXX_Marshal

func (m *ProcessDetails) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProcessDetails) XXX_Merge

func (m *ProcessDetails) XXX_Merge(src proto.Message)

func (*ProcessDetails) XXX_Size

func (m *ProcessDetails) XXX_Size() int

func (*ProcessDetails) XXX_Unmarshal

func (m *ProcessDetails) XXX_Unmarshal(b []byte) error