v1alpha2

package
v0.25.16 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// RuntimeReady means the runtime is up and ready to accept basic containers.
	RuntimeReady = "RuntimeReady"
	// NetworkReady means the runtime network is up and ready to accept containers which require network.
	NetworkReady = "NetworkReady"
)

Required runtime condition type.

Variables

View Source
var (
	ErrInvalidLengthApi        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowApi          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupApi = fmt.Errorf("proto: unexpected end of group")
)
View Source
var ContainerState_name = map[int32]string{
	0: "CONTAINER_CREATED",
	1: "CONTAINER_RUNNING",
	2: "CONTAINER_EXITED",
	3: "CONTAINER_UNKNOWN",
}
View Source
var ContainerState_value = map[string]int32{
	"CONTAINER_CREATED": 0,
	"CONTAINER_RUNNING": 1,
	"CONTAINER_EXITED":  2,
	"CONTAINER_UNKNOWN": 3,
}
View Source
var MountPropagation_name = map[int32]string{
	0: "PROPAGATION_PRIVATE",
	1: "PROPAGATION_HOST_TO_CONTAINER",
	2: "PROPAGATION_BIDIRECTIONAL",
}
View Source
var MountPropagation_value = map[string]int32{
	"PROPAGATION_PRIVATE":           0,
	"PROPAGATION_HOST_TO_CONTAINER": 1,
	"PROPAGATION_BIDIRECTIONAL":     2,
}
View Source
var NamespaceMode_name = map[int32]string{
	0: "POD",
	1: "CONTAINER",
	2: "NODE",
	3: "TARGET",
}
View Source
var NamespaceMode_value = map[string]int32{
	"POD":       0,
	"CONTAINER": 1,
	"NODE":      2,
	"TARGET":    3,
}
View Source
var PodSandboxState_name = map[int32]string{
	0: "SANDBOX_READY",
	1: "SANDBOX_NOTREADY",
}
View Source
var PodSandboxState_value = map[string]int32{
	"SANDBOX_READY":    0,
	"SANDBOX_NOTREADY": 1,
}
View Source
var Protocol_name = map[int32]string{
	0: "TCP",
	1: "UDP",
	2: "SCTP",
}
View Source
var Protocol_value = map[string]int32{
	"TCP":  0,
	"UDP":  1,
	"SCTP": 2,
}
View Source
var SecurityProfile_ProfileType_name = map[int32]string{
	0: "RuntimeDefault",
	1: "Unconfined",
	2: "Localhost",
}
View Source
var SecurityProfile_ProfileType_value = map[string]int32{
	"RuntimeDefault": 0,
	"Unconfined":     1,
	"Localhost":      2,
}

Functions

func RegisterImageServiceServer

func RegisterImageServiceServer(s *grpc.Server, srv ImageServiceServer)

func RegisterRuntimeServiceServer

func RegisterRuntimeServiceServer(s *grpc.Server, srv RuntimeServiceServer)

Types

type AttachRequest

