Documentation ¶
Index ¶
- Constants
- Variables
- func AllContainersAreWindowsHostProcess(pod *v1.Pod) bool
- func BuildPodFullName(name, namespace string) string
- func ExpandContainerCommandAndArgs(container *v1.Container, envs []EnvVar) (command []string, args []string)
- func ExpandContainerCommandOnlyStatic(containerCommand []string, envs []v1.EnvVar) (command []string)
- func ExpandContainerVolumeMounts(mount v1.VolumeMount, envs []EnvVar) (string, error)
- func FilterEventRecorder(recorder record.EventRecorder) record.EventRecorder
- func GenerateContainerRef(pod *v1.Pod, container *v1.Container) (*v1.ObjectReference, error)
- func GetContainerSpec(pod *v1.Pod, containerName string) *v1.Container
- func GetPodFullName(pod *v1.Pod) string
- func HandleResizing(resize <-chan remotecommand.TerminalSize, ...)
- func HasPrivilegedContainer(pod *v1.Pod) bool
- func HasWindowsHostProcessContainer(pod *v1.Pod) bool
- func HashContainer(container *v1.Container) uint64
- func IsHostNetworkPod(pod *v1.Pod) bool
- func ParsePodFullName(podFullName string) (string, string, error)
- func ShouldContainerBeRestarted(container *v1.Container, pod *v1.Pod, podStatus *PodStatus) bool
- type Annotation
- type Attacher
- type Cache
- type CommandRunner
- type Container
- type ContainerID
- type DeviceInfo
- type DockerID
- type EnvVar
- type GC
- type GCPolicy
- type HandlerRunner
- type Image
- type ImageService
- type ImageSpec
- type ImageStats
- type Mount
- type OSInterface
- type Option
- type Pod
- type PodPair
- type PodStatus
- type PodSyncResult
- type Pods
- type PortMapping
- type RealOS
- func (RealOS) Chmod(path string, perm os.FileMode) error
- func (RealOS) Chtimes(path string, atime time.Time, mtime time.Time) error
- func (RealOS) Create(path string) (*os.File, error)
- func (RealOS) Glob(pattern string) ([]string, error)
- func (RealOS) Hostname() (name string, err error)
- func (RealOS) MkdirAll(path string, perm os.FileMode) error
- func (RealOS) Open(name string) (*os.File, error)
- func (RealOS) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
- func (RealOS) Pipe() (r *os.File, w *os.File, err error)
- func (RealOS) ReadDir(dirname string) ([]os.DirEntry, error)
- func (RealOS) Remove(path string) error
- func (RealOS) RemoveAll(path string) error
- func (RealOS) Rename(oldpath, newpath string) error
- func (RealOS) Stat(path string) (os.FileInfo, error)
- func (RealOS) Symlink(oldname string, newname string) error
- type RunContainerOptions
- type Runtime
- type RuntimeCache
- type RuntimeCondition
- type RuntimeConditionType
- type RuntimeHelper
- type RuntimeStatus
- type SortContainerStatusesByCreationTime
- type SourcesReadyProvider
- type State
- type Status
- type StreamingRuntime
- type SyncAction
- type SyncResult
- type TestRuntimeCache
- type Version
- type VolumeInfo
- type VolumeMap
Constants ¶
const ( // MaxPodTerminationMessageLogLength is the maximum bytes any one pod may have written // as termination message output across all containers. Containers will be evenly truncated // until output is below this limit. MaxPodTerminationMessageLogLength = 1024 * 12 // MaxContainerTerminationMessageLength is the upper bound any one container may write to // its termination message path. Contents above this length will be truncated. MaxContainerTerminationMessageLength = 1024 * 4 // MaxContainerTerminationMessageLogLength is the maximum bytes any one container will // have written to its termination message when the message is read from the logs. MaxContainerTerminationMessageLogLength = 1024 * 2 // MaxContainerTerminationMessageLogLines is the maximum number of previous lines of // log output that the termination message can contain. MaxContainerTerminationMessageLogLines = 80 )
Variables ¶
var ( // ErrRunContainer returned when runtime failed to start any of pod's container. ErrRunContainer = errors.New("RunContainerError") // ErrKillContainer returned when runtime failed to kill any of pod's containers. ErrKillContainer = errors.New("KillContainerError") // ErrCreatePodSandbox returned when runtime failed to create a sandbox for pod. ErrCreatePodSandbox = errors.New("CreatePodSandboxError") // ErrConfigPodSandbox returned when runetime failed to get pod sandbox config from pod. ErrConfigPodSandbox = errors.New("ConfigPodSandboxError") // ErrKillPodSandbox returned when runtime failed to stop pod's sandbox. ErrKillPodSandbox = errors.New("KillPodSandboxError") )
var ( // ErrContainerNotFound returned when a container in the given pod with the // given container name was not found, amongst those managed by the kubelet. ErrContainerNotFound = errors.New("no matching container") )
var ErrCrashLoopBackOff = errors.New("CrashLoopBackOff")
ErrCrashLoopBackOff returned when a container Terminated and Kubelet is backing off the restart.
var ImplicitContainerPrefix = "implicitly required container "
ImplicitContainerPrefix is a container name prefix that will indicate that container was started implicitly (like the pod infra container).
Functions ¶
func AllContainersAreWindowsHostProcess ¶ added in v1.22.0
AllContainersAreWindowsHostProcess returns true if all containers in a pod are HostProcess containers.
func BuildPodFullName ¶
BuildPodFullName builds the pod full name from pod name and namespace.
func ExpandContainerCommandAndArgs ¶ added in v0.18.0
func ExpandContainerCommandAndArgs(container *v1.Container, envs []EnvVar) (command []string, args []string)
ExpandContainerCommandAndArgs expands the given Container's command by replacing variable references `with the values of given EnvVar.
func ExpandContainerCommandOnlyStatic ¶ added in v1.6.0
func ExpandContainerCommandOnlyStatic(containerCommand []string, envs []v1.EnvVar) (command []string)
ExpandContainerCommandOnlyStatic substitutes only static environment variable values from the container environment definitions. This does *not* include valueFrom substitutions. TODO: callers should use ExpandContainerCommandAndArgs with a fully resolved list of environment.
func ExpandContainerVolumeMounts ¶ added in v1.11.0
func ExpandContainerVolumeMounts(mount v1.VolumeMount, envs []EnvVar) (string, error)
ExpandContainerVolumeMounts expands the subpath of the given VolumeMount by replacing variable references with the values of given EnvVar.
func FilterEventRecorder ¶ added in v1.2.0
func FilterEventRecorder(recorder record.EventRecorder) record.EventRecorder
FilterEventRecorder creates an event recorder to record object's event except implicitly required container's, like infra container.
func GenerateContainerRef ¶ added in v0.15.0
GenerateContainerRef returns an *v1.ObjectReference which references the given container within the given pod. Returns an error if the reference can't be constructed or the container doesn't actually belong to the pod.
func GetContainerSpec ¶ added in v1.6.0
GetContainerSpec gets the container spec by containerName.
func GetPodFullName ¶
GetPodFullName returns a name that uniquely identifies a pod.
func HandleResizing ¶ added in v1.4.0
func HandleResizing(resize <-chan remotecommand.TerminalSize, resizeFunc func(size remotecommand.TerminalSize))
HandleResizing spawns a goroutine that processes the resize channel, calling resizeFunc for each remotecommand.TerminalSize received from the channel. The resize channel must be closed elsewhere to stop the goroutine.
func HasPrivilegedContainer ¶ added in v1.6.0
HasPrivilegedContainer returns true if any of the containers in the pod are privileged.
func HasWindowsHostProcessContainer ¶ added in v1.22.0
HasWindowsHostProcessContainer returns true if any of the containers in a pod are HostProcess containers.
func HashContainer ¶ added in v0.18.0
HashContainer returns the hash of the container. It is used to compare the running container with its desired spec. Note: remember to update hashValues in container_hash_test.go as well.
func IsHostNetworkPod ¶ added in v1.3.0
IsHostNetworkPod returns whether the host networking requested for the given Pod. Pod must not be nil.
func ParsePodFullName ¶
ParsePodFullName parsed the pod full name.
Types ¶
type Annotation ¶ added in v1.10.0
Annotation represents an annotation.
type Attacher ¶ added in v1.19.0
type Attacher interface {
AttachContainer(ctx context.Context, id ContainerID, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool, resize <-chan remotecommand.TerminalSize) (err error)
}
Attacher interface allows to attach a container.
type Cache ¶ added in v1.2.0
type Cache interface { Get(types.UID) (*PodStatus, error) // Set updates the cache by setting the PodStatus for the pod only // if the data is newer than the cache based on the provided // time stamp. Returns if the cache was updated. Set(types.UID, *PodStatus, error, time.Time) (updated bool) // GetNewerThan is a blocking call that only returns the status // when it is newer than the given time. GetNewerThan(types.UID, time.Time) (*PodStatus, error) Delete(types.UID) UpdateTime(time.Time) }
Cache stores the PodStatus for the pods. It represents *all* the visible pods/containers in the container runtime. All cache entries are at least as new or newer than the global timestamp (set by UpdateTime()), while individual entries may be slightly newer than the global timestamp. If a pod has no states known by the runtime, Cache returns an empty PodStatus object with ID populated.
Cache provides two methods to retrieve the PodStatus: the non-blocking Get() and the blocking GetNewerThan() method. The component responsible for populating the cache is expected to call Delete() to explicitly free the cache entries.
type CommandRunner ¶ added in v1.19.0
type CommandRunner interface { // RunInContainer synchronously executes the command in the container, and returns the output. // If the command completes with a non-0 exit code, a k8s.io/utils/exec.ExitError will be returned. RunInContainer(ctx context.Context, id ContainerID, cmd []string, timeout time.Duration) ([]byte, error) }
CommandRunner interface allows to run command in a container.
type Container ¶
type Container struct { // The ID of the container, used by the container runtime to identify // a container. ID ContainerID // The name of the container, which should be the same as specified by // v1.Container. Name string // The image name of the container, this also includes the tag of the image, // the expected form is "NAME:TAG". Image string // The id of the image used by the container. ImageID string // Hash of the container, used for comparison. Optional for containers // not managed by kubelet. Hash uint64 // State is the state of the container. State State }
Container provides the runtime information for a container, such as ID, hash, state of the container.
type ContainerID ¶ added in v0.16.0
type ContainerID struct { // The type of the container runtime. e.g. 'docker'. Type string // The identification of the container, this is comsumable by // the underlying container runtime. (Note that the container // runtime interface still takes the whole struct as input). ID string }
ContainerID is a type that identifies a container.
func BuildContainerID ¶ added in v0.16.0
func BuildContainerID(typ, ID string) ContainerID
BuildContainerID returns the ContainerID given type and id.
func ParseContainerID ¶ added in v1.2.0
func ParseContainerID(containerID string) ContainerID
ParseContainerID is a convenience method for creating a ContainerID from an ID string.
func (*ContainerID) IsEmpty ¶ added in v1.2.0
func (c *ContainerID) IsEmpty() bool
IsEmpty returns whether given ContainerID is empty.
func (*ContainerID) MarshalJSON ¶ added in v0.16.0
func (c *ContainerID) MarshalJSON() ([]byte, error)
MarshalJSON formats a given ContainerID into a byte array.
func (*ContainerID) ParseString ¶ added in v0.16.0
func (c *ContainerID) ParseString(data string) error
ParseString converts given string into ContainerID
func (*ContainerID) String ¶ added in v0.16.0
func (c *ContainerID) String() string
func (*ContainerID) UnmarshalJSON ¶ added in v0.16.0
func (c *ContainerID) UnmarshalJSON(data []byte) error
UnmarshalJSON parses ContainerID from a given array of bytes.
type DeviceInfo ¶ added in v1.5.0
type DeviceInfo struct { // Path on host for mapping PathOnHost string // Path in Container to map PathInContainer string // Cgroup permissions Permissions string }
DeviceInfo contains information about the device.
type DockerID ¶ added in v1.2.0
type DockerID string
DockerID is an ID of docker container. It is a type to make it clear when we're working with docker container Ids
func (DockerID) ContainerID ¶ added in v1.2.0
func (id DockerID) ContainerID() ContainerID
ContainerID converts DockerID into a ContainerID.
type GC ¶ added in v1.19.0
type GC interface { // Garbage collect containers. GarbageCollect(ctx context.Context) error // Deletes all unused containers, including containers belonging to pods that are terminated but not deleted DeleteAllUnusedContainers(ctx context.Context) error }
GC manages garbage collection of dead containers.
Implementation is thread-compatible.
func NewContainerGC ¶ added in v1.2.0
func NewContainerGC(runtime Runtime, policy GCPolicy, sourcesReadyProvider SourcesReadyProvider) (GC, error)
NewContainerGC creates a new instance of GC with the specified policy.
type GCPolicy ¶ added in v1.19.0
type GCPolicy struct { // Minimum age at which a container can be garbage collected, zero for no limit. MinAge time.Duration // Max number of dead containers any single pod (UID, container name) pair is // allowed to have, less than zero for no limit. MaxPerPodContainer int // Max number of total dead containers, less than zero for no limit. MaxContainers int }
GCPolicy specifies a policy for garbage collecting containers.
type HandlerRunner ¶ added in v0.16.0
type HandlerRunner interface {
Run(ctx context.Context, containerID ContainerID, pod *v1.Pod, container *v1.Container, handler *v1.LifecycleHandler) (string, error)
}
HandlerRunner runs a lifecycle handler for a container.
type Image ¶ added in v0.17.0
type Image struct { // ID of the image. ID string // Other names by which this image is known. RepoTags []string // Digests by which this image is known. RepoDigests []string // The size of the image in bytes. Size int64 // ImageSpec for the image which include annotations. Spec ImageSpec // Pin for preventing garbage collection Pinned bool }
Image contains basic information about a container image.
type ImageService ¶ added in v1.5.0
type ImageService interface { // PullImage pulls an image from the network to local storage using the supplied // secrets if necessary. It returns a reference (digest or ID) to the pulled image. PullImage(ctx context.Context, image ImageSpec, pullSecrets []v1.Secret, podSandboxConfig *runtimeapi.PodSandboxConfig) (string, error) // GetImageRef gets the reference (digest or ID) of the image which has already been in // the local storage. It returns ("", nil) if the image isn't in the local storage. GetImageRef(ctx context.Context, image ImageSpec) (string, error) // ListImages gets all images currently on the machine. ListImages(ctx context.Context) ([]Image, error) // RemoveImage removes the specified image. RemoveImage(ctx context.Context, image ImageSpec) error // ImageStats returns Image statistics. ImageStats(ctx context.Context) (*ImageStats, error) }
ImageService interfaces allows to work with image service.
type ImageSpec ¶ added in v0.17.0
type ImageSpec struct { // ID of the image. Image string // The annotations for the image. // This should be passed to CRI during image pulls and returned when images are listed. Annotations []Annotation }
ImageSpec is an internal representation of an image. Currently, it wraps the value of a Container's Image field, but in the future it will include more detailed information about the different image types.
type ImageStats ¶ added in v1.3.0
type ImageStats struct { // Total amount of storage consumed by existing images. TotalStorageBytes uint64 }
ImageStats contains statistics about all the images currently available.
type Mount ¶ added in v0.18.0
type Mount struct { // Name of the volume mount. // TODO(yifan): Remove this field, as this is not representing the unique name of the mount, // but the volume name only. Name string // Path of the mount within the container. ContainerPath string // Path of the mount on the host. HostPath string // Whether the mount is read-only. ReadOnly bool // Whether the mount needs SELinux relabeling SELinuxRelabel bool // Requested propagation mode Propagation runtimeapi.MountPropagation }
Mount represents a volume mount.
type OSInterface ¶ added in v0.16.0
type OSInterface interface { MkdirAll(path string, perm os.FileMode) error Symlink(oldname string, newname string) error Stat(path string) (os.FileInfo, error) Remove(path string) error RemoveAll(path string) error Create(path string) (*os.File, error) Chmod(path string, perm os.FileMode) error Hostname() (name string, err error) Chtimes(path string, atime time.Time, mtime time.Time) error Pipe() (r *os.File, w *os.File, err error) ReadDir(dirname string) ([]os.DirEntry, error) Glob(pattern string) ([]string, error) Open(name string) (*os.File, error) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error) Rename(oldpath, newpath string) error }
OSInterface collects system level operations that need to be mocked out during tests.
type Option ¶ added in v1.2.0
type Option func(Runtime)
Option is a functional option type for Runtime, useful for completely optional settings.
type Pod ¶
type Pod struct { // The ID of the pod, which can be used to retrieve a particular pod // from the pod list returned by GetPods(). ID types.UID // The name and namespace of the pod, which is readable by human. Name string Namespace string // Creation timestamps of the Pod in nanoseconds. CreatedAt uint64 // List of containers that belongs to this pod. It may contain only // running containers, or mixed with dead ones (when GetPods(true)). Containers []*Container // List of sandboxes associated with this pod. The sandboxes are converted // to Container temporarily to avoid substantial changes to other // components. This is only populated by kuberuntime. // TODO: use the runtimeApi.PodSandbox type directly. Sandboxes []*Container }
Pod is a group of containers.
func ConvertPodStatusToRunningPod ¶ added in v1.2.0
ConvertPodStatusToRunningPod returns Pod given PodStatus and container runtime string. TODO(random-liu): Convert PodStatus to running Pod, should be deprecated soon
func (*Pod) FindContainerByID ¶ added in v1.2.0
func (p *Pod) FindContainerByID(id ContainerID) *Container
FindContainerByID returns a container in the pod with the given ContainerID.
func (*Pod) FindContainerByName ¶
FindContainerByName returns a container in the pod with the given name. When there are multiple containers with the same name, the first match will be returned.
func (*Pod) FindSandboxByID ¶ added in v1.5.0
func (p *Pod) FindSandboxByID(id ContainerID) *Container
FindSandboxByID returns a sandbox in the pod with the given ContainerID.
type PodPair ¶ added in v1.2.0
type PodPair struct { // APIPod is the v1.Pod APIPod *v1.Pod // RunningPod is the pod defined in pkg/kubelet/container/runtime#Pod RunningPod *Pod }
PodPair contains both runtime#Pod and api#Pod
type PodStatus ¶ added in v1.2.0
type PodStatus struct { // ID of the pod. ID types.UID // Name of the pod. Name string // Namespace of the pod. Namespace string // All IPs assigned to this pod IPs []string // Status of containers in the pod. ContainerStatuses []*Status // Status of the pod sandbox. // Only for kuberuntime now, other runtime may keep it nil. SandboxStatuses []*runtimeapi.PodSandboxStatus // Timestamp at which container and pod statuses were recorded TimeStamp time.Time }
PodStatus represents the status of the pod and its containers. v1.PodStatus can be derived from examining PodStatus and v1.Pod.
func (*PodStatus) FindContainerStatusByName ¶ added in v1.2.0
FindContainerStatusByName returns container status in the pod status with the given name. When there are multiple containers' statuses with the same name, the first match will be returned.
func (*PodStatus) GetRunningContainerStatuses ¶ added in v1.2.0
GetRunningContainerStatuses returns container status of all the running containers in a pod
type PodSyncResult ¶ added in v1.2.0
type PodSyncResult struct { // Result of different sync actions SyncResults []*SyncResult // Error encountered in SyncPod() and KillPod() that is not already included in SyncResults SyncError error }
PodSyncResult is the summary result of SyncPod() and KillPod()
func (*PodSyncResult) AddPodSyncResult ¶ added in v1.2.0
func (p *PodSyncResult) AddPodSyncResult(result PodSyncResult)
AddPodSyncResult merges a PodSyncResult to current one
func (*PodSyncResult) AddSyncResult ¶ added in v1.2.0
func (p *PodSyncResult) AddSyncResult(result ...*SyncResult)
AddSyncResult adds multiple SyncResult to current PodSyncResult
func (*PodSyncResult) Error ¶ added in v1.2.0
func (p *PodSyncResult) Error() error
Error returns an error summarizing all the errors in PodSyncResult
func (*PodSyncResult) Fail ¶ added in v1.2.0
func (p *PodSyncResult) Fail(err error)
Fail fails the PodSyncResult with an error occurred in SyncPod() and KillPod() itself
type Pods ¶
type Pods []*Pod
Pods represents the list of pods
func (Pods) FindPod ¶ added in v0.15.0
FindPod combines FindPodByID and FindPodByFullName, it finds and returns a pod in the pod list either by the full name or the pod ID. It will return an empty pod if not found.
func (Pods) FindPodByFullName ¶ added in v0.15.0
FindPodByFullName finds and returns a pod in the pod list by the full name. It will return an empty pod if not found.
type PortMapping ¶ added in v0.18.0
type PortMapping struct { // Protocol of the port mapping. Protocol v1.Protocol // The port number within the container. ContainerPort int // The port number on the host. HostPort int // The host IP. HostIP string }
PortMapping contains information about the port mapping.
func MakePortMappings ¶ added in v1.6.0
func MakePortMappings(container *v1.Container) (ports []PortMapping)
MakePortMappings creates internal port mapping from api port mapping.
type RealOS ¶ added in v0.16.0
type RealOS struct{}
RealOS is used to dispatch the real system level operations.
func (RealOS) Chmod ¶ added in v1.6.0
Chmod will change the permissions on the specified path or return an error.
func (RealOS) Chtimes ¶ added in v1.3.0
Chtimes will call os.Chtimes to change the atime and mtime of the path
func (RealOS) Create ¶ added in v1.3.0
Create will call os.Create to create and return a file at path.
func (RealOS) Glob ¶ added in v1.5.0
Glob will call filepath.Glob to return the names of all files matching pattern.
func (RealOS) ReadDir ¶ added in v1.3.0
ReadDir will call os.ReadDir to return the files under the directory.
func (RealOS) RemoveAll ¶ added in v1.5.0
RemoveAll will call os.RemoveAll to remove the path and its children.
type RunContainerOptions ¶
type RunContainerOptions struct { // The environment variables list. Envs []EnvVar // The mounts for the containers. Mounts []Mount // The host devices mapped into the containers. Devices []DeviceInfo // The annotations for the container // These annotations are generated by other components (i.e., // not users). Currently, only device plugins populate the annotations. Annotations []Annotation // If the container has specified the TerminationMessagePath, then // this directory will be used to create and mount the log file to // container.TerminationMessagePath PodContainerDir string // The type of container rootfs ReadOnly bool // hostname for pod containers Hostname string // EnableHostUserNamespace sets userns=host when users request host namespaces (pid, ipc, net), // are using non-namespaced capabilities (mknod, sys_time, sys_module), the pod contains a privileged container, // or using host path volumes. // This should only be enabled when the container runtime is performing user remapping AND if the // experimental behavior is desired. EnableHostUserNamespace bool }
RunContainerOptions specify the options which are necessary for running containers
type Runtime ¶
type Runtime interface { // Type returns the type of the container runtime. Type() string // Version returns the version information of the container runtime. Version(ctx context.Context) (Version, error) // APIVersion returns the cached API version information of the container // runtime. Implementation is expected to update this cache periodically. // This may be different from the runtime engine's version. // TODO(random-liu): We should fold this into Version() APIVersion() (Version, error) // Status returns the status of the runtime. An error is returned if the Status // function itself fails, nil otherwise. Status(ctx context.Context) (*RuntimeStatus, error) // GetPods returns a list of containers grouped by pods. The boolean parameter // specifies whether the runtime returns all containers including those already // exited and dead containers (used for garbage collection). GetPods(ctx context.Context, all bool) ([]*Pod, error) // GarbageCollect removes dead containers using the specified container gc policy // If allSourcesReady is not true, it means that kubelet doesn't have the // complete list of pods from all available sources (e.g., apiserver, http, // file). In this case, garbage collector should refrain itself from aggressive // behavior such as removing all containers of unrecognized pods (yet). // If evictNonDeletedPods is set to true, containers and sandboxes belonging to pods // that are terminated, but not deleted will be evicted. Otherwise, only deleted pods // will be GC'd. // TODO: Revisit this method and make it cleaner. GarbageCollect(ctx context.Context, gcPolicy GCPolicy, allSourcesReady bool, evictNonDeletedPods bool) error // SyncPod syncs the running pod into the desired pod. SyncPod(ctx context.Context, pod *v1.Pod, podStatus *PodStatus, pullSecrets []v1.Secret, backOff *flowcontrol.Backoff) PodSyncResult // KillPod kills all the containers of a pod. Pod may be nil, running pod must not be. // TODO(random-liu): Return PodSyncResult in KillPod. // gracePeriodOverride if specified allows the caller to override the pod default grace period. // only hard kill paths are allowed to specify a gracePeriodOverride in the kubelet in order to not corrupt user data. // it is useful when doing SIGKILL for hard eviction scenarios, or max grace period during soft eviction scenarios. KillPod(ctx context.Context, pod *v1.Pod, runningPod Pod, gracePeriodOverride *int64) error // GetPodStatus retrieves the status of the pod, including the // information of all containers in the pod that are visible in Runtime. GetPodStatus(ctx context.Context, uid types.UID, name, namespace string) (*PodStatus, error) // TODO(vmarmol): Unify pod and containerID args. // GetContainerLogs returns logs of a specific container. By // default, it returns a snapshot of the container log. Set 'follow' to true to // stream the log. Set 'follow' to false and specify the number of lines (e.g. // "100" or "all") to tail the log. GetContainerLogs(ctx context.Context, pod *v1.Pod, containerID ContainerID, logOptions *v1.PodLogOptions, stdout, stderr io.Writer) (err error) // DeleteContainer deletes a container. If the container is still running, an error is returned. DeleteContainer(ctx context.Context, containerID ContainerID) error // ImageService provides methods to image-related methods. ImageService // UpdatePodCIDR sends a new podCIDR to the runtime. // This method just proxies a new runtimeConfig with the updated // CIDR value down to the runtime shim. UpdatePodCIDR(ctx context.Context, podCIDR string) error // CheckpointContainer tells the runtime to checkpoint a container // and store the resulting archive to the checkpoint directory. CheckpointContainer(ctx context.Context, options *runtimeapi.CheckpointContainerRequest) error // Generate pod status from the CRI event GeneratePodStatus(event *runtimeapi.ContainerEventResponse) (*PodStatus, error) // ListMetricDescriptors gets the descriptors for the metrics that will be returned in ListPodSandboxMetrics. // This list should be static at startup: either the client and server restart together when // adding or removing metrics descriptors, or they should not change. // Put differently, if ListPodSandboxMetrics references a name that is not described in the initial // ListMetricDescriptors call, then the metric will not be broadcasted. ListMetricDescriptors(ctx context.Context) ([]*runtimeapi.MetricDescriptor, error) // ListPodSandboxMetrics retrieves the metrics for all pod sandboxes. ListPodSandboxMetrics(ctx context.Context) ([]*runtimeapi.PodSandboxMetrics, error) }
Runtime interface defines the interfaces that should be implemented by a container runtime. Thread safety is required from implementations of this interface.
type RuntimeCache ¶
type RuntimeCache interface { GetPods(context.Context) ([]*Pod, error) ForceUpdateIfOlder(context.Context, time.Time) error }
RuntimeCache is in interface for obtaining cached Pods.
func NewRuntimeCache ¶
func NewRuntimeCache(getter podsGetter) (RuntimeCache, error)
NewRuntimeCache creates a container runtime cache.
type RuntimeCondition ¶ added in v1.5.0
type RuntimeCondition struct { // Type of runtime condition. Type RuntimeConditionType // Status of the condition, one of true/false. Status bool // Reason is brief reason for the condition's last transition. Reason string // Message is human readable message indicating details about last transition. Message string }
RuntimeCondition contains condition information for the runtime.
func (*RuntimeCondition) String ¶ added in v1.5.0
func (c *RuntimeCondition) String() string
String formats the runtime condition into human readable string.
type RuntimeConditionType ¶ added in v1.5.0
type RuntimeConditionType string
RuntimeConditionType is the types of required runtime conditions.
const ( // RuntimeReady means the runtime is up and ready to accept basic containers. RuntimeReady RuntimeConditionType = "RuntimeReady" // NetworkReady means the runtime network is up and ready to accept containers which require network. NetworkReady RuntimeConditionType = "NetworkReady" )
type RuntimeHelper ¶ added in v1.2.0
type RuntimeHelper interface { GenerateRunContainerOptions(ctx context.Context, pod *v1.Pod, container *v1.Container, podIP string, podIPs []string) (contOpts *RunContainerOptions, cleanupAction func(), err error) GetPodDNS(pod *v1.Pod) (dnsConfig *runtimeapi.DNSConfig, err error) // GetPodCgroupParent returns the CgroupName identifier, and its literal cgroupfs form on the host // of a pod. GetPodCgroupParent(pod *v1.Pod) string GetPodDir(podUID types.UID) string GeneratePodHostNameAndDomain(pod *v1.Pod) (hostname string, hostDomain string, err error) // GetExtraSupplementalGroupsForPod returns a list of the extra // supplemental groups for the Pod. These extra supplemental groups come // from annotations on persistent volumes that the pod depends on. GetExtraSupplementalGroupsForPod(pod *v1.Pod) []int64 // GetOrCreateUserNamespaceMappings returns the configuration for the sandbox user namespace GetOrCreateUserNamespaceMappings(pod *v1.Pod) (*runtimeapi.UserNamespace, error) // PrepareDynamicResources prepares resources for a pod. PrepareDynamicResources(pod *v1.Pod) error // UnprepareDynamicResources unprepares resources for a a pod. UnprepareDynamicResources(pod *v1.Pod) error }
RuntimeHelper wraps kubelet to make container runtime able to get necessary informations like the RunContainerOptions, DNS settings, Host IP.
type RuntimeStatus ¶ added in v1.5.0
type RuntimeStatus struct { // Conditions is an array of current observed runtime conditions. Conditions []RuntimeCondition }
RuntimeStatus contains the status of the runtime.
func (*RuntimeStatus) GetRuntimeCondition ¶ added in v1.5.0
func (r *RuntimeStatus) GetRuntimeCondition(t RuntimeConditionType) *RuntimeCondition
GetRuntimeCondition gets a specified runtime condition from the runtime status.
func (*RuntimeStatus) String ¶ added in v1.5.0
func (r *RuntimeStatus) String() string
String formats the runtime status into human readable string.
type SortContainerStatusesByCreationTime ¶ added in v1.2.0
type SortContainerStatusesByCreationTime []*Status
SortContainerStatusesByCreationTime sorts the container statuses by creation time.
func (SortContainerStatusesByCreationTime) Len ¶ added in v1.2.0
func (s SortContainerStatusesByCreationTime) Len() int
func (SortContainerStatusesByCreationTime) Less ¶ added in v1.2.0
func (s SortContainerStatusesByCreationTime) Less(i, j int) bool
func (SortContainerStatusesByCreationTime) Swap ¶ added in v1.2.0
func (s SortContainerStatusesByCreationTime) Swap(i, j int)
type SourcesReadyProvider ¶ added in v1.7.0
type SourcesReadyProvider interface { // AllReady returns true if the currently configured sources have all been seen. AllReady() bool }
SourcesReadyProvider knows how to determine if configuration sources are ready
type State ¶ added in v1.19.0
type State string
State represents the state of a container
const ( // ContainerStateCreated indicates a container that has been created (e.g. with docker create) but not started. ContainerStateCreated State = "created" // ContainerStateRunning indicates a currently running container. ContainerStateRunning State = "running" // ContainerStateExited indicates a container that ran and completed ("stopped" in other contexts, although a created container is technically also "stopped"). ContainerStateExited State = "exited" // ContainerStateUnknown encompasses all the states that we currently don't care about (like restarting, paused, dead). ContainerStateUnknown State = "unknown" )
func SandboxToContainerState ¶ added in v1.5.0
func SandboxToContainerState(state runtimeapi.PodSandboxState) State
SandboxToContainerState converts runtimeapi.PodSandboxState to kubecontainer.State. This is only needed because we need to return sandboxes as if they were kubecontainer.Containers to avoid substantial changes to PLEG. TODO: Remove this once it becomes obsolete.
type Status ¶ added in v1.19.0
type Status struct { // ID of the container. ID ContainerID // Name of the container. Name string // Status of the container. State State // Creation time of the container. CreatedAt time.Time // Start time of the container. StartedAt time.Time // Finish time of the container. FinishedAt time.Time // Exit code of the container. ExitCode int // Name of the image, this also includes the tag of the image, // the expected form is "NAME:TAG". Image string // ID of the image. ImageID string // Hash of the container, used for comparison. Hash uint64 // Number of times that the container has been restarted. RestartCount int // A string explains why container is in such a status. Reason string // Message written by the container before exiting (stored in // TerminationMessagePath). Message string }
Status represents the status of a container.
type StreamingRuntime ¶ added in v1.11.0
type StreamingRuntime interface { GetExec(ctx context.Context, id ContainerID, cmd []string, stdin, stdout, stderr, tty bool) (*url.URL, error) GetAttach(ctx context.Context, id ContainerID, stdin, stdout, stderr, tty bool) (*url.URL, error) GetPortForward(ctx context.Context, podName, podNamespace string, podUID types.UID, ports []int32) (*url.URL, error) }
StreamingRuntime is the interface implemented by runtimes that handle the serving of the streaming calls (exec/attach/port-forward) themselves. In this case, Kubelet should redirect to the runtime server.
type SyncAction ¶ added in v1.2.0
type SyncAction string
SyncAction indicates different kind of actions in SyncPod() and KillPod(). Now there are only actions about start/kill container and setup/teardown network.
const ( // StartContainer action StartContainer SyncAction = "StartContainer" // KillContainer action KillContainer SyncAction = "KillContainer" // SetupNetwork action SetupNetwork SyncAction = "SetupNetwork" // TeardownNetwork action TeardownNetwork SyncAction = "TeardownNetwork" // InitContainer action InitContainer SyncAction = "InitContainer" // CreatePodSandbox action CreatePodSandbox SyncAction = "CreatePodSandbox" // ConfigPodSandbox action ConfigPodSandbox SyncAction = "ConfigPodSandbox" // KillPodSandbox action KillPodSandbox SyncAction = "KillPodSandbox" )
type SyncResult ¶ added in v1.2.0
type SyncResult struct { // The associated action of the result Action SyncAction // The target of the action, now the target can only be: // * Container: Target should be container name // * Network: Target is useless now, we just set it as pod full name now Target interface{} // Brief error reason Error error // Human readable error reason Message string }
SyncResult is the result of sync action.
func NewSyncResult ¶ added in v1.2.0
func NewSyncResult(action SyncAction, target interface{}) *SyncResult
NewSyncResult generates new SyncResult with specific Action and Target
func (*SyncResult) Fail ¶ added in v1.2.0
func (r *SyncResult) Fail(err error, msg string)
Fail fails the SyncResult with specific error and message
type TestRuntimeCache ¶ added in v1.3.0
type TestRuntimeCache struct {
// contains filtered or unexported fields
}
TestRuntimeCache embeds runtimeCache with some additional methods for testing. It must be declared in the container package to have visibility to runtimeCache. It cannot be in a "..._test.go" file in order for runtime_cache_test.go to have cross-package visibility to it. (cross-package declarations in test files cannot be used from dot imports if this package is vendored)
func NewTestRuntimeCache ¶ added in v1.3.0
func NewTestRuntimeCache(getter podsGetter) *TestRuntimeCache
NewTestRuntimeCache creates a new instance of TestRuntimeCache.
func (*TestRuntimeCache) ForceUpdateIfOlder ¶ added in v1.3.0
func (*TestRuntimeCache) GetCachedPods ¶ added in v1.3.0
func (r *TestRuntimeCache) GetCachedPods() []*Pod
GetCachedPods returns the cached pods.
func (*TestRuntimeCache) GetPods ¶ added in v1.3.0
GetPods returns the cached pods if they are not outdated; otherwise, it retrieves the latest pods and return them.
func (*TestRuntimeCache) UpdateCacheWithLock ¶ added in v1.3.0
func (r *TestRuntimeCache) UpdateCacheWithLock() error
UpdateCacheWithLock updates the cache with the lock.
type Version ¶ added in v0.16.0
type Version interface { // Compare compares two versions of the runtime. On success it returns -1 // if the version is less than the other, 1 if it is greater than the other, // or 0 if they are equal. Compare(other string) (int, error) // String returns a string that represents the version. String() string }
Version interface allow to consume the runtime versions - compare and format to string.
type VolumeInfo ¶ added in v1.2.0
type VolumeInfo struct { // Mounter is the volume's mounter Mounter volume.Mounter // BlockVolumeMapper is the Block volume's mapper BlockVolumeMapper volume.BlockVolumeMapper // SELinuxLabeled indicates whether this volume has had the // pod's SELinux label applied to it or not SELinuxLabeled bool // Whether the volume permission is set to read-only or not // This value is passed from volume.spec ReadOnly bool // Inner volume spec name, which is the PV name if used, otherwise // it is the same as the outer volume spec name. InnerVolumeSpecName string }
VolumeInfo contains information about the volume.
type VolumeMap ¶ added in v0.17.0
type VolumeMap map[string]VolumeInfo
VolumeMap represents the map of volumes.