options

package
v0.12.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 30, 2024 License: MIT Imports: 5 Imported by: 78

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Options_DebugType_name = map[int32]string{
		0: "NPIPE",
		1: "FILE",
		2: "ETW",
	}
	Options_DebugType_value = map[string]int32{
		"NPIPE": 0,
		"FILE":  1,
		"ETW":   2,
	}
)

Enum value maps for Options_DebugType.

View Source 
var (
	Options_SandboxIsolation_name = map[int32]string{
		0: "PROCESS",
		1: "HYPERVISOR",
	}
	Options_SandboxIsolation_value = map[string]int32{
		"PROCESS":    0,
		"HYPERVISOR": 1,
	}
)

Enum value maps for Options_SandboxIsolation.

View Source 
var File_github_com_Microsoft_hcsshim_cmd_containerd_shim_runhcs_v1_options_runhcs_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Options 

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 `` /* 133-byte string literal not displayed */
	// 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 `` /* 161-byte string literal not displayed */
	// 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 `` /* 138-byte string literal not displayed */
	// 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 `` /* 164-byte string literal not displayed */
	// 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 `` /* 143-byte string literal not displayed */
	// 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 `` /* 126-byte string literal not displayed */
	// default_container_annotations specifies a set of annotations that should be set for every workload container
	DefaultContainerAnnotations map[string]string `` /* 233-byte string literal not displayed */
	// no_inherit_host_timezone specifies to skip inheriting the hosts time zone for WCOW UVMs and instead default to
	// UTC.
	NoInheritHostTimezone bool `` /* 130-byte string literal not displayed */
	// 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"`
	// contains filtered or unexported fields
}

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

func (*Options) Descriptor deprecated 

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

Deprecated: Use Options.ProtoReflect.Descriptor instead.

func (*Options) GetBootFilesRootPath added in v0.10.0 

func (x *Options) GetBootFilesRootPath() string

func (*Options) GetDebug added in v0.10.0 

func (x *Options) GetDebug() bool

func (*Options) GetDebugType added in v0.10.0 

func (x *Options) GetDebugType() Options_DebugType

func (*Options) GetDefaultContainerAnnotations added in v0.10.0 

func (x *Options) GetDefaultContainerAnnotations() map[string]string

func (*Options) GetDefaultContainerScratchSizeInGb added in v0.10.0 

func (x *Options) GetDefaultContainerScratchSizeInGb() int32

func (*Options) GetDefaultVmScratchSizeInGb added in v0.10.0 

func (x *Options) GetDefaultVmScratchSizeInGb() int32

func (*Options) GetGPUVHDPath added in v0.10.0 

func (x *Options) GetGPUVHDPath() string

func (*Options) GetIoRetryTimeoutInSec added in v0.10.0 

func (x *Options) GetIoRetryTimeoutInSec() int32

func (*Options) GetLogLevel added in v0.10.0 

func (x *Options) GetLogLevel() string

func (*Options) GetNCProxyAddr added in v0.10.0 

func (x *Options) GetNCProxyAddr() string

func (*Options) GetNoInheritHostTimezone added in v0.10.0 

func (x *Options) GetNoInheritHostTimezone() bool

func (*Options) GetRegistryRoot added in v0.10.0 

func (x *Options) GetRegistryRoot() string

func (*Options) GetSandboxImage added in v0.10.0 

func (x *Options) GetSandboxImage() string

func (*Options) GetSandboxIsolation added in v0.10.0 

func (x *Options) GetSandboxIsolation() Options_SandboxIsolation

func (*Options) GetSandboxPlatform added in v0.10.0 

func (x *Options) GetSandboxPlatform() string

func (*Options) GetScaleCpuLimitsToSandbox added in v0.10.0 

func (x *Options) GetScaleCpuLimitsToSandbox() bool

func (*Options) GetScrubLogs added in v0.10.0 

func (x *Options) GetScrubLogs() bool

func (*Options) GetShareScratch added in v0.10.0 

func (x *Options) GetShareScratch() bool

func (*Options) GetVmMemorySizeInMb added in v0.10.0 

func (x *Options) GetVmMemorySizeInMb() int32

func (*Options) GetVmProcessorCount added in v0.10.0 

