Documentation ¶
Index ¶
- Constants
- Variables
- func BuildPodFullName(name, namespace string) string
- func EnvVarsToMap(envs []EnvVar) map[string]string
- func ExpandContainerCommandAndArgs(container *api.Container, envs []EnvVar) (command []string, args []string)
- func FilterEventRecorder(recorder record.EventRecorder) record.EventRecorder
- func GenerateContainerRef(pod *api.Pod, container *api.Container) (*api.ObjectReference, error)
- func GetPodFullName(pod *api.Pod) string
- func HashContainer(container *api.Container) uint64
- func ParsePodFullName(podFullName string) (string, string, error)
- func ShouldContainerBeRestarted(container *api.Container, pod *api.Pod, podStatus *PodStatus) bool
- func StartPty(c *exec.Cmd) (*os.File, error)
- type Cache
- type Container
- type ContainerAttacher
- type ContainerCommandRunner
- type ContainerGC
- type ContainerGCPolicy
- type ContainerID
- type ContainerState
- type ContainerStatus
- type DockerID
- type EnvVar
- type HandlerRunner
- type Image
- type ImagePuller
- type ImageSpec
- type Mount
- type OSInterface
- type Option
- type Pod
- type PodPair
- type PodStatus
- type PodSyncResult
- type Pods
- type PortMapping
- type RealOS
- type RefManager
- type RunContainerOptions
- type Runtime
- type RuntimeCache
- type RuntimeHelper
- type SortContainerStatusesByCreationTime
- type SyncAction
- type SyncResult
- type Version
- type VolumeInfo
- type VolumeMap
Constants ¶
const ( // Container event reason list CreatedContainer = "Created" StartedContainer = "Started" FailedToCreateContainer = "Failed" FailedToStartContainer = "Failed" KillingContainer = "Killing" BackOffStartContainer = "BackOff" // Image event reason list PullingImage = "Pulling" PulledImage = "Pulled" FailedToPullImage = "Failed" FailedToInspectImage = "InspectFailed" ErrImageNeverPullPolicy = "ErrImageNeverPull" BackOffPullImage = "BackOff" // kubelet event reason list NodeReady = "NodeReady" NodeNotReady = "NodeNotReady" NodeSchedulable = "NodeSchedulable" NodeNotSchedulable = "NodeNotSchedulable" StartingKubelet = "Starting" KubeletSetupFailed = "KubeletSetupFailed" FailedMountVolume = "FailedMount" HostPortConflict = "HostPortConflict" NodeSelectorMismatching = "NodeSelectorMismatching" InsufficientFreeCPU = "InsufficientFreeCPU" InsufficientFreeMemory = "InsufficientFreeMemory" OutOfDisk = "OutOfDisk" HostNetworkNotSupported = "HostNetworkNotSupported" UndefinedShaper = "NilShaper" NodeRebooted = "Rebooted" // Image manager event reason list InvalidDiskCapacity = "InvalidDiskCapacity" FreeDiskSpaceFailed = "FreeDiskSpaceFailed" // Probe event reason list ContainerUnhealthy = "Unhealthy" // Pod worker event reason list FailedSync = "FailedSync" // Config event reason list FailedValidation = "FailedValidation" )
Variables ¶
var ( // Container image pull failed, kubelet is backing off image pull ErrImagePullBackOff = errors.New("ImagePullBackOff") // Unable to inspect image ErrImageInspect = errors.New("ImageInspectError") // General image pull error ErrImagePull = errors.New("ErrImagePull") // Required Image is absent on host and PullPolicy is NeverPullImage ErrImageNeverPull = errors.New("ErrImageNeverPull") // 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") RegistryUnavailable = errors.New("RegistryUnavailable") )
var ( ErrRunContainer = errors.New("RunContainerError") ErrKillContainer = errors.New("KillContainerError") ErrVerifyNonRoot = errors.New("VerifyNonRootError") )
var ( ErrSetupNetwork = errors.New("SetupNetworkError") ErrTeardownNetwork = errors.New("TeardownNetworkError") )
var ErrCrashLoopBackOff = errors.New("CrashLoopBackOff")
Container Terminated and Kubelet is backing off the restart
var ImplicitContainerPrefix string = "implicitly required container "
Functions ¶
func BuildPodFullName ¶
Build the pod full name from pod name and namespace.
func EnvVarsToMap ¶ added in v0.18.0
EnvVarsToMap constructs a map of environment name to value from a slice of env vars.
func ExpandContainerCommandAndArgs ¶ added in v0.18.0
func FilterEventRecorder ¶ added in v1.2.0
func FilterEventRecorder(recorder record.EventRecorder) record.EventRecorder
Create 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 *api.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.
This function will return an error if the provided Pod does not have a selfLink, but we expect selfLink to be populated at all call sites for the function.
func GetPodFullName ¶
GetPodFullName returns a name that uniquely identifies a pod.
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.
func ParsePodFullName ¶
Parse the pod full name.
func ShouldContainerBeRestarted ¶ added in v0.17.0
ShouldContainerBeRestarted checks whether a container needs to be restarted. TODO(yifan): Think about how to refactor this.
Types ¶
type Cache ¶ added in v1.2.0
type Cache interface { Get(types.UID) (*PodStatus, error) Set(types.UID, *PodStatus, error, time.Time) // 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 retrive 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 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 // api.Container. Name string // The image name of the container. Image string // Hash of the container, used for comparison. Optional for containers // not managed by kubelet. Hash uint64 // The timestamp of the creation time of the container. // TODO(yifan): Consider to move it to api.ContainerStatus. Created int64 // State is the state of the container. State ContainerState }
Container provides the runtime information for a container, such as ID, hash, state of the container.
type ContainerAttacher ¶ added in v1.1.0
type ContainerAttacher interface {
AttachContainer(id ContainerID, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool) (err error)
}
type ContainerCommandRunner ¶ added in v0.17.0
type ContainerCommandRunner interface { // TODO(vmarmol): Merge RunInContainer and ExecInContainer. // Runs the command in the container of the specified pod using nsinit. RunInContainer(containerID ContainerID, cmd []string) ([]byte, error) // Runs the command in the container of the specified pod using nsenter. // Attaches the processes stdin, stdout, and stderr. Optionally uses a // tty. ExecInContainer(containerID ContainerID, cmd []string, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool) error // Forward the specified port from the specified pod to the stream. PortForward(pod *Pod, port uint16, stream io.ReadWriteCloser) error }
CommandRunner encapsulates the command runner interfaces for testability.
type ContainerGC ¶ added in v1.2.0
type ContainerGC interface { // Garbage collect containers. GarbageCollect() error }
Manages garbage collection of dead containers.
Implementation is thread-compatible.
func NewContainerGC ¶ added in v1.2.0
func NewContainerGC(runtime Runtime, policy ContainerGCPolicy) (ContainerGC, error)
New ContainerGC instance with the specified policy.
type ContainerGCPolicy ¶ added in v1.2.0
type ContainerGCPolicy 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 }
Specified a policy for garbage collecting containers.
type ContainerID ¶ added in v0.16.0
type ContainerID struct { // The type of the container runtime. e.g. 'docker', 'rkt'. 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
func ParseContainerID ¶ added in v1.2.0
func ParseContainerID(containerID string) ContainerID
Convenience method for creating a ContainerID from an ID string.
func (*ContainerID) IsEmpty ¶ added in v1.2.0
func (c *ContainerID) IsEmpty() bool
func (*ContainerID) MarshalJSON ¶ added in v0.16.0
func (c *ContainerID) MarshalJSON() ([]byte, error)
func (*ContainerID) ParseString ¶ added in v0.16.0
func (c *ContainerID) ParseString(data string) error
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
type ContainerState ¶ added in v1.2.0
type ContainerState string
const ( ContainerStateRunning ContainerState = "running" ContainerStateExited ContainerState = "exited" // This unknown encompasses all the states that we currently don't care. ContainerStateUnknown ContainerState = "unknown" )
type ContainerStatus ¶ added in v1.2.0
type ContainerStatus struct { // ID of the container. ID ContainerID // Name of the container. Name string // Status of the container. State ContainerState // 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. 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 }
ContainerStatus represents the status of a container.
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
type HandlerRunner ¶ added in v0.16.0
type HandlerRunner interface {
Run(containerID ContainerID, pod *api.Pod, container *api.Container, handler *api.Handler) 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 // The size of the image in bytes. Size int64 }
Basic information about a container image.
type ImagePuller ¶ added in v1.1.0
type ImagePuller interface {
PullImage(pod *api.Pod, container *api.Container, pullSecrets []api.Secret) (error, string)
}
ImagePuller wraps Runtime.PullImage() to pull a container image. It will check the presence of the image, and report the 'image pulling', 'image pulled' events correspondingly.
func NewImagePuller ¶ added in v1.1.0
func NewImagePuller(recorder record.EventRecorder, runtime Runtime, imageBackOff *util.Backoff) ImagePuller
NewImagePuller takes an event recorder and container runtime to create a image puller that wraps the container runtime's PullImage interface.
func NewSerializedImagePuller ¶ added in v1.2.0
func NewSerializedImagePuller(recorder record.EventRecorder, runtime Runtime, imageBackOff *util.Backoff) ImagePuller
NewSerializedImagePuller takes an event recorder and container runtime to create a image puller that wraps the container runtime's PullImage interface. Pulls one image at a time. Issue #10959 has the rationale behind serializing image pulls.
type ImageSpec ¶ added in v0.17.0
type ImageSpec struct {
Image string
}
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 OSInterface ¶ added in v0.16.0
type OSInterface interface { Mkdir(path string, perm os.FileMode) error Symlink(oldname string, newname 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 // List of containers that belongs to this pod. It may contain only // running containers, or mixed with dead ones (when GetPods(true)). Containers []*Container }
Pod is a group of containers.
func ConvertPodStatusToRunningPod ¶ added in v1.2.0
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
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.
type PodPair ¶ added in v1.2.0
type PodPair struct { // APIPod is the api.Pod APIPod *api.Pod // RunningPod is the pod defined 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 // Namspace of the pod. Namespace string // IP of the pod. IP string // Status of containers in the pod. ContainerStatuses []*ContainerStatus }
PodStatus represents the status of the pod and its containers. api.PodStatus can be derived from examining PodStatus and api.Pod.
func (*PodStatus) FindContainerStatusByName ¶ added in v1.2.0
func (podStatus *PodStatus) FindContainerStatusByName(containerName string) *ContainerStatus
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
func (podStatus *PodStatus) GetRunningContainerStatuses() []*ContainerStatus
Get 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
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 RealOS ¶ added in v0.16.0
type RealOS struct{}
RealOS is used to dispatch the real system level operaitons.
type RefManager ¶
RefManager manages the references for the containers. The references are used for reporting events such as creation, failure, etc. This manager is thread-safe, no locks are necessary for the caller.
func NewRefManager ¶
func NewRefManager() *RefManager
NewRefManager creates and returns a container reference manager with empty contents.
func (*RefManager) ClearRef ¶
func (c *RefManager) ClearRef(id ContainerID)
ClearRef forgets the given container id and its associated container reference.
func (*RefManager) GetRef ¶
func (c *RefManager) GetRef(id ContainerID) (ref *api.ObjectReference, ok bool)
GetRef returns the container reference of the given ID, or (nil, false) if none is stored.
func (*RefManager) SetRef ¶
func (c *RefManager) SetRef(id ContainerID, ref *api.ObjectReference)
SetRef stores a reference to a pod's container, associating it with the given container ID.
type RunContainerOptions ¶
type RunContainerOptions struct { // The environment variables list. Envs []EnvVar // The mounts for the containers. Mounts []Mount // The port mappings for the containers. PortMappings []PortMapping // 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 list of DNS servers for the container to use. DNS []string // The list of DNS search domains. DNSSearch []string // The parent cgroup to pass to Docker CgroupParent string // The type of container rootfs ReadOnly bool // hostname for pod containers Hostname string }
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() (Version, error) // APIVersion returns the API version information of the container // runtime. This may be different from the runtime engine's version. // TODO(random-liu): We should fold this into Version() APIVersion() (Version, error) // Status returns error if the runtime is unhealthy; nil otherwise. Status() error // GetPods returns a list containers group by pods. The boolean parameter // specifies whether the runtime returns all containers including those already // exited and dead containers (used for garbage collection). GetPods(all bool) ([]*Pod, error) // GarbageCollect removes dead containers using the specified container gc policy GarbageCollect(gcPolicy ContainerGCPolicy) error // Syncs the running pod into the desired pod. SyncPod(pod *api.Pod, apiPodStatus api.PodStatus, podStatus *PodStatus, pullSecrets []api.Secret, backOff *util.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. KillPod(pod *api.Pod, runningPod Pod) error // GetPodStatus retrieves the status of the pod, including the // information of all containers in the pod that are visble in Runtime. GetPodStatus(uid types.UID, name, namespace string) (*PodStatus, error) // PullImage pulls an image from the network to local storage using the supplied // secrets if necessary. PullImage(image ImageSpec, pullSecrets []api.Secret) error // IsImagePresent checks whether the container image is already in the local storage. IsImagePresent(image ImageSpec) (bool, error) // Gets all images currently on the machine. ListImages() ([]Image, error) // Removes the specified image. RemoveImage(image ImageSpec) 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(pod *api.Pod, containerID ContainerID, logOptions *api.PodLogOptions, stdout, stderr io.Writer) (err error) // ContainerCommandRunner encapsulates the command runner interfaces for testability. ContainerCommandRunner // ContainerAttach encapsulates the attaching to containers for testability ContainerAttacher }
Runtime interface defines the interfaces that should be implemented by a container runtime. Thread safety is required from implementations of this interface.
type RuntimeCache ¶
func NewRuntimeCache ¶
func NewRuntimeCache(getter podsGetter) (RuntimeCache, error)
NewRuntimeCache creates a container runtime cache.
type RuntimeHelper ¶ added in v1.2.0
type RuntimeHelper interface { GenerateRunContainerOptions(pod *api.Pod, container *api.Container, podIP string) (*RunContainerOptions, error) GetClusterDNS(pod *api.Pod) (dnsServers []string, dnsSearches []string, err error) }
RuntimeHelper wraps kubelet to make container runtime able to get necessary informations like the RunContainerOptions, DNS settings.
type SortContainerStatusesByCreationTime ¶ added in v1.2.0
type SortContainerStatusesByCreationTime []*ContainerStatus
Sort 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 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 SyncAction = "StartContainer" KillContainer SyncAction = "KillContainer" SetupNetwork SyncAction = "SetupNetwork" TeardownNetwork SyncAction = "TeardownNetwork" )
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 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 }
type VolumeInfo ¶ added in v1.2.0
type VolumeInfo struct { // Builder is the volume's builder Builder volume.Builder // SELinuxLabeled indicates whether this volume has had the // pod's SELinux label applied to it or not SELinuxLabeled bool }
VolumeInfo contains information about the volume.
type VolumeMap ¶ added in v0.17.0
type VolumeMap map[string]VolumeInfo