type AttachRequest struct {
	// ID of the container to which to attach.
	ContainerId string `protobuf:"bytes,1,opt,name=container_id,json=containerId,proto3" json:"container_id,omitempty"`
	// Whether to stream stdin.
	// One of `stdin`, `stdout`, and `stderr` MUST be true.
	Stdin bool `protobuf:"varint,2,opt,name=stdin,proto3" json:"stdin,omitempty"`
	// Whether the process being attached is running in a TTY.
	// This must match the TTY setting in the ContainerConfig.
	Tty bool `protobuf:"varint,3,opt,name=tty,proto3" json:"tty,omitempty"`
	// Whether to stream stdout.
	// One of `stdin`, `stdout`, and `stderr` MUST be true.
	Stdout bool `protobuf:"varint,4,opt,name=stdout,proto3" json:"stdout,omitempty"`
	// Whether to stream stderr.
	// One of `stdin`, `stdout`, and `stderr` MUST be true.
	// If `tty` is true, `stderr` MUST be false. Multiplexing is not supported
	// in this case. The output of stdout and stderr will be combined to a
	// single stream.
	Stderr               bool     `protobuf:"varint,5,opt,name=stderr,proto3" json:"stderr,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AttachRequest) Descriptor

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

func (*AttachRequest) GetContainerId

func (m *AttachRequest) GetContainerId() string

func (*AttachRequest) GetStderr

func (m *AttachRequest) GetStderr() bool

func (*AttachRequest) GetStdin

func (m *AttachRequest) GetStdin() bool

func (*AttachRequest) GetStdout

func (m *AttachRequest) GetStdout() bool

func (*AttachRequest) GetTty

func (m *AttachRequest) GetTty() bool

func (*AttachRequest) Marshal

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

func (*AttachRequest) MarshalTo

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

func (*AttachRequest) MarshalToSizedBuffer added in v0.16.4

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

func (*AttachRequest) ProtoMessage

func (*AttachRequest) ProtoMessage()

func (*AttachRequest) Reset

func (m *AttachRequest) Reset()

func (*AttachRequest) Size

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

func (*AttachRequest) String

func (this *AttachRequest) String() string

func (*AttachRequest) Unmarshal

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

func (*AttachRequest) XXX_DiscardUnknown added in v0.16.4

func (m *AttachRequest) XXX_DiscardUnknown()

func (*AttachRequest) XXX_Marshal added in v0.16.4

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

func (*AttachRequest) XXX_Merge added in v0.16.4

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

func (*AttachRequest) XXX_Size added in v0.16.4

func (m *AttachRequest) XXX_Size() int

func (*AttachRequest) XXX_Unmarshal added in v0.16.4

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

type AttachResponse

type AttachResponse struct {
	// Fully qualified URL of the attach streaming server.
	Url                  string   `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AttachResponse) Descriptor

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

func (*AttachResponse) GetUrl

func (m *AttachResponse) GetUrl() string

func (*AttachResponse) Marshal

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

func (*AttachResponse) MarshalTo

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

func (*AttachResponse) MarshalToSizedBuffer added in v0.16.4

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

func (*AttachResponse) ProtoMessage

func (*AttachResponse) ProtoMessage()

func (*AttachResponse) Reset

func (m *AttachResponse) Reset()

func (*AttachResponse) Size

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

func (*AttachResponse) String

func (this *AttachResponse) String() string

func (*AttachResponse) Unmarshal

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

func (*AttachResponse) XXX_DiscardUnknown added in v0.16.4

func (m *AttachResponse) XXX_DiscardUnknown()

func (*AttachResponse) XXX_Marshal added in v0.16.4

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

func (*AttachResponse) XXX_Merge added in v0.16.4

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

func (*AttachResponse) XXX_Size added in v0.16.4

func (m *AttachResponse) XXX_Size() int

func (*AttachResponse) XXX_Unmarshal added in v0.16.4

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

type AuthConfig

type AuthConfig struct {
	Username      string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Password      string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	Auth          string `protobuf:"bytes,3,opt,name=auth,proto3" json:"auth,omitempty"`
	ServerAddress string `protobuf:"bytes,4,opt,name=server_address,json=serverAddress,proto3" 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,proto3" 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,proto3" json:"registry_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `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) Marshal

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

func (*AuthConfig) MarshalTo

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

func (*AuthConfig) MarshalToSizedBuffer added in v0.16.4

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

func (*AuthConfig) ProtoMessage

func (*AuthConfig) ProtoMessage()

func (*AuthConfig) Reset

func (m *AuthConfig) Reset()

func (*AuthConfig) Size

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

func (*AuthConfig) String

func (this *AuthConfig) String() string

func (*AuthConfig) Unmarshal

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

func (*AuthConfig) XXX_DiscardUnknown added in v0.16.4

func (m *AuthConfig) XXX_DiscardUnknown()

func (*AuthConfig) XXX_Marshal added in v0.16.4

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

func (*AuthConfig) XXX_Merge added in v0.16.4

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

func (*AuthConfig) XXX_Size added in v0.16.4

func (m *AuthConfig) XXX_Size() int

func (*AuthConfig) XXX_Unmarshal added in v0.16.4

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

type Capability