func (x *Options) GetVmProcessorCount() int32

func (*Options) ProtoMessage 

func (*Options) ProtoMessage()

func (*Options) ProtoReflect added in v0.10.0 

func (x *Options) ProtoReflect() protoreflect.Message

func (*Options) Reset 

func (x *Options) Reset()

func (*Options) String 

func (x *Options) String() string

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) Descriptor added in v0.10.0 

func (Options_DebugType) Descriptor() protoreflect.EnumDescriptor

func (Options_DebugType) Enum added in v0.10.0 

func (x Options_DebugType) Enum() *Options_DebugType

func (Options_DebugType) EnumDescriptor deprecated 

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

Deprecated: Use Options_DebugType.Descriptor instead.

func (Options_DebugType) Number added in v0.10.0 

func (x Options_DebugType) Number() protoreflect.EnumNumber

func (Options_DebugType) String 

func (x Options_DebugType) String() string

func (Options_DebugType) Type added in v0.10.0 

func (Options_DebugType) Type() protoreflect.EnumType

type Options_SandboxIsolation 

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

func (Options_SandboxIsolation) Descriptor added in v0.10.0 

func (Options_SandboxIsolation) Descriptor() protoreflect.EnumDescriptor

func (Options_SandboxIsolation) Enum added in v0.10.0 

func (x Options_SandboxIsolation) Enum() *Options_SandboxIsolation

func (Options_SandboxIsolation) EnumDescriptor deprecated 

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

Deprecated: Use Options_SandboxIsolation.Descriptor instead.

func (Options_SandboxIsolation) Number added in v0.10.0 

func (x Options_SandboxIsolation) Number() protoreflect.EnumNumber

func (Options_SandboxIsolation) String 

func (x Options_SandboxIsolation) String() string

func (Options_SandboxIsolation) Type added in v0.10.0 

func (Options_SandboxIsolation) Type() protoreflect.EnumType

type ProcessDetails 

type ProcessDetails struct {
	ImageName                    string                 `protobuf:"bytes,1,opt,name=image_name,json=imageName,proto3" json:"image_name,omitempty"`
	CreatedAt                    *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	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                 `` /* 152-byte string literal not displayed */
	MemoryWorkingSetSharedBytes  uint64                 `` /* 149-byte string literal not displayed */
	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"`
	// contains filtered or unexported fields
}

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

func (*ProcessDetails) Descriptor deprecated 

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

Deprecated: Use ProcessDetails.ProtoReflect.Descriptor instead.

func (*ProcessDetails) GetCreatedAt added in v0.10.0 

func (x *ProcessDetails) GetCreatedAt() *timestamppb.Timestamp

func (*ProcessDetails) GetExecID added in v0.10.0 

func (x *ProcessDetails) GetExecID() string

func (*ProcessDetails) GetImageName added in v0.10.0 

func (x *ProcessDetails) GetImageName() string

func (*ProcessDetails) GetKernelTime_100Ns added in v0.10.0 

func (x *ProcessDetails) GetKernelTime_100Ns() uint64

func (*ProcessDetails) GetMemoryCommitBytes added in v0.10.0 

func (x *ProcessDetails) GetMemoryCommitBytes() uint64

func (*ProcessDetails) GetMemoryWorkingSetPrivateBytes added in v0.10.0 

func (x *ProcessDetails) GetMemoryWorkingSetPrivateBytes() uint64

func (*ProcessDetails) GetMemoryWorkingSetSharedBytes added in v0.10.0 

func (x *ProcessDetails) GetMemoryWorkingSetSharedBytes() uint64

func (*ProcessDetails) GetProcessID added in v0.10.0 

func (x *ProcessDetails) GetProcessID() uint32

func (*ProcessDetails) GetUserTime_100Ns added in v0.10.0 

func (x *ProcessDetails) GetUserTime_100Ns() uint64

func (*ProcessDetails) ProtoMessage 

func (*ProcessDetails) ProtoMessage()

func (*ProcessDetails) ProtoReflect added in v0.10.0 

func (x *ProcessDetails) ProtoReflect() protoreflect.Message

func (*ProcessDetails) Reset 

func (x *ProcessDetails) Reset()

func (*ProcessDetails) String 

func (x *ProcessDetails) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.