container

Documentation

Index

• type Container
• 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
  • func (f *FakeRuntimeCache) ForceUpdateIfOlder(time.Time) error
  • func (f *FakeRuntimeCache) GetPods() ([]*Pod, error)
• type Pod
• type Runtime
• type RuntimeCache
  • func NewFakeRuntimeCache(runtime Runtime) RuntimeCache
  • func NewRuntimeCache(runtime Runtime) (RuntimeCache, error)

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
}

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

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) GetPods

func (f *FakeRuntime) GetPods(all bool) ([]*Pod, error)

func (*FakeRuntime) KillContainerInPod

func (f *FakeRuntime) KillContainerInPod(container api.Container, pod *api.Pod) error

func (*FakeRuntime) KillPod

func (f *FakeRuntime) KillPod(pod *api.Pod) error

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

func (*FakeRuntime) Version

func (f *FakeRuntime) Version() (map[string]string, 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.

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.VolumePlugin) 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.VolumePlugin) 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

type RuntimeCache interface {
	GetPods() ([]*Pod, error)
	ForceUpdateIfOlder(time.Time) error
}

func NewFakeRuntimeCache

func NewFakeRuntimeCache(runtime Runtime) RuntimeCache

func NewRuntimeCache

func NewRuntimeCache(runtime Runtime) (RuntimeCache, error)

NewRuntimeCache creates a container runtime cache.