type Capability struct {
	// List of capabilities to add.
	AddCapabilities []string `protobuf:"bytes,1,rep,name=add_capabilities,json=addCapabilities,proto3" json:"add_capabilities,omitempty"`
	// List of capabilities to drop.
	DropCapabilities []string `protobuf:"bytes,2,rep,name=drop_capabilities,json=dropCapabilities,proto3" json:"drop_capabilities,omitempty"`
	// List of ambient capabilities to add.
	AddAmbientCapabilities []string `` /* 129-byte string literal not displayed */
	XXX_NoUnkeyedLiteral   struct{} `json:"-"`
	XXX_sizecache          int32    `json:"-"`
}

Capability contains the container capabilities to add or drop Dropping a capability will drop it from all sets. If a capability is added to only the add_capabilities list then it gets added to permitted, inheritable, effective and bounding sets, i.e. all sets except the ambient set. If a capability is added to only the add_ambient_capabilities list then it gets added to all sets, i.e permitted inheritable, effective, bounding and ambient sets. If a capability is added to add_capabilities and add_ambient_capabilities lists then it gets added to all sets, i.e. permitted, inheritable, effective, bounding and ambient sets.

func (*Capability) Descriptor

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

func (*Capability) GetAddAmbientCapabilities added in v0.24.0

func (m *Capability) GetAddAmbientCapabilities() []string

func (*Capability) GetAddCapabilities

func (m *Capability) GetAddCapabilities() []string

func (*Capability) GetDropCapabilities

func (m *Capability) GetDropCapabilities() []string

func (*Capability) Marshal

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

func (*Capability) MarshalTo

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

func (*Capability) MarshalToSizedBuffer added in v0.16.4

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

func (*Capability) ProtoMessage

func (*Capability) ProtoMessage()

func (*Capability) Reset

func (m *Capability) Reset()

func (*Capability) Size

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

func (*Capability) String

func (this *Capability) String() string

func (*Capability) Unmarshal

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

func (*Capability) XXX_DiscardUnknown added in v0.16.4

func (m *Capability) XXX_DiscardUnknown()

func (*Capability) XXX_Marshal added in v0.16.4

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

func (*Capability) XXX_Merge added in v0.16.4

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

func (*Capability) XXX_Size added in v0.16.4

func (m *Capability) XXX_Size() int

func (*Capability) XXX_Unmarshal added in v0.16.4

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

type Container

