Documentation
¶
Index ¶
- func BuildPodFullName(name, namespace string) string
- func GenerateContainerRef(pod *api.Pod, container *api.Container) (*api.ObjectReference, error)
- func GetPodFullName(pod *api.Pod) string
- func ParsePodFullName(podFullName string) (string, string, error)
- type Container
- type ContainerRunner
- 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) ClearCalls()
- func (f *FakeRuntime) GetContainers(all bool) ([]*Container, error)
- func (f *FakeRuntime) GetPodStatus(pod *Pod) (api.PodStatus, error)
- func (f *FakeRuntime) GetPods(all bool) ([]*Pod, error)
- func (f *FakeRuntime) KillContainerInPod(container api.Container, pod *api.Pod) error
- func (f *FakeRuntime) KillPod(pod *api.Pod) error
- func (f *FakeRuntime) RunContainerInPod(container api.Container, pod *api.Pod, ...) error
- func (f *FakeRuntime) RunPod(pod *api.Pod, volumeMap map[string]volume.VolumePlugin) error
- func (f *FakeRuntime) Version() (map[string]string, error)
- type FakeRuntimeCache
- type Pod
- type Pods
- type ReadinessManager
- type RefManager
- type RunContainerOptions
- type Runtime
- type RuntimeCache
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildPodFullName ¶
Build the pod full name from pod name and namespace.
func GenerateContainerRef ¶ added in v0.4.4
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.
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 ContainerRunner ¶ added in v0.4.4
type ContainerRunner interface {
RunContainer(pod *api.Pod, container *api.Container, opts *RunContainerOptions) (string, error)
}
Container runner is a narrow interface to consume in the Kubelet before there is a full implementation of Runtime.
TODO: eventually include this interface in Runtime
type FakeRuntime ¶
type FakeRuntime struct { sync.Mutex CalledFunctions []string Podlist []*Pod ContainerList []*Container PodStatus api.PodStatus StartedPods []string KilledPods []string StartedContainers []string KilledContainers []string VersionInfo map[string]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) ClearCalls ¶
func (f *FakeRuntime) ClearCalls()
ClearCalls resets the FakeRuntime to the initial state.
func (*FakeRuntime) GetContainers ¶
func (f *FakeRuntime) GetContainers(all bool) ([]*Container, error)
func (*FakeRuntime) GetPodStatus ¶
func (f *FakeRuntime) GetPodStatus(pod *Pod) (api.PodStatus, error)
func (*FakeRuntime) KillContainerInPod ¶
func (*FakeRuntime) RunContainerInPod ¶
func (f *FakeRuntime) RunContainerInPod(container api.Container, pod *api.Pod, volumeMap map[string]volume.VolumePlugin) error
func (*FakeRuntime) RunPod ¶
func (f *FakeRuntime) RunPod(pod *api.Pod, volumeMap map[string]volume.VolumePlugin) error
type FakeRuntimeCache ¶
type FakeRuntimeCache struct {
// contains filtered or unexported fields
}
func (*FakeRuntimeCache) ForceUpdateIfOlder ¶
func (f *FakeRuntimeCache) ForceUpdateIfOlder(time.Time) error
func (*FakeRuntimeCache) GetPods ¶
func (f *FakeRuntimeCache) GetPods() ([]*Pod, error)
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 // The status of the pod. // TODO(yifan): Inspect and get the statuses for all pods can be expensive, // maybe we want to get one pod's status at a time (e.g. GetPodStatus() // for the particular pod after we GetPods()). Status api.PodStatus }
Pod is a group of containers, with the status of the pod.
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 Pods ¶
type Pods []*Pod
func (Pods) FindPod ¶ added in v0.4.4
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.4.4
FindPodByFullName finds and returns a pod in the pod list by the full name. It will return an empty pod if not found.
type ReadinessManager ¶ added in v0.4.4
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 ¶ added in v0.4.4
func NewReadinessManager() *ReadinessManager
NewReadinessManager creates ane returns a readiness manager with empty contents.
func (*ReadinessManager) GetReadiness ¶ added in v0.4.4
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 ¶ added in v0.4.4
func (r *ReadinessManager) RemoveReadiness(id string)
RemoveReadiness clears the readiness value for the container with the given ID.
func (*ReadinessManager) SetReadiness ¶ added in v0.4.4
func (r *ReadinessManager) SetReadiness(id string, value bool)
SetReadiness sets the readiness value for the container with the given ID.
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 string)
ClearRef forgets the given container id and its associated container reference. TODO(yifan): This is currently never called. Consider to remove this function, or figure out when to clear the references.
func (*RefManager) GetRef ¶
func (c *RefManager) GetRef(id string) (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 string, 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, they are in the form of 'key=value'. Envs []string // The mounts for the containers, they are in the form of: // 'hostPath:containerPath', or // 'hostPath:containerPath:ro', if the path read only. Binds []string // 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 // Docker namespace identifiers(currently we have 'NetMode' and 'IpcMode'. // These are for docker to attach a container in a pod to the pod infra // container's namespace. // TODO(yifan): Remove these after we pushed the pod infra container logic // into docker's container runtime. NetMode string IpcMode string }
RunContainerOptions specify the options which are necessary for running containers
type Runtime ¶
type Runtime interface { // Version returns a map of version information of the container runtime. Version() (map[string]string, 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) // RunPod starts all the containers of a pod within a namespace. RunPod(*api.Pod, map[string]volume.Volume) error // KillPod kills all the containers of a pod. KillPod(*api.Pod) error // RunContainerInPod starts a container within the same namespace of a pod. RunContainerInPod(api.Container, *api.Pod, map[string]volume.Volume) error // KillContainerInPod kills a container in the pod. KillContainerInPod(api.Container, *api.Pod) error // GetPodStatus retrieves the status of the pod, including the information of // all containers in the pod. GetPodStatus(*Pod) (api.PodStatus, error) // GetContainers returns all containers on the node, including those are // not managed by kubelet. If 'all' is false, then only running containers // are returned. GetContainers(all bool) ([]*Container, error) }
Runtime interface defines the interfaces that should be implemented by a container runtime.
type RuntimeCache ¶
func NewFakeRuntimeCache ¶
func NewFakeRuntimeCache(runtime Runtime) RuntimeCache
func NewRuntimeCache ¶
func NewRuntimeCache(runtime Runtime) (RuntimeCache, error)
NewRuntimeCache creates a container runtime cache.