Documentation
¶
Index ¶
- 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 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 *api.PodStatus, ...) bool
- func StartPty(c *exec.Cmd) (*os.File, error)
- func TrimRuntimePrefix(fullString string) string
- type Container
- type ContainerAttacher
- type ContainerCommandRunner
- type ContainerID
- type EnvVar
- type FakeOS
- type FakeRuntime
- func (f *FakeRuntime) AssertCalls(calls []string) error
- func (f *FakeRuntime) AssertKilledContainers(containers []string) error
- func (f *FakeRuntime) AssertKilledPods(pods []string) error
- func (f *FakeRuntime) AssertStartedContainers(containers []string) error
- func (f *FakeRuntime) AssertStartedPods(pods []string) error
- func (f *FakeRuntime) AttachContainer(containerID string, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool) error
- func (f *FakeRuntime) ClearCalls()
- func (f *FakeRuntime) ExecInContainer(containerID string, cmd []string, stdin io.Reader, ...) error
- func (f *FakeRuntime) GetContainerLogs(pod *api.Pod, containerID string, logOptions *api.PodLogOptions, ...) (err error)
- func (f *FakeRuntime) GetContainers(all bool) ([]*Container, error)
- func (f *FakeRuntime) GetPodStatus(*api.Pod) (*api.PodStatus, error)
- func (f *FakeRuntime) GetPods(all bool) ([]*Pod, error)
- func (f *FakeRuntime) IsImagePresent(image ImageSpec) (bool, error)
- func (f *FakeRuntime) KillContainerInPod(container api.Container, pod *api.Pod) error
- func (f *FakeRuntime) KillPod(pod *api.Pod, runningPod Pod) error
- func (f *FakeRuntime) ListImages() ([]Image, error)
- func (f *FakeRuntime) PortForward(pod *Pod, port uint16, stream io.ReadWriteCloser) error
- func (f *FakeRuntime) PullImage(image ImageSpec, pullSecrets []api.Secret) error
- func (f *FakeRuntime) RemoveImage(image ImageSpec) error
- func (f *FakeRuntime) RunContainerInPod(container api.Container, pod *api.Pod, ...) error
- func (f *FakeRuntime) RunInContainer(containerID string, cmd []string) ([]byte, error)
- func (f *FakeRuntime) SyncPod(pod *api.Pod, _ Pod, _ api.PodStatus, _ []api.Secret, backOff *util.Backoff) error
- func (f *FakeRuntime) Type() string
- func (f *FakeRuntime) Version() (Version, error)
- type FakeRuntimeCache
- type FakeVersion
- type HandlerRunner
- type Image
- type ImagePuller
- type ImageSpec
- type Mount
- type OSInterface
- type Pod
- type Pods
- type PortMapping
- type ReadinessManager
- type RealOS
- type RefManager
- type RunContainerOptions
- type RunContainerOptionsGenerator
- type Runtime
- type RuntimeCache
- type Version
- type VolumeMap
Constants ¶
This section is empty.
Variables ¶
var ErrCrashLoopBackOff = errors.New("CrashLoopBackOff")
Container Terminated and Kubelet is backing off the restart
Functions ¶
func BuildPodFullName ¶
func BuildPodFullName(name, namespace string) string
Build the pod full name from pod name and namespace.
func EnvVarsToMap ¶ added in v0.18.0
func EnvVarsToMap(envs []EnvVar) map[string]string
EnvVarsToMap constructs a map of environment name to value from a slice of env vars.
func ExpandContainerCommandAndArgs ¶ added in v0.18.0
func ExpandContainerCommandAndArgs(container *api.Container, envs []EnvVar) (command []string, args []string)
func GenerateContainerRef ¶ added in v0.15.0
func GenerateContainerRef(pod *api.Pod, container *api.Container) (*api.ObjectReference, error)
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 ¶
func GetPodFullName(pod *api.Pod) string
GetPodFullName returns a name that uniquely identifies a pod.
func HashContainer ¶ added in v0.18.0
func HashContainer(container *api.Container) uint64
HashContainer returns the hash of the container. It is used to compare the running container with its desired spec.
func ParsePodFullName ¶
func ParsePodFullName(podFullName string) (string, string, error)
Parse the pod full name.
func ShouldContainerBeRestarted ¶ added in v0.17.0
func ShouldContainerBeRestarted(container *api.Container, pod *api.Pod, podStatus *api.PodStatus, readinessManager *ReadinessManager) bool
ShouldContainerBeRestarted checks whether a container needs to be restarted. TODO(yifan): Think about how to refactor this.
func TrimRuntimePrefix ¶ added in v0.17.0
func TrimRuntimePrefix(fullString string) string
Trims runtime prefix from ID or image name (e.g.: docker://busybox -> busybox).
Types ¶
type Container ¶
type Container struct {
// The ID of the container, used by the container runtime to identify
// a container.
ID types.UID
// 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
}
Container provides the runtime information for a container, such as ID, hash, status of the container.
type ContainerAttacher ¶ added in v1.1.0
type ContainerAttacher interface {
AttachContainer(id string, 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.
// TODO(yifan): Use strong type for containerID.
RunInContainer(containerID string, 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.
// TODO(yifan): Use strong type for containerID.
ExecInContainer(containerID string, 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 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 (*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) UnmarshalJSON ¶ added in v0.16.0
func (c *ContainerID) UnmarshalJSON(data []byte) error
type FakeOS ¶ added in v0.16.0
type FakeOS struct{}
FakeOS mocks out certain OS calls to avoid perturbing the filesystem on the test machine.
type FakeRuntime ¶
type FakeRuntime struct {
sync.Mutex
CalledFunctions []string
PodList []*Pod
ContainerList []*Container
ImageList []Image
PodStatus api.PodStatus
StartedPods []string
KilledPods []string
StartedContainers []string
KilledContainers []string
VersionInfo string
RuntimeType string
Err error
}
FakeRuntime is a fake container runtime for testing.
func (*FakeRuntime) AssertCalls ¶
func (f *FakeRuntime) AssertCalls(calls []string) error
AssertCalls test if the invoked functions are as expected.
func (*FakeRuntime) AssertKilledContainers ¶
func (f *FakeRuntime) AssertKilledContainers(containers []string) error
func (*FakeRuntime) AssertKilledPods ¶
func (f *FakeRuntime) AssertKilledPods(pods []string) error
func (*FakeRuntime) AssertStartedContainers ¶
func (f *FakeRuntime) AssertStartedContainers(containers []string) error
func (*FakeRuntime) AssertStartedPods ¶
func (f *FakeRuntime) AssertStartedPods(pods []string) error
func (*FakeRuntime) AttachContainer ¶ added in v1.1.0
func (f *FakeRuntime) AttachContainer(containerID string, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool) error
func (*FakeRuntime) ClearCalls ¶
func (f *FakeRuntime) ClearCalls()
ClearCalls resets the FakeRuntime to the initial state.
func (*FakeRuntime) ExecInContainer ¶ added in v0.18.0
func (f *FakeRuntime) ExecInContainer(containerID string, cmd []string, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool) error
func (*FakeRuntime) GetContainerLogs ¶ added in v0.18.0
func (f *FakeRuntime) GetContainerLogs(pod *api.Pod, containerID string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) (err error)
func (*FakeRuntime) GetContainers ¶
func (f *FakeRuntime) GetContainers(all bool) ([]*Container, error)
func (*FakeRuntime) GetPodStatus ¶
func (f *FakeRuntime) GetPodStatus(*api.Pod) (*api.PodStatus, error)
func (*FakeRuntime) IsImagePresent ¶ added in v0.18.0
func (f *FakeRuntime) IsImagePresent(image ImageSpec) (bool, error)
func (*FakeRuntime) KillContainerInPod ¶
func (f *FakeRuntime) KillContainerInPod(container api.Container, pod *api.Pod) error
func (*FakeRuntime) ListImages ¶ added in v0.18.0
func (f *FakeRuntime) ListImages() ([]Image, error)
func (*FakeRuntime) PortForward ¶ added in v0.18.0
func (f *FakeRuntime) PortForward(pod *Pod, port uint16, stream io.ReadWriteCloser) error
func (*FakeRuntime) PullImage ¶ added in v0.18.0
func (f *FakeRuntime) PullImage(image ImageSpec, pullSecrets []api.Secret) error
func (*FakeRuntime) RemoveImage ¶ added in v0.18.0
func (f *FakeRuntime) RemoveImage(image ImageSpec) error
func (*FakeRuntime) RunContainerInPod ¶
func (f *FakeRuntime) RunContainerInPod(container api.Container, pod *api.Pod, volumeMap map[string]volume.VolumePlugin) error
func (*FakeRuntime) RunInContainer ¶ added in v0.18.0
func (f *FakeRuntime) RunInContainer(containerID string, cmd []string) ([]byte, error)
type FakeRuntimeCache ¶
type FakeRuntimeCache struct {
// contains filtered or unexported fields
}
func (*FakeRuntimeCache) ForceUpdateIfOlder ¶
func (f *FakeRuntimeCache) ForceUpdateIfOlder(time.Time) error
type FakeVersion ¶ added in v0.18.0
type FakeVersion struct {
Version string
}
type HandlerRunner ¶ added in v0.16.0
type HandlerRunner interface {
Run(containerID string, 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.
Tags []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
}
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) 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.1.1
func NewSerializedImagePuller(recorder record.EventRecorder, runtime Runtime) 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 Mount ¶ added in v0.18.0
type Mount struct {
// Name of the volume mount.
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
}
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 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, with the status of the pod.
func (*Pod) FindContainerByName ¶
func (p *Pod) FindContainerByName(containerName string) *Container
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 Pods ¶
type Pods []*Pod
func (Pods) FindPod ¶ added in v0.15.0
func (p Pods) FindPod(podFullName string, podUID types.UID) Pod
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
func (p Pods) FindPodByFullName(podFullName string) Pod
FindPodByFullName finds and returns a pod in the pod list by the full name. It will return an empty pod if not found.
func (Pods) FindPodByID ¶
func (p Pods) FindPodByID(podUID types.UID) Pod
FindPodByID finds and returns a pod in the pod list by UID. It will return an empty pod if not found.
type PortMapping ¶ added in v0.18.0
type PortMapping struct {
// Name of the port mapping
Name string
// Protocol of the port mapping.
Protocol api.Protocol
// The port number within the container.
ContainerPort int
// The port number on the host.
HostPort int
// The host IP.
HostIP string
}
type ReadinessManager ¶
type ReadinessManager struct {
// guards states
sync.RWMutex
// contains filtered or unexported fields
}
ReadinessManager maintains the readiness information(probe results) of containers over time to allow for implementation of health thresholds. This manager is thread-safe, no locks are necessary for the caller.
func NewReadinessManager ¶
func NewReadinessManager() *ReadinessManager
NewReadinessManager creates ane returns a readiness manager with empty contents.
func (*ReadinessManager) GetReadiness ¶
func (r *ReadinessManager) GetReadiness(id string) bool
GetReadiness returns the readiness value for the container with the given ID. If the readiness value is found, returns it. If the readiness is not found, returns false.
func (*ReadinessManager) RemoveReadiness ¶
func (r *ReadinessManager) RemoveReadiness(id string)
RemoveReadiness clears the readiness value for the container with the given ID.
func (*ReadinessManager) SetReadiness ¶
func (r *ReadinessManager) SetReadiness(id string, value bool)
SetReadiness sets the readiness value for the container with the given ID.
type RealOS ¶ added in v0.16.0
type RealOS struct{}
RealOS is used to dispatch the real system level operaitons.
type RefManager ¶
type RefManager struct {
sync.RWMutex
// contains filtered or unexported fields
}
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 string)
ClearRef forgets the given container id and its associated container reference.
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
}
RunContainerOptions specify the options which are necessary for running containers
type RunContainerOptionsGenerator ¶ added in v0.16.0
type RunContainerOptionsGenerator interface {
GenerateRunContainerOptions(pod *api.Pod, container *api.Container) (*RunContainerOptions, error)
}
RunContainerOptionsGenerator generates the options that necessary for container runtime to run a container.
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)
// 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)
// Syncs the running pod into the desired pod.
SyncPod(pod *api.Pod, runningPod Pod, podStatus api.PodStatus, pullSecrets []api.Secret, backOff *util.Backoff) error
// KillPod kills all the containers of a pod. Pod may be nil, running pod must not be.
KillPod(pod *api.Pod, runningPod Pod) error
// GetPodStatus retrieves the status of the pod, including the information of
// all containers in the pod. Clients of this interface assume the containers
// statuses in a pod always have a deterministic ordering (eg: sorted by name).
GetPodStatus(*api.Pod) (*api.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 string, 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 ¶
type RuntimeCache interface {
GetPods() ([]*Pod, error)
ForceUpdateIfOlder(time.Time) error
}
func NewFakeRuntimeCache ¶
func NewFakeRuntimeCache(getter podsGetter) RuntimeCache
func NewRuntimeCache ¶
func NewRuntimeCache(getter podsGetter) (RuntimeCache, error)
NewRuntimeCache creates a container runtime cache.
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
}