type Container struct {
	// ID of the container, used by the container runtime to identify
	// a container.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the sandbox to which this container belongs.
	PodSandboxId string `protobuf:"bytes,2,opt,name=pod_sandbox_id,json=podSandboxId,proto3" json:"pod_sandbox_id,omitempty"`
	// Metadata of the container.
	Metadata *ContainerMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Spec of the image.
	Image *ImageSpec `protobuf:"bytes,4,opt,name=image,proto3" 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,proto3" json:"image_ref,omitempty"`
	// State of the container.
	State ContainerState `protobuf:"varint,6,opt,name=state,proto3,enum=runtime.v1alpha2.ContainerState" json:"state,omitempty"`
	// Creation time of the container in nanoseconds.
	CreatedAt int64 `protobuf:"varint,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Key-value pairs that may be used to scope and select individual resources.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Unstructured key-value map holding arbitrary metadata.
	// Annotations MUST NOT be altered by the runtime; the value of this field
	// MUST be identical to that of the corresponding ContainerConfig used to
	// instantiate this Container.
	Annotations          map[string]string `` /* 163-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

Container provides the runtime information for a container, such as ID, hash, state of the container.

func (*Container) Descriptor

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

func (*Container) GetAnnotations

func (m *Container) GetAnnotations() map[string]string

func (*Container) GetCreatedAt

func (m *Container) GetCreatedAt() int64

func (*Container) GetId

func (m *Container) GetId() string

func (*Container) GetImage

func (m *Container) GetImage() *ImageSpec

func (*Container) GetImageRef

func (m *Container) GetImageRef() string

func (*Container) GetLabels

func (m *Container) GetLabels() map[string]string

func (*Container) GetMetadata

func (m *Container) GetMetadata() *ContainerMetadata

func (*Container) GetPodSandboxId

func (m *Container) GetPodSandboxId() string

func (*Container) GetState

func (m *Container) GetState() ContainerState

func (*Container) Marshal

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

func (*Container) MarshalTo

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

func (*Container) MarshalToSizedBuffer added in v0.16.4

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

func (*Container) ProtoMessage

func (*Container) ProtoMessage()

func (*Container) Reset

func (m *Container) Reset()

func (*Container) Size

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

func (*Container) String

func (this *Container) String() string

func (*Container) Unmarshal

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

func (*Container) XXX_DiscardUnknown added in v0.16.4

func (m *Container) XXX_DiscardUnknown()

func (*Container) XXX_Marshal added in v0.16.4

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

func (*Container) XXX_Merge added in v0.16.4

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

func (*Container) XXX_Size added in v0.16.4

func (m *Container) XXX_Size() int

func (*Container) XXX_Unmarshal added in v0.16.4

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

type ContainerAttributes

type ContainerAttributes struct {
	// ID of the container.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Metadata of the container.
	Metadata *ContainerMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Key-value pairs that may be used to scope and select individual resources.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Unstructured key-value map holding arbitrary metadata.
	// Annotations MUST NOT be altered by the runtime; the value of this field
	// MUST be identical to that of the corresponding ContainerConfig used to
	// instantiate the Container this status represents.
	Annotations          map[string]string `` /* 163-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

ContainerAttributes provides basic information of the container.

func (*ContainerAttributes) Descriptor

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

func (*ContainerAttributes) GetAnnotations

func (m *ContainerAttributes) GetAnnotations() map[string]string

func (*ContainerAttributes) GetId

func (m *ContainerAttributes) GetId() string

func (*ContainerAttributes) GetLabels

func (m *ContainerAttributes) GetLabels() map[string]string

func (*ContainerAttributes) GetMetadata

func (m *ContainerAttributes) GetMetadata() *ContainerMetadata

func (*ContainerAttributes) Marshal

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

func (*ContainerAttributes) MarshalTo

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

func (*ContainerAttributes) MarshalToSizedBuffer added in v0.16.4

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

func (*ContainerAttributes) ProtoMessage

func (*ContainerAttributes) ProtoMessage()

func (*ContainerAttributes) Reset

func (m *ContainerAttributes) Reset()

func (*ContainerAttributes) Size

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

func (*ContainerAttributes) String

func (this *ContainerAttributes) String() string

func (*ContainerAttributes) Unmarshal

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

func (*ContainerAttributes) XXX_DiscardUnknown added in v0.16.4

func (m *ContainerAttributes) XXX_DiscardUnknown()

func (*ContainerAttributes) XXX_Marshal added in v0.16.4

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

func (*ContainerAttributes) XXX_Merge added in v0.16.4

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

func (*ContainerAttributes) XXX_Size added in v0.16.4

func (m *ContainerAttributes) XXX_Size() int

func (*ContainerAttributes) XXX_Unmarshal added in v0.16.4

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

type ContainerConfig

type ContainerConfig struct {
	// 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,proto3" json:"metadata,omitempty"`
	// Image to use.
	Image *ImageSpec `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// Command to execute (i.e., entrypoint for docker)
	Command []string `protobuf:"bytes,3,rep,name=command,proto3" json:"command,omitempty"`
	// Args for the Command (i.e., command for docker)
	Args []string `protobuf:"bytes,4,rep,name=args,proto3" json:"args,omitempty"`
	// Current working directory of the command.
	WorkingDir string `protobuf:"bytes,5,opt,name=working_dir,json=workingDir,proto3" json:"working_dir,omitempty"`
	// List of environment variable to set in the container.
	Envs []*KeyValue `protobuf:"bytes,6,rep,name=envs,proto3" json:"envs,omitempty"`
	// Mounts for the container.
	Mounts []*Mount `protobuf:"bytes,7,rep,name=mounts,proto3" json:"mounts,omitempty"`
	// Devices for the container.
	Devices []*Device `protobuf:"bytes,8,rep,name=devices,proto3" json:"devices,omitempty"`
	// 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 `` /* 153-byte string literal not displayed */
	// Unstructured key-value map that may be used by the kubelet to store and
	// retrieve arbitrary metadata.
	//
	// Annotations MUST NOT be altered by the runtime; the annotations stored
	// here MUST be returned in the ContainerStatus associated with the container
	// this ContainerConfig creates.
	//
	// In general, in order to preserve a well-defined interface between the
	// kubelet and the container runtime, annotations SHOULD NOT influence
	// runtime behaviour.
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// 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.
	L