Documentation ¶
Overview ¶
Package runtime is a generated protocol buffer package.
It is generated from these files:
api.proto
It has these top-level messages:
VersionRequest VersionResponse DNSConfig PortMapping Mount NamespaceOption LinuxPodSandboxConfig PodSandboxMetadata PodSandboxConfig RunPodSandboxRequest RunPodSandboxResponse StopPodSandboxRequest StopPodSandboxResponse RemovePodSandboxRequest RemovePodSandboxResponse PodSandboxStatusRequest PodSandboxNetworkStatus Namespace LinuxPodSandboxStatus PodSandboxStatus PodSandboxStatusResponse PodSandboxFilter ListPodSandboxRequest PodSandbox ListPodSandboxResponse ImageSpec KeyValue LinuxContainerResources SELinuxOption Capability LinuxContainerConfig LinuxUser ContainerMetadata ContainerConfig CreateContainerRequest CreateContainerResponse StartContainerRequest StartContainerResponse StopContainerRequest StopContainerResponse RemoveContainerRequest RemoveContainerResponse ContainerFilter ListContainersRequest Container ListContainersResponse ContainerStatusRequest ContainerStatus ContainerStatusResponse ExecSyncRequest ExecSyncResponse ExecRequest ExecResponse AttachRequest AttachResponse PortForwardRequest PortForwardResponse ImageFilter ListImagesRequest Image ListImagesResponse ImageStatusRequest ImageStatusResponse AuthConfig PullImageRequest PullImageResponse RemoveImageRequest RemoveImageResponse NetworkConfig RuntimeConfig UpdateRuntimeConfigRequest UpdateRuntimeConfigResponse
Index ¶
- Variables
- func RegisterImageServiceServer(s *grpc.Server, srv ImageServiceServer)
- func RegisterRuntimeServiceServer(s *grpc.Server, srv RuntimeServiceServer)
- type AttachRequest
- type AttachResponse
- type AuthConfig
- func (*AuthConfig) Descriptor() ([]byte, []int)
- func (m *AuthConfig) GetAuth() string
- func (m *AuthConfig) GetIdentityToken() string
- func (m *AuthConfig) GetPassword() string
- func (m *AuthConfig) GetRegistryToken() string
- func (m *AuthConfig) GetServerAddress() string
- func (m *AuthConfig) GetUsername() string
- func (*AuthConfig) ProtoMessage()
- func (m *AuthConfig) Reset()
- func (m *AuthConfig) String() string
- type Capability
- type Container
- func (*Container) Descriptor() ([]byte, []int)
- func (m *Container) GetAnnotations() map[string]string
- func (m *Container) GetCreatedAt() int64
- func (m *Container) GetId() string
- func (m *Container) GetImage() *ImageSpec
- func (m *Container) GetImageRef() string
- func (m *Container) GetLabels() map[string]string
- func (m *Container) GetMetadata() *ContainerMetadata
- func (m *Container) GetPodSandboxId() string
- func (m *Container) GetState() ContainerState
- func (*Container) ProtoMessage()
- func (m *Container) Reset()
- func (m *Container) String() string
- type ContainerConfig
- func (*ContainerConfig) Descriptor() ([]byte, []int)
- func (m *ContainerConfig) GetAnnotations() map[string]string
- func (m *ContainerConfig) GetArgs() []string
- func (m *ContainerConfig) GetCommand() []string
- func (m *ContainerConfig) GetEnvs() []*KeyValue
- func (m *ContainerConfig) GetImage() *ImageSpec
- func (m *ContainerConfig) GetLabels() map[string]string
- func (m *ContainerConfig) GetLinux() *LinuxContainerConfig
- func (m *ContainerConfig) GetLogPath() string
- func (m *ContainerConfig) GetMetadata() *ContainerMetadata
- func (m *ContainerConfig) GetMounts() []*Mount
- func (m *ContainerConfig) GetPrivileged() bool
- func (m *ContainerConfig) GetReadonlyRootfs() bool
- func (m *ContainerConfig) GetStdin() bool
- func (m *ContainerConfig) GetStdinOnce() bool
- func (m *ContainerConfig) GetTty() bool
- func (m *ContainerConfig) GetWorkingDir() string
- func (*ContainerConfig) ProtoMessage()
- func (m *ContainerConfig) Reset()
- func (m *ContainerConfig) String() string
- type ContainerFilter
- func (*ContainerFilter) Descriptor() ([]byte, []int)
- func (m *ContainerFilter) GetId() string
- func (m *ContainerFilter) GetLabelSelector() map[string]string
- func (m *ContainerFilter) GetPodSandboxId() string
- func (m *ContainerFilter) GetState() ContainerState
- func (*ContainerFilter) ProtoMessage()
- func (m *ContainerFilter) Reset()
- func (m *ContainerFilter) String() string
- type ContainerMetadata
- type ContainerState
- type ContainerStatus
- func (*ContainerStatus) Descriptor() ([]byte, []int)
- func (m *ContainerStatus) GetAnnotations() map[string]string
- func (m *ContainerStatus) GetCreatedAt() int64
- func (m *ContainerStatus) GetExitCode() int32
- func (m *ContainerStatus) GetFinishedAt() int64
- func (m *ContainerStatus) GetId() string
- func (m *ContainerStatus) GetImage() *ImageSpec
- func (m *ContainerStatus) GetImageRef() string
- func (m *ContainerStatus) GetLabels() map[string]string
- func (m *ContainerStatus) GetMessage() string
- func (m *ContainerStatus) GetMetadata() *ContainerMetadata
- func (m *ContainerStatus) GetMounts() []*Mount
- func (m *ContainerStatus) GetReason() string
- func (m *ContainerStatus) GetStartedAt() int64
- func (m *ContainerStatus) GetState() ContainerState
- func (*ContainerStatus) ProtoMessage()
- func (m *ContainerStatus) Reset()
- func (m *ContainerStatus) String() string
- type ContainerStatusRequest
- type ContainerStatusResponse
- type CreateContainerRequest
- func (*CreateContainerRequest) Descriptor() ([]byte, []int)
- func (m *CreateContainerRequest) GetConfig() *ContainerConfig
- func (m *CreateContainerRequest) GetPodSandboxId() string
- func (m *CreateContainerRequest) GetSandboxConfig() *PodSandboxConfig
- func (*CreateContainerRequest) ProtoMessage()
- func (m *CreateContainerRequest) Reset()
- func (m *CreateContainerRequest) String() string
- type CreateContainerResponse
- type DNSConfig
- type ExecRequest
- func (*ExecRequest) Descriptor() ([]byte, []int)
- func (m *ExecRequest) GetCmd() []string
- func (m *ExecRequest) GetContainerId() string
- func (m *ExecRequest) GetStdin() bool
- func (m *ExecRequest) GetTty() bool
- func (*ExecRequest) ProtoMessage()
- func (m *ExecRequest) Reset()
- func (m *ExecRequest) String() string
- type ExecResponse
- type ExecSyncRequest
- func (*ExecSyncRequest) Descriptor() ([]byte, []int)
- func (m *ExecSyncRequest) GetCmd() []string
- func (m *ExecSyncRequest) GetContainerId() string
- func (m *ExecSyncRequest) GetTimeout() int64
- func (*ExecSyncRequest) ProtoMessage()
- func (m *ExecSyncRequest) Reset()
- func (m *ExecSyncRequest) String() string
- type ExecSyncResponse
- func (*ExecSyncResponse) Descriptor() ([]byte, []int)
- func (m *ExecSyncResponse) GetExitCode() int32
- func (m *ExecSyncResponse) GetStderr() []byte
- func (m *ExecSyncResponse) GetStdout() []byte
- func (*ExecSyncResponse) ProtoMessage()
- func (m *ExecSyncResponse) Reset()
- func (m *ExecSyncResponse) String() string
- type Image
- type ImageFilter
- type ImageServiceClient
- type ImageServiceServer
- type ImageSpec
- type ImageStatusRequest
- type ImageStatusResponse
- type KeyValue
- type LinuxContainerConfig
- func (*LinuxContainerConfig) Descriptor() ([]byte, []int)
- func (m *LinuxContainerConfig) GetCapabilities() *Capability
- func (m *LinuxContainerConfig) GetResources() *LinuxContainerResources
- func (m *LinuxContainerConfig) GetSelinuxOptions() *SELinuxOption
- func (m *LinuxContainerConfig) GetUser() *LinuxUser
- func (*LinuxContainerConfig) ProtoMessage()
- func (m *LinuxContainerConfig) Reset()
- func (m *LinuxContainerConfig) String() string
- type LinuxContainerResources
- func (*LinuxContainerResources) Descriptor() ([]byte, []int)
- func (m *LinuxContainerResources) GetCpuPeriod() int64
- func (m *LinuxContainerResources) GetCpuQuota() int64
- func (m *LinuxContainerResources) GetCpuShares() int64
- func (m *LinuxContainerResources) GetMemoryLimitInBytes() int64
- func (m *LinuxContainerResources) GetOomScoreAdj() int64
- func (*LinuxContainerResources) ProtoMessage()
- func (m *LinuxContainerResources) Reset()
- func (m *LinuxContainerResources) String() string
- type LinuxPodSandboxConfig
- func (*LinuxPodSandboxConfig) Descriptor() ([]byte, []int)
- func (m *LinuxPodSandboxConfig) GetCgroupParent() string
- func (m *LinuxPodSandboxConfig) GetNamespaceOptions() *NamespaceOption
- func (*LinuxPodSandboxConfig) ProtoMessage()
- func (m *LinuxPodSandboxConfig) Reset()
- func (m *LinuxPodSandboxConfig) String() string
- type LinuxPodSandboxStatus
- type LinuxUser
- type ListContainersRequest
- type ListContainersResponse
- type ListImagesRequest
- type ListImagesResponse
- type ListPodSandboxRequest
- type ListPodSandboxResponse
- type Mount
- type Namespace
- type NamespaceOption
- func (*NamespaceOption) Descriptor() ([]byte, []int)
- func (m *NamespaceOption) GetHostIpc() bool
- func (m *NamespaceOption) GetHostNetwork() bool
- func (m *NamespaceOption) GetHostPid() bool
- func (*NamespaceOption) ProtoMessage()
- func (m *NamespaceOption) Reset()
- func (m *NamespaceOption) String() string
- type NetworkConfig
- type PodSandBoxState
- type PodSandbox
- func (*PodSandbox) Descriptor() ([]byte, []int)
- func (m *PodSandbox) GetAnnotations() map[string]string
- func (m *PodSandbox) GetCreatedAt() int64
- func (m *PodSandbox) GetId() string
- func (m *PodSandbox) GetLabels() map[string]string
- func (m *PodSandbox) GetMetadata() *PodSandboxMetadata
- func (m *PodSandbox) GetState() PodSandBoxState
- func (*PodSandbox) ProtoMessage()
- func (m *PodSandbox) Reset()
- func (m *PodSandbox) String() string
- type PodSandboxConfig
- func (*PodSandboxConfig) Descriptor() ([]byte, []int)
- func (m *PodSandboxConfig) GetAnnotations() map[string]string
- func (m *PodSandboxConfig) GetDnsConfig() *DNSConfig
- func (m *PodSandboxConfig) GetHostname() string
- func (m *PodSandboxConfig) GetLabels() map[string]string
- func (m *PodSandboxConfig) GetLinux() *LinuxPodSandboxConfig
- func (m *PodSandboxConfig) GetLogDirectory() string
- func (m *PodSandboxConfig) GetMetadata() *PodSandboxMetadata
- func (m *PodSandboxConfig) GetPortMappings() []*PortMapping
- func (*PodSandboxConfig) ProtoMessage()
- func (m *PodSandboxConfig) Reset()
- func (m *PodSandboxConfig) String() string
- type PodSandboxFilter
- func (*PodSandboxFilter) Descriptor() ([]byte, []int)
- func (m *PodSandboxFilter) GetId() string
- func (m *PodSandboxFilter) GetLabelSelector() map[string]string
- func (m *PodSandboxFilter) GetState() PodSandBoxState
- func (*PodSandboxFilter) ProtoMessage()
- func (m *PodSandboxFilter) Reset()
- func (m *PodSandboxFilter) String() string
- type PodSandboxMetadata
- func (*PodSandboxMetadata) Descriptor() ([]byte, []int)
- func (m *PodSandboxMetadata) GetAttempt() uint32
- func (m *PodSandboxMetadata) GetName() string
- func (m *PodSandboxMetadata) GetNamespace() string
- func (m *PodSandboxMetadata) GetUid() string
- func (*PodSandboxMetadata) ProtoMessage()
- func (m *PodSandboxMetadata) Reset()
- func (m *PodSandboxMetadata) String() string
- type PodSandboxNetworkStatus
- type PodSandboxStatus
- func (*PodSandboxStatus) Descriptor() ([]byte, []int)
- func (m *PodSandboxStatus) GetAnnotations() map[string]string
- func (m *PodSandboxStatus) GetCreatedAt() int64
- func (m *PodSandboxStatus) GetId() string
- func (m *PodSandboxStatus) GetLabels() map[string]string
- func (m *PodSandboxStatus) GetLinux() *LinuxPodSandboxStatus
- func (m *PodSandboxStatus) GetMetadata() *PodSandboxMetadata
- func (m *PodSandboxStatus) GetNetwork() *PodSandboxNetworkStatus
- func (m *PodSandboxStatus) GetState() PodSandBoxState
- func (*PodSandboxStatus) ProtoMessage()
- func (m *PodSandboxStatus) Reset()
- func (m *PodSandboxStatus) String() string
- type PodSandboxStatusRequest
- type PodSandboxStatusResponse
- type PortForwardRequest
- type PortForwardResponse
- type PortMapping
- func (*PortMapping) Descriptor() ([]byte, []int)
- func (m *PortMapping) GetContainerPort() int32
- func (m *PortMapping) GetHostIp() string
- func (m *PortMapping) GetHostPort() int32
- func (m *PortMapping) GetProtocol() Protocol
- func (*PortMapping) ProtoMessage()
- func (m *PortMapping) Reset()
- func (m *PortMapping) String() string
- type Protocol
- type PullImageRequest
- func (*PullImageRequest) Descriptor() ([]byte, []int)
- func (m *PullImageRequest) GetAuth() *AuthConfig
- func (m *PullImageRequest) GetImage() *ImageSpec
- func (m *PullImageRequest) GetSandboxConfig() *PodSandboxConfig
- func (*PullImageRequest) ProtoMessage()
- func (m *PullImageRequest) Reset()
- func (m *PullImageRequest) String() string
- type PullImageResponse
- type RemoveContainerRequest
- type RemoveContainerResponse
- type RemoveImageRequest
- type RemoveImageResponse
- type RemovePodSandboxRequest
- type RemovePodSandboxResponse
- type RunPodSandboxRequest
- type RunPodSandboxResponse
- type RuntimeConfig
- type RuntimeServiceClient
- type RuntimeServiceServer
- type SELinuxOption
- func (*SELinuxOption) Descriptor() ([]byte, []int)
- func (m *SELinuxOption) GetLevel() string
- func (m *SELinuxOption) GetRole() string
- func (m *SELinuxOption) GetType() string
- func (m *SELinuxOption) GetUser() string
- func (*SELinuxOption) ProtoMessage()
- func (m *SELinuxOption) Reset()
- func (m *SELinuxOption) String() string
- type StartContainerRequest
- type StartContainerResponse
- type StopContainerRequest
- type StopContainerResponse
- type StopPodSandboxRequest
- type StopPodSandboxResponse
- type UpdateRuntimeConfigRequest
- type UpdateRuntimeConfigResponse
- type VersionRequest
- type VersionResponse
- func (*VersionResponse) Descriptor() ([]byte, []int)
- func (m *VersionResponse) GetRuntimeApiVersion() string
- func (m *VersionResponse) GetRuntimeName() string
- func (m *VersionResponse) GetRuntimeVersion() string
- func (m *VersionResponse) GetVersion() string
- func (*VersionResponse) ProtoMessage()
- func (m *VersionResponse) Reset()
- func (m *VersionResponse) String() string
Constants ¶
This section is empty.
Variables ¶
var ContainerState_name = map[int32]string{
0: "CREATED",
1: "RUNNING",
2: "EXITED",
3: "UNKNOWN",
}
var ContainerState_value = map[string]int32{
"CREATED": 0,
"RUNNING": 1,
"EXITED": 2,
"UNKNOWN": 3,
}
var PodSandBoxState_name = map[int32]string{
0: "READY",
1: "NOTREADY",
}
var PodSandBoxState_value = map[string]int32{
"READY": 0,
"NOTREADY": 1,
}
var Protocol_name = map[int32]string{
0: "TCP",
1: "UDP",
}
var Protocol_value = map[string]int32{
"TCP": 0,
"UDP": 1,
}
Functions ¶
func RegisterImageServiceServer ¶
func RegisterImageServiceServer(s *grpc.Server, srv ImageServiceServer)
func RegisterRuntimeServiceServer ¶
func RegisterRuntimeServiceServer(s *grpc.Server, srv RuntimeServiceServer)
Types ¶
type AttachRequest ¶ added in v1.5.0
type AttachRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` // Whether to stream stdin Stdin *bool `protobuf:"varint,2,opt,name=stdin" json:"stdin,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*AttachRequest) Descriptor ¶ added in v1.5.0
func (*AttachRequest) Descriptor() ([]byte, []int)
func (*AttachRequest) GetContainerId ¶ added in v1.5.0
func (m *AttachRequest) GetContainerId() string
func (*AttachRequest) GetStdin ¶ added in v1.5.0
func (m *AttachRequest) GetStdin() bool
func (*AttachRequest) ProtoMessage ¶ added in v1.5.0
func (*AttachRequest) ProtoMessage()
func (*AttachRequest) Reset ¶ added in v1.5.0
func (m *AttachRequest) Reset()
func (*AttachRequest) String ¶ added in v1.5.0
func (m *AttachRequest) String() string
type AttachResponse ¶ added in v1.5.0
type AttachResponse struct { // The fully qualified URL of the attach streaming server Url *string `protobuf:"bytes,1,opt,name=url" json:"url,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*AttachResponse) Descriptor ¶ added in v1.5.0
func (*AttachResponse) Descriptor() ([]byte, []int)
func (*AttachResponse) GetUrl ¶ added in v1.5.0
func (m *AttachResponse) GetUrl() string
func (*AttachResponse) ProtoMessage ¶ added in v1.5.0
func (*AttachResponse) ProtoMessage()
func (*AttachResponse) Reset ¶ added in v1.5.0
func (m *AttachResponse) Reset()
func (*AttachResponse) String ¶ added in v1.5.0
func (m *AttachResponse) String() string
type AuthConfig ¶
type AuthConfig struct { Username *string `protobuf:"bytes,1,opt,name=username" json:"username,omitempty"` Password *string `protobuf:"bytes,2,opt,name=password" json:"password,omitempty"` Auth *string `protobuf:"bytes,3,opt,name=auth" json:"auth,omitempty"` ServerAddress *string `protobuf:"bytes,4,opt,name=server_address,json=serverAddress" json:"server_address,omitempty"` // IdentityToken is used to authenticate the user and get // an access token for the registry. IdentityToken *string `protobuf:"bytes,5,opt,name=identity_token,json=identityToken" json:"identity_token,omitempty"` // RegistryToken is a bearer token to be sent to a registry RegistryToken *string `protobuf:"bytes,6,opt,name=registry_token,json=registryToken" json:"registry_token,omitempty"` XXX_unrecognized []byte `json:"-"` }
AuthConfig contains authorization information for connecting to a registry.
func (*AuthConfig) Descriptor ¶
func (*AuthConfig) Descriptor() ([]byte, []int)
func (*AuthConfig) GetAuth ¶
func (m *AuthConfig) GetAuth() string
func (*AuthConfig) GetIdentityToken ¶
func (m *AuthConfig) GetIdentityToken() string
func (*AuthConfig) GetPassword ¶
func (m *AuthConfig) GetPassword() string
func (*AuthConfig) GetRegistryToken ¶
func (m *AuthConfig) GetRegistryToken() string
func (*AuthConfig) GetServerAddress ¶
func (m *AuthConfig) GetServerAddress() string
func (*AuthConfig) GetUsername ¶
func (m *AuthConfig) GetUsername() string
func (*AuthConfig) ProtoMessage ¶
func (*AuthConfig) ProtoMessage()
func (*AuthConfig) Reset ¶
func (m *AuthConfig) Reset()
func (*AuthConfig) String ¶
func (m *AuthConfig) String() string
type Capability ¶
type Capability struct { // List of capabilities to add. AddCapabilities []string `protobuf:"bytes,1,rep,name=add_capabilities,json=addCapabilities" json:"add_capabilities,omitempty"` // List of capabilities to drop. DropCapabilities []string `protobuf:"bytes,2,rep,name=drop_capabilities,json=dropCapabilities" json:"drop_capabilities,omitempty"` XXX_unrecognized []byte `json:"-"` }
Capability contains the container capabilities to add or drop
func (*Capability) Descriptor ¶
func (*Capability) Descriptor() ([]byte, []int)
func (*Capability) GetAddCapabilities ¶
func (m *Capability) GetAddCapabilities() []string
func (*Capability) GetDropCapabilities ¶
func (m *Capability) GetDropCapabilities() []string
func (*Capability) ProtoMessage ¶
func (*Capability) ProtoMessage()
func (*Capability) Reset ¶
func (m *Capability) Reset()
func (*Capability) String ¶
func (m *Capability) String() string
type Container ¶
type Container struct { // The ID of the container, used by the container runtime to identify // a container. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // The id of the sandbox which this container belongs to. PodSandboxId *string `protobuf:"bytes,2,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` // The metadata of the container. Metadata *ContainerMetadata `protobuf:"bytes,3,opt,name=metadata" json:"metadata,omitempty"` // The spec of the image Image *ImageSpec `protobuf:"bytes,4,opt,name=image" json:"image,omitempty"` // Reference to the image in use. For most runtimes, this should be an // image ID. ImageRef *string `protobuf:"bytes,5,opt,name=image_ref,json=imageRef" json:"image_ref,omitempty"` // State is the state of the container. State *ContainerState `protobuf:"varint,6,opt,name=state,enum=runtime.ContainerState" json:"state,omitempty"` // Creation time of the container in nanoseconds. CreatedAt *int64 `protobuf:"varint,7,opt,name=created_at,json=createdAt" json:"created_at,omitempty"` // Labels are key value pairs that may be used to scope and select individual resources. Labels map[string]string `` /* 132-byte string literal not displayed */ // Annotations is an unstructured key value map that may be set by external // tools to store and retrieve arbitrary metadata. Annotations map[string]string `` /* 142-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
Container provides the runtime information for a container, such as ID, hash, state of the container.
func (*Container) Descriptor ¶
func (*Container) GetAnnotations ¶
func (*Container) GetCreatedAt ¶ added in v1.5.0
func (*Container) GetImageRef ¶
func (*Container) GetMetadata ¶
func (m *Container) GetMetadata() *ContainerMetadata
func (*Container) GetPodSandboxId ¶ added in v1.5.0
func (*Container) GetState ¶
func (m *Container) GetState() ContainerState
func (*Container) ProtoMessage ¶
func (*Container) ProtoMessage()
type ContainerConfig ¶
type ContainerConfig struct { // The metadata of the container. This information will uniquely identify // the container, and the runtime should leverage this to ensure correct // operation. The runtime may also use this information to improve UX, such // as by constructing a readable name. Metadata *ContainerMetadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // Image to use. Image *ImageSpec `protobuf:"bytes,2,opt,name=image" json:"image,omitempty"` // Command to execute (i.e., entrypoint for docker) Command []string `protobuf:"bytes,3,rep,name=command" json:"command,omitempty"` // Args for the Command (i.e., command for docker) Args []string `protobuf:"bytes,4,rep,name=args" json:"args,omitempty"` // Current working directory of the command. WorkingDir *string `protobuf:"bytes,5,opt,name=working_dir,json=workingDir" json:"working_dir,omitempty"` // List of environment variable to set in the container Envs []*KeyValue `protobuf:"bytes,6,rep,name=envs" json:"envs,omitempty"` // Mounts specifies mounts for the container Mounts []*Mount `protobuf:"bytes,7,rep,name=mounts" json:"mounts,omitempty"` // Labels are key value pairs that may be used to scope and select individual resources. // Label keys are of the form: // label-key ::= prefixed-name | name // prefixed-name ::= prefix '/' name // prefix ::= DNS_SUBDOMAIN // name ::= DNS_LABEL Labels map[string]string `` /* 132-byte string literal not displayed */ // Annotations is an unstructured key value map that may be set by external // tools to store and retrieve arbitrary metadata. Annotations map[string]string `` /* 142-byte string literal not displayed */ // If set, run container in privileged mode. // Processes in privileged containers are essentially equivalent to root on the host. Privileged *bool `protobuf:"varint,10,opt,name=privileged" json:"privileged,omitempty"` // If set, the root filesystem of the container is read-only. ReadonlyRootfs *bool `protobuf:"varint,11,opt,name=readonly_rootfs,json=readonlyRootfs" json:"readonly_rootfs,omitempty"` // Path relative to PodSandboxConfig.LogDirectory for container to store // the log (STDOUT and STDERR) on the host. // E.g., // PodSandboxConfig.LogDirectory = `/var/log/pods/<podUID>/` // ContainerConfig.LogPath = `containerName_Instance#.log` // // WARNING: Log management and how kubelet should interface with the // container logs are under active discussion in // https://issues.k8s.io/24677. There *may* be future change of direction // for logging as the discussion carries on. LogPath *string `protobuf:"bytes,12,opt,name=log_path,json=logPath" json:"log_path,omitempty"` // Variables for interactive containers, these have very specialized // use-cases (e.g. debugging). // TODO: Determine if we need to continue supporting these fields that are // part of Kubernetes's Container Spec. Stdin *bool `protobuf:"varint,13,opt,name=stdin" json:"stdin,omitempty"` StdinOnce *bool `protobuf:"varint,14,opt,name=stdin_once,json=stdinOnce" json:"stdin_once,omitempty"` Tty *bool `protobuf:"varint,15,opt,name=tty" json:"tty,omitempty"` // Linux contains configuration specific to Linux containers. Linux *LinuxContainerConfig `protobuf:"bytes,16,opt,name=linux" json:"linux,omitempty"` XXX_unrecognized []byte `json:"-"` }
ContainerConfig holds all the required and optional fields for creating a container.
func (*ContainerConfig) Descriptor ¶
func (*ContainerConfig) Descriptor() ([]byte, []int)
func (*ContainerConfig) GetAnnotations ¶
func (m *ContainerConfig) GetAnnotations() map[string]string
func (*ContainerConfig) GetArgs ¶
func (m *ContainerConfig) GetArgs() []string
func (*ContainerConfig) GetCommand ¶
func (m *ContainerConfig) GetCommand() []string
func (*ContainerConfig) GetEnvs ¶
func (m *ContainerConfig) GetEnvs() []*KeyValue
func (*ContainerConfig) GetImage ¶
func (m *ContainerConfig) GetImage() *ImageSpec
func (*ContainerConfig) GetLabels ¶
func (m *ContainerConfig) GetLabels() map[string]string
func (*ContainerConfig) GetLinux ¶
func (m *ContainerConfig) GetLinux() *LinuxContainerConfig
func (*ContainerConfig) GetLogPath ¶
func (m *ContainerConfig) GetLogPath() string
func (*ContainerConfig) GetMetadata ¶
func (m *ContainerConfig) GetMetadata() *ContainerMetadata
func (*ContainerConfig) GetMounts ¶
func (m *ContainerConfig) GetMounts() []*Mount
func (*ContainerConfig) GetPrivileged ¶
func (m *ContainerConfig) GetPrivileged() bool
func (*ContainerConfig) GetReadonlyRootfs ¶
func (m *ContainerConfig) GetReadonlyRootfs() bool
func (*ContainerConfig) GetStdin ¶
func (m *ContainerConfig) GetStdin() bool
func (*ContainerConfig) GetStdinOnce ¶
func (m *ContainerConfig) GetStdinOnce() bool
func (*ContainerConfig) GetTty ¶
func (m *ContainerConfig) GetTty() bool
func (*ContainerConfig) GetWorkingDir ¶
func (m *ContainerConfig) GetWorkingDir() string
func (*ContainerConfig) ProtoMessage ¶
func (*ContainerConfig) ProtoMessage()
func (*ContainerConfig) Reset ¶
func (m *ContainerConfig) Reset()
func (*ContainerConfig) String ¶
func (m *ContainerConfig) String() string
type ContainerFilter ¶
type ContainerFilter struct { // ID of the container. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // State of the container. State *ContainerState `protobuf:"varint,2,opt,name=state,enum=runtime.ContainerState" json:"state,omitempty"` // The id of the pod sandbox PodSandboxId *string `protobuf:"bytes,3,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` // LabelSelector to select matches. // Only api.MatchLabels is supported for now and the requirements // are ANDed. MatchExpressions is not supported yet. LabelSelector map[string]string `` /* 167-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
ContainerFilter is used to filter containers. All those fields are combined with 'AND'
func (*ContainerFilter) Descriptor ¶
func (*ContainerFilter) Descriptor() ([]byte, []int)
func (*ContainerFilter) GetId ¶
func (m *ContainerFilter) GetId() string
func (*ContainerFilter) GetLabelSelector ¶
func (m *ContainerFilter) GetLabelSelector() map[string]string
func (*ContainerFilter) GetPodSandboxId ¶
func (m *ContainerFilter) GetPodSandboxId() string
func (*ContainerFilter) GetState ¶
func (m *ContainerFilter) GetState() ContainerState
func (*ContainerFilter) ProtoMessage ¶
func (*ContainerFilter) ProtoMessage()
func (*ContainerFilter) Reset ¶
func (m *ContainerFilter) Reset()
func (*ContainerFilter) String ¶
func (m *ContainerFilter) String() string
type ContainerMetadata ¶
type ContainerMetadata struct { // The name of the container. Same as the container name in the PodSpec. Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The attempt number of creating the container. Attempt *uint32 `protobuf:"varint,2,opt,name=attempt" json:"attempt,omitempty"` XXX_unrecognized []byte `json:"-"` }
ContainerMetadata holds all necessary information for building the container name. The container runtime is encouraged to expose the metadata in its user interface for better user experience. E.g., runtime can construct a unique container name based on the metadata. Note that (name, attempt) is unique within a sandbox for the entire lifetime of the sandbox.
func (*ContainerMetadata) Descriptor ¶
func (*ContainerMetadata) Descriptor() ([]byte, []int)
func (*ContainerMetadata) GetAttempt ¶
func (m *ContainerMetadata) GetAttempt() uint32
func (*ContainerMetadata) GetName ¶
func (m *ContainerMetadata) GetName() string
func (*ContainerMetadata) ProtoMessage ¶
func (*ContainerMetadata) ProtoMessage()
func (*ContainerMetadata) Reset ¶
func (m *ContainerMetadata) Reset()
func (*ContainerMetadata) String ¶
func (m *ContainerMetadata) String() string
type ContainerState ¶
type ContainerState int32
const ( ContainerState_CREATED ContainerState = 0 ContainerState_RUNNING ContainerState = 1 ContainerState_EXITED ContainerState = 2 ContainerState_UNKNOWN ContainerState = 3 )
func (ContainerState) Enum ¶
func (x ContainerState) Enum() *ContainerState
func (ContainerState) EnumDescriptor ¶
func (ContainerState) EnumDescriptor() ([]byte, []int)
func (ContainerState) String ¶
func (x ContainerState) String() string
func (*ContainerState) UnmarshalJSON ¶
func (x *ContainerState) UnmarshalJSON(data []byte) error
type ContainerStatus ¶
type ContainerStatus struct { // ID of the container. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Metadata of the container. Metadata *ContainerMetadata `protobuf:"bytes,2,opt,name=metadata" json:"metadata,omitempty"` // Status of the container. State *ContainerState `protobuf:"varint,3,opt,name=state,enum=runtime.ContainerState" json:"state,omitempty"` // Creation time of the container in nanoseconds. CreatedAt *int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt" json:"created_at,omitempty"` // Start time of the container in nanoseconds. StartedAt *int64 `protobuf:"varint,5,opt,name=started_at,json=startedAt" json:"started_at,omitempty"` // Finish time of the container in nanoseconds. FinishedAt *int64 `protobuf:"varint,6,opt,name=finished_at,json=finishedAt" json:"finished_at,omitempty"` // Exit code of the container. ExitCode *int32 `protobuf:"varint,7,opt,name=exit_code,json=exitCode" json:"exit_code,omitempty"` // The spec of the image Image *ImageSpec `protobuf:"bytes,8,opt,name=image" json:"image,omitempty"` // Reference to the image in use. For most runtimes, this should be an // image ID ImageRef *string `protobuf:"bytes,9,opt,name=image_ref,json=imageRef" json:"image_ref,omitempty"` // A brief CamelCase string explains why container is in such a status. Reason *string `protobuf:"bytes,10,opt,name=reason" json:"reason,omitempty"` // A human-readable message indication details about why container is in // this state. Message *string `protobuf:"bytes,11,opt,name=message" json:"message,omitempty"` // Labels are key value pairs that may be used to scope and select individual resources. Labels map[string]string `` /* 133-byte string literal not displayed */ // Annotations is an unstructured key value map. Annotations map[string]string `` /* 143-byte string literal not displayed */ // Mounts specifies mounts for the container Mounts []*Mount `protobuf:"bytes,14,rep,name=mounts" json:"mounts,omitempty"` XXX_unrecognized []byte `json:"-"` }
ContainerStatus represents the status of a container.
func (*ContainerStatus) Descriptor ¶
func (*ContainerStatus) Descriptor() ([]byte, []int)
func (*ContainerStatus) GetAnnotations ¶
func (m *ContainerStatus) GetAnnotations() map[string]string
func (*ContainerStatus) GetCreatedAt ¶
func (m *ContainerStatus) GetCreatedAt() int64
func (*ContainerStatus) GetExitCode ¶
func (m *ContainerStatus) GetExitCode() int32
func (*ContainerStatus) GetFinishedAt ¶
func (m *ContainerStatus) GetFinishedAt() int64
func (*ContainerStatus) GetId ¶
func (m *ContainerStatus) GetId() string
func (*ContainerStatus) GetImage ¶
func (m *ContainerStatus) GetImage() *ImageSpec
func (*ContainerStatus) GetImageRef ¶
func (m *ContainerStatus) GetImageRef() string
func (*ContainerStatus) GetLabels ¶
func (m *ContainerStatus) GetLabels() map[string]string
func (*ContainerStatus) GetMessage ¶ added in v1.5.0
func (m *ContainerStatus) GetMessage() string
func (*ContainerStatus) GetMetadata ¶
func (m *ContainerStatus) GetMetadata() *ContainerMetadata
func (*ContainerStatus) GetMounts ¶
func (m *ContainerStatus) GetMounts() []*Mount
func (*ContainerStatus) GetReason ¶
func (m *ContainerStatus) GetReason() string
func (*ContainerStatus) GetStartedAt ¶
func (m *ContainerStatus) GetStartedAt() int64
func (*ContainerStatus) GetState ¶
func (m *ContainerStatus) GetState() ContainerState
func (*ContainerStatus) ProtoMessage ¶
func (*ContainerStatus) ProtoMessage()
func (*ContainerStatus) Reset ¶
func (m *ContainerStatus) Reset()
func (*ContainerStatus) String ¶
func (m *ContainerStatus) String() string
type ContainerStatusRequest ¶
type ContainerStatusRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ContainerStatusRequest) Descriptor ¶
func (*ContainerStatusRequest) Descriptor() ([]byte, []int)
func (*ContainerStatusRequest) GetContainerId ¶
func (m *ContainerStatusRequest) GetContainerId() string
func (*ContainerStatusRequest) ProtoMessage ¶
func (*ContainerStatusRequest) ProtoMessage()
func (*ContainerStatusRequest) Reset ¶
func (m *ContainerStatusRequest) Reset()
func (*ContainerStatusRequest) String ¶
func (m *ContainerStatusRequest) String() string
type ContainerStatusResponse ¶
type ContainerStatusResponse struct { // The status of the container Status *ContainerStatus `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ContainerStatusResponse) Descriptor ¶
func (*ContainerStatusResponse) Descriptor() ([]byte, []int)
func (*ContainerStatusResponse) GetStatus ¶
func (m *ContainerStatusResponse) GetStatus() *ContainerStatus
func (*ContainerStatusResponse) ProtoMessage ¶
func (*ContainerStatusResponse) ProtoMessage()
func (*ContainerStatusResponse) Reset ¶
func (m *ContainerStatusResponse) Reset()
func (*ContainerStatusResponse) String ¶
func (m *ContainerStatusResponse) String() string
type CreateContainerRequest ¶
type CreateContainerRequest struct { // The id of the PodSandbox PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` // The config of the container Config *ContainerConfig `protobuf:"bytes,2,opt,name=config" json:"config,omitempty"` // The config of the PodSandbox. This is the same config that was passed // to RunPodSandboxRequest to create the PodSandbox. It is passed again // here just for easy reference. The PodSandboxConfig is immutable and // remains the same throughout the lifetime of the pod. SandboxConfig *PodSandboxConfig `protobuf:"bytes,3,opt,name=sandbox_config,json=sandboxConfig" json:"sandbox_config,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*CreateContainerRequest) Descriptor ¶
func (*CreateContainerRequest) Descriptor() ([]byte, []int)
func (*CreateContainerRequest) GetConfig ¶
func (m *CreateContainerRequest) GetConfig() *ContainerConfig
func (*CreateContainerRequest) GetPodSandboxId ¶
func (m *CreateContainerRequest) GetPodSandboxId() string
func (*CreateContainerRequest) GetSandboxConfig ¶
func (m *CreateContainerRequest) GetSandboxConfig() *PodSandboxConfig
func (*CreateContainerRequest) ProtoMessage ¶
func (*CreateContainerRequest) ProtoMessage()
func (*CreateContainerRequest) Reset ¶
func (m *CreateContainerRequest) Reset()
func (*CreateContainerRequest) String ¶
func (m *CreateContainerRequest) String() string
type CreateContainerResponse ¶
type CreateContainerResponse struct { // The id of the created container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*CreateContainerResponse) Descriptor ¶
func (*CreateContainerResponse) Descriptor() ([]byte, []int)
func (*CreateContainerResponse) GetContainerId ¶
func (m *CreateContainerResponse) GetContainerId() string
func (*CreateContainerResponse) ProtoMessage ¶
func (*CreateContainerResponse) ProtoMessage()
func (*CreateContainerResponse) Reset ¶
func (m *CreateContainerResponse) Reset()
func (*CreateContainerResponse) String ¶
func (m *CreateContainerResponse) String() string
type DNSConfig ¶ added in v1.5.0
type DNSConfig struct { // List of DNS servers of the cluster. Servers []string `protobuf:"bytes,1,rep,name=servers" json:"servers,omitempty"` // List of DNS search domains of the cluster. Searches []string `protobuf:"bytes,2,rep,name=searches" json:"searches,omitempty"` // List of DNS options. See https://linux.die.net/man/5/resolv.conf // for all available options. Options []string `protobuf:"bytes,3,rep,name=options" json:"options,omitempty"` XXX_unrecognized []byte `json:"-"` }
DNSConfig specifies the DNS servers and search domains of a sandbox.
func (*DNSConfig) Descriptor ¶ added in v1.5.0
func (*DNSConfig) GetOptions ¶ added in v1.5.0
func (*DNSConfig) GetSearches ¶ added in v1.5.0
func (*DNSConfig) GetServers ¶ added in v1.5.0
func (*DNSConfig) ProtoMessage ¶ added in v1.5.0
func (*DNSConfig) ProtoMessage()
type ExecRequest ¶
type ExecRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` // The cmd to execute Cmd []string `protobuf:"bytes,2,rep,name=cmd" json:"cmd,omitempty"` // Whether use tty Tty *bool `protobuf:"varint,3,opt,name=tty" json:"tty,omitempty"` // Whether to stream stdin Stdin *bool `protobuf:"varint,4,opt,name=stdin" json:"stdin,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ExecRequest) Descriptor ¶
func (*ExecRequest) Descriptor() ([]byte, []int)
func (*ExecRequest) GetCmd ¶
func (m *ExecRequest) GetCmd() []string
func (*ExecRequest) GetContainerId ¶
func (m *ExecRequest) GetContainerId() string
func (*ExecRequest) GetStdin ¶
func (m *ExecRequest) GetStdin() bool
func (*ExecRequest) GetTty ¶
func (m *ExecRequest) GetTty() bool
func (*ExecRequest) ProtoMessage ¶
func (*ExecRequest) ProtoMessage()
func (*ExecRequest) Reset ¶
func (m *ExecRequest) Reset()
func (*ExecRequest) String ¶
func (m *ExecRequest) String() string
type ExecResponse ¶
type ExecResponse struct { // The fully qualified URL of the exec streaming server Url *string `protobuf:"bytes,1,opt,name=url" json:"url,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ExecResponse) Descriptor ¶
func (*ExecResponse) Descriptor() ([]byte, []int)
func (*ExecResponse) GetUrl ¶ added in v1.5.0
func (m *ExecResponse) GetUrl() string
func (*ExecResponse) ProtoMessage ¶
func (*ExecResponse) ProtoMessage()
func (*ExecResponse) Reset ¶
func (m *ExecResponse) Reset()
func (*ExecResponse) String ¶
func (m *ExecResponse) String() string
type ExecSyncRequest ¶ added in v1.5.0
type ExecSyncRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` // The cmd to execute Cmd []string `protobuf:"bytes,2,rep,name=cmd" json:"cmd,omitempty"` // Timeout in seconds to stop the command. Default: run forever. Timeout *int64 `protobuf:"varint,3,opt,name=timeout" json:"timeout,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ExecSyncRequest) Descriptor ¶ added in v1.5.0
func (*ExecSyncRequest) Descriptor() ([]byte, []int)
func (*ExecSyncRequest) GetCmd ¶ added in v1.5.0
func (m *ExecSyncRequest) GetCmd() []string
func (*ExecSyncRequest) GetContainerId ¶ added in v1.5.0
func (m *ExecSyncRequest) GetContainerId() string
func (*ExecSyncRequest) GetTimeout ¶ added in v1.5.0
func (m *ExecSyncRequest) GetTimeout() int64
func (*ExecSyncRequest) ProtoMessage ¶ added in v1.5.0
func (*ExecSyncRequest) ProtoMessage()
func (*ExecSyncRequest) Reset ¶ added in v1.5.0
func (m *ExecSyncRequest) Reset()
func (*ExecSyncRequest) String ¶ added in v1.5.0
func (m *ExecSyncRequest) String() string
type ExecSyncResponse ¶ added in v1.5.0
type ExecSyncResponse struct { // The captured command stdout output. Stdout []byte `protobuf:"bytes,1,opt,name=stdout" json:"stdout,omitempty"` // The captured command stderr output. Stderr []byte `protobuf:"bytes,2,opt,name=stderr" json:"stderr,omitempty"` // The exit code the command finished with. ExitCode *int32 `protobuf:"varint,3,opt,name=exit_code,json=exitCode" json:"exit_code,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ExecSyncResponse) Descriptor ¶ added in v1.5.0
func (*ExecSyncResponse) Descriptor() ([]byte, []int)
func (*ExecSyncResponse) GetExitCode ¶ added in v1.5.0
func (m *ExecSyncResponse) GetExitCode() int32
func (*ExecSyncResponse) GetStderr ¶ added in v1.5.0
func (m *ExecSyncResponse) GetStderr() []byte
func (*ExecSyncResponse) GetStdout ¶ added in v1.5.0
func (m *ExecSyncResponse) GetStdout() []byte
func (*ExecSyncResponse) ProtoMessage ¶ added in v1.5.0
func (*ExecSyncResponse) ProtoMessage()
func (*ExecSyncResponse) Reset ¶ added in v1.5.0
func (m *ExecSyncResponse) Reset()
func (*ExecSyncResponse) String ¶ added in v1.5.0
func (m *ExecSyncResponse) String() string
type Image ¶
type Image struct { // ID of the image. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Other names by which this image is known. RepoTags []string `protobuf:"bytes,2,rep,name=repo_tags,json=repoTags" json:"repo_tags,omitempty"` // Digests by which this image is known. RepoDigests []string `protobuf:"bytes,3,rep,name=repo_digests,json=repoDigests" json:"repo_digests,omitempty"` // The size of the image in bytes. Size_ *uint64 `protobuf:"varint,4,opt,name=size" json:"size,omitempty"` XXX_unrecognized []byte `json:"-"` }
Basic information about a container image.
func (*Image) Descriptor ¶
func (*Image) GetRepoDigests ¶
func (*Image) GetRepoTags ¶
func (*Image) ProtoMessage ¶
func (*Image) ProtoMessage()
type ImageFilter ¶
type ImageFilter struct { // The spec of the image Image *ImageSpec `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ImageFilter) Descriptor ¶
func (*ImageFilter) Descriptor() ([]byte, []int)
func (*ImageFilter) GetImage ¶
func (m *ImageFilter) GetImage() *ImageSpec
func (*ImageFilter) ProtoMessage ¶
func (*ImageFilter) ProtoMessage()
func (*ImageFilter) Reset ¶
func (m *ImageFilter) Reset()
func (*ImageFilter) String ¶
func (m *ImageFilter) String() string
type ImageServiceClient ¶
type ImageServiceClient interface { // ListImages lists existing images. ListImages(ctx context.Context, in *ListImagesRequest, opts ...grpc.CallOption) (*ListImagesResponse, error) // ImageStatus returns the status of the image. If the image is not // present, returns nil. ImageStatus(ctx context.Context, in *ImageStatusRequest, opts ...grpc.CallOption) (*ImageStatusResponse, error) // PullImage pulls an image with authentication config. PullImage(ctx context.Context, in *PullImageRequest, opts ...grpc.CallOption) (*PullImageResponse, error) // RemoveImage removes the image. // It should return success if the image has already been removed. RemoveImage(ctx context.Context, in *RemoveImageRequest, opts ...grpc.CallOption) (*RemoveImageResponse, error) }
func NewImageServiceClient ¶
func NewImageServiceClient(cc *grpc.ClientConn) ImageServiceClient
type ImageServiceServer ¶
type ImageServiceServer interface { // ListImages lists existing images. ListImages(context.Context, *ListImagesRequest) (*ListImagesResponse, error) // ImageStatus returns the status of the image. If the image is not // present, returns nil. ImageStatus(context.Context, *ImageStatusRequest) (*ImageStatusResponse, error) // PullImage pulls an image with authentication config. PullImage(context.Context, *PullImageRequest) (*PullImageResponse, error) // RemoveImage removes the image. // It should return success if the image has already been removed. RemoveImage(context.Context, *RemoveImageRequest) (*RemoveImageResponse, error) }
type ImageSpec ¶
type ImageSpec struct { Image *string `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` XXX_unrecognized []byte `json:"-"` }
ImageSpec is an internal representation of an image. Currently, it wraps the value of a Container's Image field (e.g. imageName, imageName:tag, or imageName:digest), but in the future it will include more detailed information about the different image types.
func (*ImageSpec) Descriptor ¶
func (*ImageSpec) ProtoMessage ¶
func (*ImageSpec) ProtoMessage()
type ImageStatusRequest ¶
type ImageStatusRequest struct { // The spec of the image Image *ImageSpec `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ImageStatusRequest) Descriptor ¶
func (*ImageStatusRequest) Descriptor() ([]byte, []int)
func (*ImageStatusRequest) GetImage ¶
func (m *ImageStatusRequest) GetImage() *ImageSpec
func (*ImageStatusRequest) ProtoMessage ¶
func (*ImageStatusRequest) ProtoMessage()
func (*ImageStatusRequest) Reset ¶
func (m *ImageStatusRequest) Reset()
func (*ImageStatusRequest) String ¶
func (m *ImageStatusRequest) String() string
type ImageStatusResponse ¶
type ImageStatusResponse struct { // The status of the image Image *Image `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ImageStatusResponse) Descriptor ¶
func (*ImageStatusResponse) Descriptor() ([]byte, []int)
func (*ImageStatusResponse) GetImage ¶
func (m *ImageStatusResponse) GetImage() *Image
func (*ImageStatusResponse) ProtoMessage ¶
func (*ImageStatusResponse) ProtoMessage()
func (*ImageStatusResponse) Reset ¶
func (m *ImageStatusResponse) Reset()
func (*ImageStatusResponse) String ¶
func (m *ImageStatusResponse) String() string
type KeyValue ¶
type KeyValue struct { Key *string `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"` Value *string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*KeyValue) Descriptor ¶
func (*KeyValue) ProtoMessage ¶
func (*KeyValue) ProtoMessage()
type LinuxContainerConfig ¶
type LinuxContainerConfig struct { // Resources specification for the container. Resources *LinuxContainerResources `protobuf:"bytes,1,opt,name=resources" json:"resources,omitempty"` // Capabilities to add or drop. Capabilities *Capability `protobuf:"bytes,2,opt,name=capabilities" json:"capabilities,omitempty"` // Optional SELinux context to be applied. SelinuxOptions *SELinuxOption `protobuf:"bytes,3,opt,name=selinux_options,json=selinuxOptions" json:"selinux_options,omitempty"` // User contains the user for the container process. User *LinuxUser `protobuf:"bytes,4,opt,name=user" json:"user,omitempty"` XXX_unrecognized []byte `json:"-"` }
LinuxContainerConfig contains platform-specific configuration for Linux-based containers.
func (*LinuxContainerConfig) Descriptor ¶
func (*LinuxContainerConfig) Descriptor() ([]byte, []int)
func (*LinuxContainerConfig) GetCapabilities ¶
func (m *LinuxContainerConfig) GetCapabilities() *Capability
func (*LinuxContainerConfig) GetResources ¶
func (m *LinuxContainerConfig) GetResources() *LinuxContainerResources
func (*LinuxContainerConfig) GetSelinuxOptions ¶
func (m *LinuxContainerConfig) GetSelinuxOptions() *SELinuxOption
func (*LinuxContainerConfig) GetUser ¶
func (m *LinuxContainerConfig) GetUser() *LinuxUser
func (*LinuxContainerConfig) ProtoMessage ¶
func (*LinuxContainerConfig) ProtoMessage()
func (*LinuxContainerConfig) Reset ¶
func (m *LinuxContainerConfig) Reset()
func (*LinuxContainerConfig) String ¶
func (m *LinuxContainerConfig) String() string
type LinuxContainerResources ¶
type LinuxContainerResources struct { // CPU CFS (Completely Fair Scheduler) period CpuPeriod *int64 `protobuf:"varint,1,opt,name=cpu_period,json=cpuPeriod" json:"cpu_period,omitempty"` // CPU CFS (Completely Fair Scheduler) quota CpuQuota *int64 `protobuf:"varint,2,opt,name=cpu_quota,json=cpuQuota" json:"cpu_quota,omitempty"` CpuShares *int64 `protobuf:"varint,3,opt,name=cpu_shares,json=cpuShares" json:"cpu_shares,omitempty"` // Memory limit in bytes MemoryLimitInBytes *int64 `protobuf:"varint,4,opt,name=memory_limit_in_bytes,json=memoryLimitInBytes" json:"memory_limit_in_bytes,omitempty"` // OOMScoreAdj adjusts the oom-killer score. OomScoreAdj *int64 `protobuf:"varint,5,opt,name=oom_score_adj,json=oomScoreAdj" json:"oom_score_adj,omitempty"` XXX_unrecognized []byte `json:"-"` }
LinuxContainerResources specifies Linux specific configuration for resources. TODO: Consider using Resources from opencontainers/runtime-spec/specs-go directly.
func (*LinuxContainerResources) Descriptor ¶
func (*LinuxContainerResources) Descriptor() ([]byte, []int)
func (*LinuxContainerResources) GetCpuPeriod ¶
func (m *LinuxContainerResources) GetCpuPeriod() int64
func (*LinuxContainerResources) GetCpuQuota ¶
func (m *LinuxContainerResources) GetCpuQuota() int64
func (*LinuxContainerResources) GetCpuShares ¶
func (m *LinuxContainerResources) GetCpuShares() int64
func (*LinuxContainerResources) GetMemoryLimitInBytes ¶
func (m *LinuxContainerResources) GetMemoryLimitInBytes() int64
func (*LinuxContainerResources) GetOomScoreAdj ¶
func (m *LinuxContainerResources) GetOomScoreAdj() int64
func (*LinuxContainerResources) ProtoMessage ¶
func (*LinuxContainerResources) ProtoMessage()
func (*LinuxContainerResources) Reset ¶
func (m *LinuxContainerResources) Reset()
func (*LinuxContainerResources) String ¶
func (m *LinuxContainerResources) String() string
type LinuxPodSandboxConfig ¶
type LinuxPodSandboxConfig struct { // The parent cgroup of the pod sandbox. // The cgroupfs style syntax will be used, but the container runtime can // convert it to systemd semantics if needed. CgroupParent *string `protobuf:"bytes,1,opt,name=cgroup_parent,json=cgroupParent" json:"cgroup_parent,omitempty"` // The configurations for the sandbox's namespaces. // This will be used only if the PodSandbox uses namespace for isolation. NamespaceOptions *NamespaceOption `protobuf:"bytes,2,opt,name=namespace_options,json=namespaceOptions" json:"namespace_options,omitempty"` XXX_unrecognized []byte `json:"-"` }
LinuxPodSandboxConfig holds platform-specific configurations for Linux host platforms and Linux-based containers.
func (*LinuxPodSandboxConfig) Descriptor ¶
func (*LinuxPodSandboxConfig) Descriptor() ([]byte, []int)
func (*LinuxPodSandboxConfig) GetCgroupParent ¶
func (m *LinuxPodSandboxConfig) GetCgroupParent() string
func (*LinuxPodSandboxConfig) GetNamespaceOptions ¶
func (m *LinuxPodSandboxConfig) GetNamespaceOptions() *NamespaceOption
func (*LinuxPodSandboxConfig) ProtoMessage ¶
func (*LinuxPodSandboxConfig) ProtoMessage()
func (*LinuxPodSandboxConfig) Reset ¶
func (m *LinuxPodSandboxConfig) Reset()
func (*LinuxPodSandboxConfig) String ¶
func (m *LinuxPodSandboxConfig) String() string
type LinuxPodSandboxStatus ¶
type LinuxPodSandboxStatus struct { // Namespaces contains paths to the sandbox's namespaces. Namespaces *Namespace `protobuf:"bytes,1,opt,name=namespaces" json:"namespaces,omitempty"` XXX_unrecognized []byte `json:"-"` }
LinuxSandBoxStatus contains status specific to Linux sandboxes.
func (*LinuxPodSandboxStatus) Descriptor ¶
func (*LinuxPodSandboxStatus) Descriptor() ([]byte, []int)
func (*LinuxPodSandboxStatus) GetNamespaces ¶
func (m *LinuxPodSandboxStatus) GetNamespaces() *Namespace
func (*LinuxPodSandboxStatus) ProtoMessage ¶
func (*LinuxPodSandboxStatus) ProtoMessage()
func (*LinuxPodSandboxStatus) Reset ¶
func (m *LinuxPodSandboxStatus) Reset()
func (*LinuxPodSandboxStatus) String ¶
func (m *LinuxPodSandboxStatus) String() string
type LinuxUser ¶
type LinuxUser struct { // uid specifies the user ID the container process has. Uid *int64 `protobuf:"varint,1,opt,name=uid" json:"uid,omitempty"` // gid specifies the group ID the container process has. Gid *int64 `protobuf:"varint,2,opt,name=gid" json:"gid,omitempty"` // additional_gids specifies additional GIDs the container process has. AdditionalGids []int64 `protobuf:"varint,3,rep,name=additional_gids,json=additionalGids" json:"additional_gids,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*LinuxUser) Descriptor ¶
func (*LinuxUser) GetAdditionalGids ¶
func (*LinuxUser) ProtoMessage ¶
func (*LinuxUser) ProtoMessage()
type ListContainersRequest ¶
type ListContainersRequest struct { Filter *ContainerFilter `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ListContainersRequest) Descriptor ¶
func (*ListContainersRequest) Descriptor() ([]byte, []int)
func (*ListContainersRequest) GetFilter ¶
func (m *ListContainersRequest) GetFilter() *ContainerFilter
func (*ListContainersRequest) ProtoMessage ¶
func (*ListContainersRequest) ProtoMessage()
func (*ListContainersRequest) Reset ¶
func (m *ListContainersRequest) Reset()
func (*ListContainersRequest) String ¶
func (m *ListContainersRequest) String() string
type ListContainersResponse ¶
type ListContainersResponse struct { // List of containers Containers []*Container `protobuf:"bytes,1,rep,name=containers" json:"containers,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ListContainersResponse) Descriptor ¶
func (*ListContainersResponse) Descriptor() ([]byte, []int)
func (*ListContainersResponse) GetContainers ¶
func (m *ListContainersResponse) GetContainers() []*Container
func (*ListContainersResponse) ProtoMessage ¶
func (*ListContainersResponse) ProtoMessage()
func (*ListContainersResponse) Reset ¶
func (m *ListContainersResponse) Reset()
func (*ListContainersResponse) String ¶
func (m *ListContainersResponse) String() string
type ListImagesRequest ¶
type ListImagesRequest struct { // The filter to list images Filter *ImageFilter `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ListImagesRequest) Descriptor ¶
func (*ListImagesRequest) Descriptor() ([]byte, []int)
func (*ListImagesRequest) GetFilter ¶
func (m *ListImagesRequest) GetFilter() *ImageFilter
func (*ListImagesRequest) ProtoMessage ¶
func (*ListImagesRequest) ProtoMessage()
func (*ListImagesRequest) Reset ¶
func (m *ListImagesRequest) Reset()
func (*ListImagesRequest) String ¶
func (m *ListImagesRequest) String() string
type ListImagesResponse ¶
type ListImagesResponse struct { // List of images Images []*Image `protobuf:"bytes,1,rep,name=images" json:"images,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ListImagesResponse) Descriptor ¶
func (*ListImagesResponse) Descriptor() ([]byte, []int)
func (*ListImagesResponse) GetImages ¶
func (m *ListImagesResponse) GetImages() []*Image
func (*ListImagesResponse) ProtoMessage ¶
func (*ListImagesResponse) ProtoMessage()
func (*ListImagesResponse) Reset ¶
func (m *ListImagesResponse) Reset()
func (*ListImagesResponse) String ¶
func (m *ListImagesResponse) String() string
type ListPodSandboxRequest ¶
type ListPodSandboxRequest struct { // PodSandboxFilter to filter a list of PodSandboxes. Filter *PodSandboxFilter `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ListPodSandboxRequest) Descriptor ¶
func (*ListPodSandboxRequest) Descriptor() ([]byte, []int)
func (*ListPodSandboxRequest) GetFilter ¶
func (m *ListPodSandboxRequest) GetFilter() *PodSandboxFilter
func (*ListPodSandboxRequest) ProtoMessage ¶
func (*ListPodSandboxRequest) ProtoMessage()
func (*ListPodSandboxRequest) Reset ¶
func (m *ListPodSandboxRequest) Reset()
func (*ListPodSandboxRequest) String ¶
func (m *ListPodSandboxRequest) String() string
type ListPodSandboxResponse ¶
type ListPodSandboxResponse struct { // List of PodSandbox Items []*PodSandbox `protobuf:"bytes,1,rep,name=items" json:"items,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ListPodSandboxResponse) Descriptor ¶
func (*ListPodSandboxResponse) Descriptor() ([]byte, []int)
func (*ListPodSandboxResponse) GetItems ¶
func (m *ListPodSandboxResponse) GetItems() []*PodSandbox
func (*ListPodSandboxResponse) ProtoMessage ¶
func (*ListPodSandboxResponse) ProtoMessage()
func (*ListPodSandboxResponse) Reset ¶
func (m *ListPodSandboxResponse) Reset()
func (*ListPodSandboxResponse) String ¶
func (m *ListPodSandboxResponse) String() string
type Mount ¶
type Mount struct { // The path of the mount within the container. ContainerPath *string `protobuf:"bytes,1,opt,name=container_path,json=containerPath" json:"container_path,omitempty"` // The path of the mount on the host. HostPath *string `protobuf:"bytes,2,opt,name=host_path,json=hostPath" json:"host_path,omitempty"` // If set, the mount is read-only. Readonly *bool `protobuf:"varint,3,opt,name=readonly" json:"readonly,omitempty"` // If set, the mount needs SELinux relabeling SelinuxRelabel *bool `protobuf:"varint,4,opt,name=selinux_relabel,json=selinuxRelabel" json:"selinux_relabel,omitempty"` XXX_unrecognized []byte `json:"-"` }
Mount specifies a host volume to mount into a container.
func (*Mount) Descriptor ¶
func (*Mount) GetContainerPath ¶
func (*Mount) GetHostPath ¶
func (*Mount) GetReadonly ¶
func (*Mount) GetSelinuxRelabel ¶
func (*Mount) ProtoMessage ¶
func (*Mount) ProtoMessage()
type Namespace ¶
type Namespace struct { // Network is the path to the network namespace. Network *string `protobuf:"bytes,1,opt,name=network" json:"network,omitempty"` // Options is the namespace options for linux namespaces Options *NamespaceOption `protobuf:"bytes,2,opt,name=options" json:"options,omitempty"` XXX_unrecognized []byte `json:"-"` }
Namespace contains paths to the namespaces.
func (*Namespace) Descriptor ¶
func (*Namespace) GetNetwork ¶
func (*Namespace) GetOptions ¶
func (m *Namespace) GetOptions() *NamespaceOption
func (*Namespace) ProtoMessage ¶
func (*Namespace) ProtoMessage()
type NamespaceOption ¶
type NamespaceOption struct { // If set, use the host's network namespace. HostNetwork *bool `protobuf:"varint,1,opt,name=host_network,json=hostNetwork" json:"host_network,omitempty"` // If set, use the host's PID namespace. HostPid *bool `protobuf:"varint,2,opt,name=host_pid,json=hostPid" json:"host_pid,omitempty"` // If set, use the host's IPC namespace. HostIpc *bool `protobuf:"varint,3,opt,name=host_ipc,json=hostIpc" json:"host_ipc,omitempty"` XXX_unrecognized []byte `json:"-"` }
NamespaceOption provides options for Linux namespaces.
func (*NamespaceOption) Descriptor ¶
func (*NamespaceOption) Descriptor() ([]byte, []int)
func (*NamespaceOption) GetHostIpc ¶
func (m *NamespaceOption) GetHostIpc() bool
func (*NamespaceOption) GetHostNetwork ¶
func (m *NamespaceOption) GetHostNetwork() bool
func (*NamespaceOption) GetHostPid ¶
func (m *NamespaceOption) GetHostPid() bool
func (*NamespaceOption) ProtoMessage ¶
func (*NamespaceOption) ProtoMessage()
func (*NamespaceOption) Reset ¶
func (m *NamespaceOption) Reset()
func (*NamespaceOption) String ¶
func (m *NamespaceOption) String() string
type NetworkConfig ¶ added in v1.5.0
type NetworkConfig struct { // The CIDR to use for pod IP addresses PodCidr *string `protobuf:"bytes,1,opt,name=pod_cidr,json=podCidr" json:"pod_cidr,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*NetworkConfig) Descriptor ¶ added in v1.5.0
func (*NetworkConfig) Descriptor() ([]byte, []int)
func (*NetworkConfig) GetPodCidr ¶ added in v1.5.0
func (m *NetworkConfig) GetPodCidr() string
func (*NetworkConfig) ProtoMessage ¶ added in v1.5.0
func (*NetworkConfig) ProtoMessage()
func (*NetworkConfig) Reset ¶ added in v1.5.0
func (m *NetworkConfig) Reset()
func (*NetworkConfig) String ¶ added in v1.5.0
func (m *NetworkConfig) String() string
type PodSandBoxState ¶
type PodSandBoxState int32
const ( PodSandBoxState_READY PodSandBoxState = 0 PodSandBoxState_NOTREADY PodSandBoxState = 1 )
func (PodSandBoxState) Enum ¶
func (x PodSandBoxState) Enum() *PodSandBoxState
func (PodSandBoxState) EnumDescriptor ¶
func (PodSandBoxState) EnumDescriptor() ([]byte, []int)
func (PodSandBoxState) String ¶
func (x PodSandBoxState) String() string
func (*PodSandBoxState) UnmarshalJSON ¶
func (x *PodSandBoxState) UnmarshalJSON(data []byte) error
type PodSandbox ¶
type PodSandbox struct { // The id of the PodSandbox Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Metadata of the sandbox Metadata *PodSandboxMetadata `protobuf:"bytes,2,opt,name=metadata" json:"metadata,omitempty"` // The state of the PodSandbox State *PodSandBoxState `protobuf:"varint,3,opt,name=state,enum=runtime.PodSandBoxState" json:"state,omitempty"` // Creation timestamps of the sandbox in nanoseconds CreatedAt *int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt" json:"created_at,omitempty"` // The labels of the PodSandbox Labels map[string]string `` /* 132-byte string literal not displayed */ // Annotations is an unstructured key value map that may be set by external // tools to store and retrieve arbitrary metadata. Annotations map[string]string `` /* 142-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
PodSandbox contains minimal information about a sandbox.
func (*PodSandbox) Descriptor ¶
func (*PodSandbox) Descriptor() ([]byte, []int)
func (*PodSandbox) GetAnnotations ¶ added in v1.5.0
func (m *PodSandbox) GetAnnotations() map[string]string
func (*PodSandbox) GetCreatedAt ¶
func (m *PodSandbox) GetCreatedAt() int64
func (*PodSandbox) GetId ¶
func (m *PodSandbox) GetId() string
func (*PodSandbox) GetLabels ¶
func (m *PodSandbox) GetLabels() map[string]string
func (*PodSandbox) GetMetadata ¶
func (m *PodSandbox) GetMetadata() *PodSandboxMetadata
func (*PodSandbox) GetState ¶
func (m *PodSandbox) GetState() PodSandBoxState
func (*PodSandbox) ProtoMessage ¶
func (*PodSandbox) ProtoMessage()
func (*PodSandbox) Reset ¶
func (m *PodSandbox) Reset()
func (*PodSandbox) String ¶
func (m *PodSandbox) String() string
type PodSandboxConfig ¶
type PodSandboxConfig struct { // The metadata of the sandbox. This information will uniquely identify // the sandbox, and the runtime should leverage this to ensure correct // operation. The runtime may also use this information to improve UX, such // as by constructing a readable name. Metadata *PodSandboxMetadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // The hostname of the sandbox. Hostname *string `protobuf:"bytes,2,opt,name=hostname" json:"hostname,omitempty"` // Path to the directory on the host in which container log files are // stored. // By default the log of a container going into the LogDirectory will be // hooked up to STDOUT and STDERR. However, the LogDirectory may contain // binary log files with structured logging data from the individual // containers. For example, the files might be newline separated JSON // structured logs, systemd-journald journal files, gRPC trace files, etc. // E.g., // PodSandboxConfig.LogDirectory = `/var/log/pods/<podUID>/` // ContainerConfig.LogPath = `containerName_Instance#.log` // // WARNING: Log management and how kubelet should interface with the // container logs are under active discussion in // https://issues.k8s.io/24677. There *may* be future change of direction // for logging as the discussion carries on. LogDirectory *string `protobuf:"bytes,3,opt,name=log_directory,json=logDirectory" json:"log_directory,omitempty"` // The DNS config for the sandbox. DnsConfig *DNSConfig `protobuf:"bytes,4,opt,name=dns_config,json=dnsConfig" json:"dns_config,omitempty"` // The port mappings for the sandbox. PortMappings []*PortMapping `protobuf:"bytes,5,rep,name=port_mappings,json=portMappings" json:"port_mappings,omitempty"` // Labels are key value pairs that may be used to scope and select individual resources. Labels map[string]string `` /* 132-byte string literal not displayed */ // Annotations is an unstructured key value map that may be set by external // tools to store and retrieve arbitrary metadata. There are a few features are // driven by annotations, Runtimes could support them optionally: // // 1. AppArmor // // key: container.apparmor.security.beta.kubernetes.io/<container_name> // description: apparmor profile for the container. // value: // * runtime/default: equivalent to not specifying a profile. // * localhost/<profile_name>: profile loaded on the node // (localhost) by name. The possible profile names are detailed at // http://wiki.apparmor.net/index.php/AppArmor_Core_Policy_Reference // // 2. Seccomp // // key: security.alpha.kubernetes.io/seccomp/pod // description: the seccomp profile for the containers of an entire pod. // value: see below. // // key: security.alpha.kubernetes.io/seccomp/container/<container name> // description: the seccomp profile for the container (overides pod). // values: see below // // The value of seccomp is runtime agnostic: // * runtime/default: the default profile for the container runtime // * unconfined: unconfined profile, ie, no seccomp sandboxing // * localhost/<profile-name>: the profile installed to the node's // local seccomp profile root // Annotations map[string]string `` /* 142-byte string literal not displayed */ // Optional configurations specific to Linux hosts. Linux *LinuxPodSandboxConfig `protobuf:"bytes,8,opt,name=linux" json:"linux,omitempty"` XXX_unrecognized []byte `json:"-"` }
PodSandboxConfig holds all the required and optional fields for creating a sandbox.
func (*PodSandboxConfig) Descriptor ¶
func (*PodSandboxConfig) Descriptor() ([]byte, []int)
func (*PodSandboxConfig) GetAnnotations ¶
func (m *PodSandboxConfig) GetAnnotations() map[string]string
func (*PodSandboxConfig) GetDnsConfig ¶ added in v1.5.0
func (m *PodSandboxConfig) GetDnsConfig() *DNSConfig
func (*PodSandboxConfig) GetHostname ¶
func (m *PodSandboxConfig) GetHostname() string
func (*PodSandboxConfig) GetLabels ¶
func (m *PodSandboxConfig) GetLabels() map[string]string
func (*PodSandboxConfig) GetLinux ¶
func (m *PodSandboxConfig) GetLinux() *LinuxPodSandboxConfig
func (*PodSandboxConfig) GetLogDirectory ¶
func (m *PodSandboxConfig) GetLogDirectory() string
func (*PodSandboxConfig) GetMetadata ¶
func (m *PodSandboxConfig) GetMetadata() *PodSandboxMetadata
func (*PodSandboxConfig) GetPortMappings ¶
func (m *PodSandboxConfig) GetPortMappings() []*PortMapping
func (*PodSandboxConfig) ProtoMessage ¶
func (*PodSandboxConfig) ProtoMessage()
func (*PodSandboxConfig) Reset ¶
func (m *PodSandboxConfig) Reset()
func (*PodSandboxConfig) String ¶
func (m *PodSandboxConfig) String() string
type PodSandboxFilter ¶
type PodSandboxFilter struct { // ID of the sandbox. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // State of the sandbox. State *PodSandBoxState `protobuf:"varint,2,opt,name=state,enum=runtime.PodSandBoxState" json:"state,omitempty"` // LabelSelector to select matches. // Only api.MatchLabels is supported for now and the requirements // are ANDed. MatchExpressions is not supported yet. LabelSelector map[string]string `` /* 167-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
PodSandboxFilter is used to filter a list of PodSandboxes. All those fields are combined with 'AND'
func (*PodSandboxFilter) Descriptor ¶
func (*PodSandboxFilter) Descriptor() ([]byte, []int)
func (*PodSandboxFilter) GetId ¶
func (m *PodSandboxFilter) GetId() string
func (*PodSandboxFilter) GetLabelSelector ¶
func (m *PodSandboxFilter) GetLabelSelector() map[string]string
func (*PodSandboxFilter) GetState ¶
func (m *PodSandboxFilter) GetState() PodSandBoxState
func (*PodSandboxFilter) ProtoMessage ¶
func (*PodSandboxFilter) ProtoMessage()
func (*PodSandboxFilter) Reset ¶
func (m *PodSandboxFilter) Reset()
func (*PodSandboxFilter) String ¶
func (m *PodSandboxFilter) String() string
type PodSandboxMetadata ¶
type PodSandboxMetadata struct { // The pod name of the sandbox. Same as the pod name in the PodSpec. Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The pod UID of the sandbox. Same as the pod UID in the PodSpec. Uid *string `protobuf:"bytes,2,opt,name=uid" json:"uid,omitempty"` // The pod namespace of the sandbox. Same as the pod namespace in the PodSpec. Namespace *string `protobuf:"bytes,3,opt,name=namespace" json:"namespace,omitempty"` // The attempt number of creating the sandbox. Attempt *uint32 `protobuf:"varint,4,opt,name=attempt" json:"attempt,omitempty"` XXX_unrecognized []byte `json:"-"` }
PodSandboxMetadata holds all necessary information for building the sandbox name. The container runtime is encouraged to expose the metadata associated with the PodSandbox in its user interface for better user experience. For example, the runtime can construct a unique PodSandboxName based on the metadata.
func (*PodSandboxMetadata) Descriptor ¶
func (*PodSandboxMetadata) Descriptor() ([]byte, []int)
func (*PodSandboxMetadata) GetAttempt ¶
func (m *PodSandboxMetadata) GetAttempt() uint32
func (*PodSandboxMetadata) GetName ¶
func (m *PodSandboxMetadata) GetName() string
func (*PodSandboxMetadata) GetNamespace ¶
func (m *PodSandboxMetadata) GetNamespace() string
func (*PodSandboxMetadata) GetUid ¶
func (m *PodSandboxMetadata) GetUid() string
func (*PodSandboxMetadata) ProtoMessage ¶
func (*PodSandboxMetadata) ProtoMessage()
func (*PodSandboxMetadata) Reset ¶
func (m *PodSandboxMetadata) Reset()
func (*PodSandboxMetadata) String ¶
func (m *PodSandboxMetadata) String() string
type PodSandboxNetworkStatus ¶
type PodSandboxNetworkStatus struct { // The IP address of the PodSandbox Ip *string `protobuf:"bytes,1,opt,name=ip" json:"ip,omitempty"` XXX_unrecognized []byte `json:"-"` }
PodSandboxNetworkStatus is the status of the network for a PodSandbox.
func (*PodSandboxNetworkStatus) Descriptor ¶
func (*PodSandboxNetworkStatus) Descriptor() ([]byte, []int)
func (*PodSandboxNetworkStatus) GetIp ¶
func (m *PodSandboxNetworkStatus) GetIp() string
func (*PodSandboxNetworkStatus) ProtoMessage ¶
func (*PodSandboxNetworkStatus) ProtoMessage()
func (*PodSandboxNetworkStatus) Reset ¶
func (m *PodSandboxNetworkStatus) Reset()
func (*PodSandboxNetworkStatus) String ¶
func (m *PodSandboxNetworkStatus) String() string
type PodSandboxStatus ¶
type PodSandboxStatus struct { // ID of the sandbox. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Metadata of the sandbox. Metadata *PodSandboxMetadata `protobuf:"bytes,2,opt,name=metadata" json:"metadata,omitempty"` // State of the sandbox. State *PodSandBoxState `protobuf:"varint,3,opt,name=state,enum=runtime.PodSandBoxState" json:"state,omitempty"` // Creation timestamp of the sandbox in nanoseconds. CreatedAt *int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt" json:"created_at,omitempty"` // Network contains network status if network is handled by the runtime. Network *PodSandboxNetworkStatus `protobuf:"bytes,5,opt,name=network" json:"network,omitempty"` // Linux specific status to a pod sandbox. Linux *LinuxPodSandboxStatus `protobuf:"bytes,6,opt,name=linux" json:"linux,omitempty"` // Labels are key value pairs that may be used to scope and select individual resources. Labels map[string]string `` /* 132-byte string literal not displayed */ // Annotations is an unstructured key value map that may be set by external // tools to store and retrieve arbitrary metadata. Annotations map[string]string `` /* 142-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
PodSandboxStatus contains the status of the PodSandbox.
func (*PodSandboxStatus) Descriptor ¶
func (*PodSandboxStatus) Descriptor() ([]byte, []int)
func (*PodSandboxStatus) GetAnnotations ¶
func (m *PodSandboxStatus) GetAnnotations() map[string]string
func (*PodSandboxStatus) GetCreatedAt ¶
func (m *PodSandboxStatus) GetCreatedAt() int64
func (*PodSandboxStatus) GetId ¶
func (m *PodSandboxStatus) GetId() string
func (*PodSandboxStatus) GetLabels ¶
func (m *PodSandboxStatus) GetLabels() map[string]string
func (*PodSandboxStatus) GetLinux ¶
func (m *PodSandboxStatus) GetLinux() *LinuxPodSandboxStatus
func (*PodSandboxStatus) GetMetadata ¶
func (m *PodSandboxStatus) GetMetadata() *PodSandboxMetadata
func (*PodSandboxStatus) GetNetwork ¶
func (m *PodSandboxStatus) GetNetwork() *PodSandboxNetworkStatus
func (*PodSandboxStatus) GetState ¶
func (m *PodSandboxStatus) GetState() PodSandBoxState
func (*PodSandboxStatus) ProtoMessage ¶
func (*PodSandboxStatus) ProtoMessage()
func (*PodSandboxStatus) Reset ¶
func (m *PodSandboxStatus) Reset()
func (*PodSandboxStatus) String ¶
func (m *PodSandboxStatus) String() string
type PodSandboxStatusRequest ¶
type PodSandboxStatusRequest struct { // The id of the PodSandbox PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*PodSandboxStatusRequest) Descriptor ¶
func (*PodSandboxStatusRequest) Descriptor() ([]byte, []int)
func (*PodSandboxStatusRequest) GetPodSandboxId ¶
func (m *PodSandboxStatusRequest) GetPodSandboxId() string
func (*PodSandboxStatusRequest) ProtoMessage ¶
func (*PodSandboxStatusRequest) ProtoMessage()
func (*PodSandboxStatusRequest) Reset ¶
func (m *PodSandboxStatusRequest) Reset()
func (*PodSandboxStatusRequest) String ¶
func (m *PodSandboxStatusRequest) String() string
type PodSandboxStatusResponse ¶
type PodSandboxStatusResponse struct { // The status of the PodSandbox Status *PodSandboxStatus `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*PodSandboxStatusResponse) Descriptor ¶
func (*PodSandboxStatusResponse) Descriptor() ([]byte, []int)
func (*PodSandboxStatusResponse) GetStatus ¶
func (m *PodSandboxStatusResponse) GetStatus() *PodSandboxStatus
func (*PodSandboxStatusResponse) ProtoMessage ¶
func (*PodSandboxStatusResponse) ProtoMessage()
func (*PodSandboxStatusResponse) Reset ¶
func (m *PodSandboxStatusResponse) Reset()
func (*PodSandboxStatusResponse) String ¶
func (m *PodSandboxStatusResponse) String() string
type PortForwardRequest ¶ added in v1.5.0
type PortForwardRequest struct { // The id of the container PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` // The port to forward Port []int32 `protobuf:"varint,2,rep,name=port" json:"port,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*PortForwardRequest) Descriptor ¶ added in v1.5.0
func (*PortForwardRequest) Descriptor() ([]byte, []int)
func (*PortForwardRequest) GetPodSandboxId ¶ added in v1.5.0
func (m *PortForwardRequest) GetPodSandboxId() string
func (*PortForwardRequest) GetPort ¶ added in v1.5.0
func (m *PortForwardRequest) GetPort() []int32
func (*PortForwardRequest) ProtoMessage ¶ added in v1.5.0
func (*PortForwardRequest) ProtoMessage()
func (*PortForwardRequest) Reset ¶ added in v1.5.0
func (m *PortForwardRequest) Reset()
func (*PortForwardRequest) String ¶ added in v1.5.0
func (m *PortForwardRequest) String() string
type PortForwardResponse ¶ added in v1.5.0
type PortForwardResponse struct { // The fully qualified URL of the port-forward streaming server Url *string `protobuf:"bytes,1,opt,name=url" json:"url,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*PortForwardResponse) Descriptor ¶ added in v1.5.0
func (*PortForwardResponse) Descriptor() ([]byte, []int)
func (*PortForwardResponse) GetUrl ¶ added in v1.5.0
func (m *PortForwardResponse) GetUrl() string
func (*PortForwardResponse) ProtoMessage ¶ added in v1.5.0
func (*PortForwardResponse) ProtoMessage()
func (*PortForwardResponse) Reset ¶ added in v1.5.0
func (m *PortForwardResponse) Reset()
func (*PortForwardResponse) String ¶ added in v1.5.0
func (m *PortForwardResponse) String() string
type PortMapping ¶
type PortMapping struct { // The protocol of the port mapping. Protocol *Protocol `protobuf:"varint,1,opt,name=protocol,enum=runtime.Protocol" json:"protocol,omitempty"` // The port number within the container. ContainerPort *int32 `protobuf:"varint,2,opt,name=container_port,json=containerPort" json:"container_port,omitempty"` // The port number on the host. HostPort *int32 `protobuf:"varint,3,opt,name=host_port,json=hostPort" json:"host_port,omitempty"` // The host IP. HostIp *string `protobuf:"bytes,4,opt,name=host_ip,json=hostIp" json:"host_ip,omitempty"` XXX_unrecognized []byte `json:"-"` }
PortMapping specifies the port mapping configurations of a sandbox.
func (*PortMapping) Descriptor ¶
func (*PortMapping) Descriptor() ([]byte, []int)
func (*PortMapping) GetContainerPort ¶
func (m *PortMapping) GetContainerPort() int32
func (*PortMapping) GetHostIp ¶
func (m *PortMapping) GetHostIp() string
func (*PortMapping) GetHostPort ¶
func (m *PortMapping) GetHostPort() int32
func (*PortMapping) GetProtocol ¶
func (m *PortMapping) GetProtocol() Protocol
func (*PortMapping) ProtoMessage ¶
func (*PortMapping) ProtoMessage()
func (*PortMapping) Reset ¶
func (m *PortMapping) Reset()
func (*PortMapping) String ¶
func (m *PortMapping) String() string
type Protocol ¶
type Protocol int32
func (Protocol) EnumDescriptor ¶
func (*Protocol) UnmarshalJSON ¶
type PullImageRequest ¶
type PullImageRequest struct { // The spec of the image Image *ImageSpec `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` // The auth config for pulling image Auth *AuthConfig `protobuf:"bytes,2,opt,name=auth" json:"auth,omitempty"` // The config of the PodSandbox, which is used to pull image in PodSandbox context SandboxConfig *PodSandboxConfig `protobuf:"bytes,3,opt,name=sandbox_config,json=sandboxConfig" json:"sandbox_config,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*PullImageRequest) Descriptor ¶
func (*PullImageRequest) Descriptor() ([]byte, []int)
func (*PullImageRequest) GetAuth ¶
func (m *PullImageRequest) GetAuth() *AuthConfig
func (*PullImageRequest) GetImage ¶
func (m *PullImageRequest) GetImage() *ImageSpec
func (*PullImageRequest) GetSandboxConfig ¶
func (m *PullImageRequest) GetSandboxConfig() *PodSandboxConfig
func (*PullImageRequest) ProtoMessage ¶
func (*PullImageRequest) ProtoMessage()
func (*PullImageRequest) Reset ¶
func (m *PullImageRequest) Reset()
func (*PullImageRequest) String ¶
func (m *PullImageRequest) String() string
type PullImageResponse ¶
type PullImageResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*PullImageResponse) Descriptor ¶
func (*PullImageResponse) Descriptor() ([]byte, []int)
func (*PullImageResponse) ProtoMessage ¶
func (*PullImageResponse) ProtoMessage()
func (*PullImageResponse) Reset ¶
func (m *PullImageResponse) Reset()
func (*PullImageResponse) String ¶
func (m *PullImageResponse) String() string
type RemoveContainerRequest ¶
type RemoveContainerRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RemoveContainerRequest) Descriptor ¶
func (*RemoveContainerRequest) Descriptor() ([]byte, []int)
func (*RemoveContainerRequest) GetContainerId ¶
func (m *RemoveContainerRequest) GetContainerId() string
func (*RemoveContainerRequest) ProtoMessage ¶
func (*RemoveContainerRequest) ProtoMessage()
func (*RemoveContainerRequest) Reset ¶
func (m *RemoveContainerRequest) Reset()
func (*RemoveContainerRequest) String ¶
func (m *RemoveContainerRequest) String() string
type RemoveContainerResponse ¶
type RemoveContainerResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*RemoveContainerResponse) Descriptor ¶
func (*RemoveContainerResponse) Descriptor() ([]byte, []int)
func (*RemoveContainerResponse) ProtoMessage ¶
func (*RemoveContainerResponse) ProtoMessage()
func (*RemoveContainerResponse) Reset ¶
func (m *RemoveContainerResponse) Reset()
func (*RemoveContainerResponse) String ¶
func (m *RemoveContainerResponse) String() string
type RemoveImageRequest ¶
type RemoveImageRequest struct { // The spec of the image Image *ImageSpec `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RemoveImageRequest) Descriptor ¶
func (*RemoveImageRequest) Descriptor() ([]byte, []int)
func (*RemoveImageRequest) GetImage ¶
func (m *RemoveImageRequest) GetImage() *ImageSpec
func (*RemoveImageRequest) ProtoMessage ¶
func (*RemoveImageRequest) ProtoMessage()
func (*RemoveImageRequest) Reset ¶
func (m *RemoveImageRequest) Reset()
func (*RemoveImageRequest) String ¶
func (m *RemoveImageRequest) String() string
type RemoveImageResponse ¶
type RemoveImageResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*RemoveImageResponse) Descriptor ¶
func (*RemoveImageResponse) Descriptor() ([]byte, []int)
func (*RemoveImageResponse) ProtoMessage ¶
func (*RemoveImageResponse) ProtoMessage()
func (*RemoveImageResponse) Reset ¶
func (m *RemoveImageResponse) Reset()
func (*RemoveImageResponse) String ¶
func (m *RemoveImageResponse) String() string
type RemovePodSandboxRequest ¶
type RemovePodSandboxRequest struct { // The id of the PodSandbox PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RemovePodSandboxRequest) Descriptor ¶
func (*RemovePodSandboxRequest) Descriptor() ([]byte, []int)
func (*RemovePodSandboxRequest) GetPodSandboxId ¶
func (m *RemovePodSandboxRequest) GetPodSandboxId() string
func (*RemovePodSandboxRequest) ProtoMessage ¶
func (*RemovePodSandboxRequest) ProtoMessage()
func (*RemovePodSandboxRequest) Reset ¶
func (m *RemovePodSandboxRequest) Reset()
func (*RemovePodSandboxRequest) String ¶
func (m *RemovePodSandboxRequest) String() string
type RemovePodSandboxResponse ¶
type RemovePodSandboxResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*RemovePodSandboxResponse) Descriptor ¶
func (*RemovePodSandboxResponse) Descriptor() ([]byte, []int)
func (*RemovePodSandboxResponse) ProtoMessage ¶
func (*RemovePodSandboxResponse) ProtoMessage()
func (*RemovePodSandboxResponse) Reset ¶
func (m *RemovePodSandboxResponse) Reset()
func (*RemovePodSandboxResponse) String ¶
func (m *RemovePodSandboxResponse) String() string
type RunPodSandboxRequest ¶ added in v1.5.0
type RunPodSandboxRequest struct { // The configuration for creating a PodSandbox. Config *PodSandboxConfig `protobuf:"bytes,1,opt,name=config" json:"config,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RunPodSandboxRequest) Descriptor ¶ added in v1.5.0
func (*RunPodSandboxRequest) Descriptor() ([]byte, []int)
func (*RunPodSandboxRequest) GetConfig ¶ added in v1.5.0
func (m *RunPodSandboxRequest) GetConfig() *PodSandboxConfig
func (*RunPodSandboxRequest) ProtoMessage ¶ added in v1.5.0
func (*RunPodSandboxRequest) ProtoMessage()
func (*RunPodSandboxRequest) Reset ¶ added in v1.5.0
func (m *RunPodSandboxRequest) Reset()
func (*RunPodSandboxRequest) String ¶ added in v1.5.0
func (m *RunPodSandboxRequest) String() string
type RunPodSandboxResponse ¶ added in v1.5.0
type RunPodSandboxResponse struct { // The id of the PodSandbox PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RunPodSandboxResponse) Descriptor ¶ added in v1.5.0
func (*RunPodSandboxResponse) Descriptor() ([]byte, []int)
func (*RunPodSandboxResponse) GetPodSandboxId ¶ added in v1.5.0
func (m *RunPodSandboxResponse) GetPodSandboxId() string
func (*RunPodSandboxResponse) ProtoMessage ¶ added in v1.5.0
func (*RunPodSandboxResponse) ProtoMessage()
func (*RunPodSandboxResponse) Reset ¶ added in v1.5.0
func (m *RunPodSandboxResponse) Reset()
func (*RunPodSandboxResponse) String ¶ added in v1.5.0
func (m *RunPodSandboxResponse) String() string
type RuntimeConfig ¶ added in v1.5.0
type RuntimeConfig struct { NetworkConfig *NetworkConfig `protobuf:"bytes,1,opt,name=network_config,json=networkConfig" json:"network_config,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RuntimeConfig) Descriptor ¶ added in v1.5.0
func (*RuntimeConfig) Descriptor() ([]byte, []int)
func (*RuntimeConfig) GetNetworkConfig ¶ added in v1.5.0
func (m *RuntimeConfig) GetNetworkConfig() *NetworkConfig
func (*RuntimeConfig) ProtoMessage ¶ added in v1.5.0
func (*RuntimeConfig) ProtoMessage()
func (*RuntimeConfig) Reset ¶ added in v1.5.0
func (m *RuntimeConfig) Reset()
func (*RuntimeConfig) String ¶ added in v1.5.0
func (m *RuntimeConfig) String() string
type RuntimeServiceClient ¶
type RuntimeServiceClient interface { // Version returns the runtime name, runtime version and runtime API version Version(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error) // RunPodSandbox creates and starts a pod-level sandbox. Runtimes should ensure // the sandbox is in ready state. RunPodSandbox(ctx context.Context, in *RunPodSandboxRequest, opts ...grpc.CallOption) (*RunPodSandboxResponse, error) // StopPodSandbox stops the running sandbox. If there are any running // containers in the sandbox, they should be forcibly terminated. StopPodSandbox(ctx context.Context, in *StopPodSandboxRequest, opts ...grpc.CallOption) (*StopPodSandboxResponse, error) // RemovePodSandbox removes the sandbox. If there are any running containers in the // sandbox, they should be forcibly removed. // It should return success if the sandbox has already been removed. RemovePodSandbox(ctx context.Context, in *RemovePodSandboxRequest, opts ...grpc.CallOption) (*RemovePodSandboxResponse, error) // PodSandboxStatus returns the status of the PodSandbox. PodSandboxStatus(ctx context.Context, in *PodSandboxStatusRequest, opts ...grpc.CallOption) (*PodSandboxStatusResponse, error) // ListPodSandbox returns a list of SandBox. ListPodSandbox(ctx context.Context, in *ListPodSandboxRequest, opts ...grpc.CallOption) (*ListPodSandboxResponse, error) // CreateContainer creates a new container in specified PodSandbox CreateContainer(ctx context.Context, in *CreateContainerRequest, opts ...grpc.CallOption) (*CreateContainerResponse, error) // StartContainer starts the container. StartContainer(ctx context.Context, in *StartContainerRequest, opts ...grpc.CallOption) (*StartContainerResponse, error) // StopContainer stops a running container with a grace period (i.e., timeout). StopContainer(ctx context.Context, in *StopContainerRequest, opts ...grpc.CallOption) (*StopContainerResponse, error) // RemoveContainer removes the container. If the container is running, the // container should be forcibly removed. // It should return success if the container has already been removed. RemoveContainer(ctx context.Context, in *RemoveContainerRequest, opts ...grpc.CallOption) (*RemoveContainerResponse, error) // ListContainers lists all containers by filters. ListContainers(ctx context.Context, in *ListContainersRequest, opts ...grpc.CallOption) (*ListContainersResponse, error) // ContainerStatus returns status of the container. ContainerStatus(ctx context.Context, in *ContainerStatusRequest, opts ...grpc.CallOption) (*ContainerStatusResponse, error) // ExecSync runs a command in a container synchronously. ExecSync(ctx context.Context, in *ExecSyncRequest, opts ...grpc.CallOption) (*ExecSyncResponse, error) // Exec prepares a streaming endpoint to execute a command in the container. Exec(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (*ExecResponse, error) // Attach prepares a streaming endpoint to attach to a running container. Attach(ctx context.Context, in *AttachRequest, opts ...grpc.CallOption) (*AttachResponse, error) // PortForward prepares a streaming endpoint to forward ports from a PodSandbox. PortForward(ctx context.Context, in *PortForwardRequest, opts ...grpc.CallOption) (*PortForwardResponse, error) // UpdateRuntimeConfig updates the runtime configuration based on request UpdateRuntimeConfig(ctx context.Context, in *UpdateRuntimeConfigRequest, opts ...grpc.CallOption) (*UpdateRuntimeConfigResponse, error) }
func NewRuntimeServiceClient ¶
func NewRuntimeServiceClient(cc *grpc.ClientConn) RuntimeServiceClient
type RuntimeServiceServer ¶
type RuntimeServiceServer interface { // Version returns the runtime name, runtime version and runtime API version Version(context.Context, *VersionRequest) (*VersionResponse, error) // RunPodSandbox creates and starts a pod-level sandbox. Runtimes should ensure // the sandbox is in ready state. RunPodSandbox(context.Context, *RunPodSandboxRequest) (*RunPodSandboxResponse, error) // StopPodSandbox stops the running sandbox. If there are any running // containers in the sandbox, they should be forcibly terminated. StopPodSandbox(context.Context, *StopPodSandboxRequest) (*StopPodSandboxResponse, error) // RemovePodSandbox removes the sandbox. If there are any running containers in the // sandbox, they should be forcibly removed. // It should return success if the sandbox has already been removed. RemovePodSandbox(context.Context, *RemovePodSandboxRequest) (*RemovePodSandboxResponse, error) // PodSandboxStatus returns the status of the PodSandbox. PodSandboxStatus(context.Context, *PodSandboxStatusRequest) (*PodSandboxStatusResponse, error) // ListPodSandbox returns a list of SandBox. ListPodSandbox(context.Context, *ListPodSandboxRequest) (*ListPodSandboxResponse, error) // CreateContainer creates a new container in specified PodSandbox CreateContainer(context.Context, *CreateContainerRequest) (*CreateContainerResponse, error) // StartContainer starts the container. StartContainer(context.Context, *StartContainerRequest) (*StartContainerResponse, error) // StopContainer stops a running container with a grace period (i.e., timeout). StopContainer(context.Context, *StopContainerRequest) (*StopContainerResponse, error) // RemoveContainer removes the container. If the container is running, the // container should be forcibly removed. // It should return success if the container has already been removed. RemoveContainer(context.Context, *RemoveContainerRequest) (*RemoveContainerResponse, error) // ListContainers lists all containers by filters. ListContainers(context.Context, *ListContainersRequest) (*ListContainersResponse, error) // ContainerStatus returns status of the container. ContainerStatus(context.Context, *ContainerStatusRequest) (*ContainerStatusResponse, error) // ExecSync runs a command in a container synchronously. ExecSync(context.Context, *ExecSyncRequest) (*ExecSyncResponse, error) // Exec prepares a streaming endpoint to execute a command in the container. Exec(context.Context, *ExecRequest) (*ExecResponse, error) // Attach prepares a streaming endpoint to attach to a running container. Attach(context.Context, *AttachRequest) (*AttachResponse, error) // PortForward prepares a streaming endpoint to forward ports from a PodSandbox. PortForward(context.Context, *PortForwardRequest) (*PortForwardResponse, error) // UpdateRuntimeConfig updates the runtime configuration based on request UpdateRuntimeConfig(context.Context, *UpdateRuntimeConfigRequest) (*UpdateRuntimeConfigResponse, error) }
type SELinuxOption ¶
type SELinuxOption struct { User *string `protobuf:"bytes,1,opt,name=user" json:"user,omitempty"` Role *string `protobuf:"bytes,2,opt,name=role" json:"role,omitempty"` Type *string `protobuf:"bytes,3,opt,name=type" json:"type,omitempty"` Level *string `protobuf:"bytes,4,opt,name=level" json:"level,omitempty"` XXX_unrecognized []byte `json:"-"` }
SELinuxOption are the labels to be applied to the container.
func (*SELinuxOption) Descriptor ¶
func (*SELinuxOption) Descriptor() ([]byte, []int)
func (*SELinuxOption) GetLevel ¶
func (m *SELinuxOption) GetLevel() string
func (*SELinuxOption) GetRole ¶
func (m *SELinuxOption) GetRole() string
func (*SELinuxOption) GetType ¶
func (m *SELinuxOption) GetType() string
func (*SELinuxOption) GetUser ¶
func (m *SELinuxOption) GetUser() string
func (*SELinuxOption) ProtoMessage ¶
func (*SELinuxOption) ProtoMessage()
func (*SELinuxOption) Reset ¶
func (m *SELinuxOption) Reset()
func (*SELinuxOption) String ¶
func (m *SELinuxOption) String() string
type StartContainerRequest ¶
type StartContainerRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*StartContainerRequest) Descriptor ¶
func (*StartContainerRequest) Descriptor() ([]byte, []int)
func (*StartContainerRequest) GetContainerId ¶
func (m *StartContainerRequest) GetContainerId() string
func (*StartContainerRequest) ProtoMessage ¶
func (*StartContainerRequest) ProtoMessage()
func (*StartContainerRequest) Reset ¶
func (m *StartContainerRequest) Reset()
func (*StartContainerRequest) String ¶
func (m *StartContainerRequest) String() string
type StartContainerResponse ¶
type StartContainerResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*StartContainerResponse) Descriptor ¶
func (*StartContainerResponse) Descriptor() ([]byte, []int)
func (*StartContainerResponse) ProtoMessage ¶
func (*StartContainerResponse) ProtoMessage()
func (*StartContainerResponse) Reset ¶
func (m *StartContainerResponse) Reset()
func (*StartContainerResponse) String ¶
func (m *StartContainerResponse) String() string
type StopContainerRequest ¶
type StopContainerRequest struct { // The id of the container ContainerId *string `protobuf:"bytes,1,opt,name=container_id,json=containerId" json:"container_id,omitempty"` // Timeout in seconds to stop the container Timeout *int64 `protobuf:"varint,2,opt,name=timeout" json:"timeout,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*StopContainerRequest) Descriptor ¶
func (*StopContainerRequest) Descriptor() ([]byte, []int)
func (*StopContainerRequest) GetContainerId ¶
func (m *StopContainerRequest) GetContainerId() string
func (*StopContainerRequest) GetTimeout ¶
func (m *StopContainerRequest) GetTimeout() int64
func (*StopContainerRequest) ProtoMessage ¶
func (*StopContainerRequest) ProtoMessage()
func (*StopContainerRequest) Reset ¶
func (m *StopContainerRequest) Reset()
func (*StopContainerRequest) String ¶
func (m *StopContainerRequest) String() string
type StopContainerResponse ¶
type StopContainerResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*StopContainerResponse) Descriptor ¶
func (*StopContainerResponse) Descriptor() ([]byte, []int)
func (*StopContainerResponse) ProtoMessage ¶
func (*StopContainerResponse) ProtoMessage()
func (*StopContainerResponse) Reset ¶
func (m *StopContainerResponse) Reset()
func (*StopContainerResponse) String ¶
func (m *StopContainerResponse) String() string
type StopPodSandboxRequest ¶
type StopPodSandboxRequest struct { // The id of the PodSandbox PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*StopPodSandboxRequest) Descriptor ¶
func (*StopPodSandboxRequest) Descriptor() ([]byte, []int)
func (*StopPodSandboxRequest) GetPodSandboxId ¶
func (m *StopPodSandboxRequest) GetPodSandboxId() string
func (*StopPodSandboxRequest) ProtoMessage ¶
func (*StopPodSandboxRequest) ProtoMessage()
func (*StopPodSandboxRequest) Reset ¶
func (m *StopPodSandboxRequest) Reset()
func (*StopPodSandboxRequest) String ¶
func (m *StopPodSandboxRequest) String() string
type StopPodSandboxResponse ¶
type StopPodSandboxResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*StopPodSandboxResponse) Descriptor ¶
func (*StopPodSandboxResponse) Descriptor() ([]byte, []int)
func (*StopPodSandboxResponse) ProtoMessage ¶
func (*StopPodSandboxResponse) ProtoMessage()
func (*StopPodSandboxResponse) Reset ¶
func (m *StopPodSandboxResponse) Reset()
func (*StopPodSandboxResponse) String ¶
func (m *StopPodSandboxResponse) String() string
type UpdateRuntimeConfigRequest ¶ added in v1.5.0
type UpdateRuntimeConfigRequest struct { RuntimeConfig *RuntimeConfig `protobuf:"bytes,1,opt,name=runtime_config,json=runtimeConfig" json:"runtime_config,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*UpdateRuntimeConfigRequest) Descriptor ¶ added in v1.5.0
func (*UpdateRuntimeConfigRequest) Descriptor() ([]byte, []int)
func (*UpdateRuntimeConfigRequest) GetRuntimeConfig ¶ added in v1.5.0
func (m *UpdateRuntimeConfigRequest) GetRuntimeConfig() *RuntimeConfig
func (*UpdateRuntimeConfigRequest) ProtoMessage ¶ added in v1.5.0
func (*UpdateRuntimeConfigRequest) ProtoMessage()
func (*UpdateRuntimeConfigRequest) Reset ¶ added in v1.5.0
func (m *UpdateRuntimeConfigRequest) Reset()
func (*UpdateRuntimeConfigRequest) String ¶ added in v1.5.0
func (m *UpdateRuntimeConfigRequest) String() string
type UpdateRuntimeConfigResponse ¶ added in v1.5.0
type UpdateRuntimeConfigResponse struct {
XXX_unrecognized []byte `json:"-"`
}
func (*UpdateRuntimeConfigResponse) Descriptor ¶ added in v1.5.0
func (*UpdateRuntimeConfigResponse) Descriptor() ([]byte, []int)
func (*UpdateRuntimeConfigResponse) ProtoMessage ¶ added in v1.5.0
func (*UpdateRuntimeConfigResponse) ProtoMessage()
func (*UpdateRuntimeConfigResponse) Reset ¶ added in v1.5.0
func (m *UpdateRuntimeConfigResponse) Reset()
func (*UpdateRuntimeConfigResponse) String ¶ added in v1.5.0
func (m *UpdateRuntimeConfigResponse) String() string
type VersionRequest ¶
type VersionRequest struct { // The version of kubelet runtime API. Version *string `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*VersionRequest) Descriptor ¶
func (*VersionRequest) Descriptor() ([]byte, []int)
func (*VersionRequest) GetVersion ¶
func (m *VersionRequest) GetVersion() string
func (*VersionRequest) ProtoMessage ¶
func (*VersionRequest) ProtoMessage()
func (*VersionRequest) Reset ¶
func (m *VersionRequest) Reset()
func (*VersionRequest) String ¶
func (m *VersionRequest) String() string
type VersionResponse ¶
type VersionResponse struct { // The version of the kubelet runtime API. Version *string `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"` // The name of the container runtime. RuntimeName *string `protobuf:"bytes,2,opt,name=runtime_name,json=runtimeName" json:"runtime_name,omitempty"` // The version of the container runtime. The string should be // semver-compatible. RuntimeVersion *string `protobuf:"bytes,3,opt,name=runtime_version,json=runtimeVersion" json:"runtime_version,omitempty"` // The API version of the container runtime. The string should be // semver-compatible. RuntimeApiVersion *string `protobuf:"bytes,4,opt,name=runtime_api_version,json=runtimeApiVersion" json:"runtime_api_version,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*VersionResponse) Descriptor ¶
func (*VersionResponse) Descriptor() ([]byte, []int)
func (*VersionResponse) GetRuntimeApiVersion ¶
func (m *VersionResponse) GetRuntimeApiVersion() string
func (*VersionResponse) GetRuntimeName ¶
func (m *VersionResponse) GetRuntimeName() string
func (*VersionResponse) GetRuntimeVersion ¶
func (m *VersionResponse) GetRuntimeVersion() string
func (*VersionResponse) GetVersion ¶
func (m *VersionResponse) GetVersion() string
func (*VersionResponse) ProtoMessage ¶
func (*VersionResponse) ProtoMessage()
func (*VersionResponse) Reset ¶
func (m *VersionResponse) Reset()
func (*VersionResponse) String ¶
func (m *VersionResponse) String() string