cm

Documentation

Index

• Constants
• type CgroupConfig
• type CgroupManager
  • func NewCgroupManager(cs *CgroupSubsystems) CgroupManager
• type CgroupSubsystems
  • func GetCgroupSubsystems() (*CgroupSubsystems, error)
• type ContainerManager
  • func NewContainerManager(mountUtil mount.Interface, cadvisorInterface cadvisor.Interface, ...) (ContainerManager, error)
  • func NewStubContainerManager() ContainerManager
• type KernelTunableBehavior
• type NodeConfig
• type PodContainerManager
• type QOSContainersInfo
  • func InitQOS(rootContainer string, subsystems *CgroupSubsystems) (QOSContainersInfo, error)
• type ResourceConfig
• type Status

Constants

const (
	// The percent of the machine memory capacity. The value is used to calculate
	// docker memory resource container's hardlimit to workaround docker memory
	// leakage issue. Please see kubernetes/issues/9881 for more detail.
	DockerMemoryLimitThresholdPercent = 70
	// The minimum memory limit allocated to docker container: 150Mi
	MinDockerMemoryLimit = 150 * 1024 * 1024
)

Types

type CgroupConfig

type CgroupConfig struct {

	// Fully qualified name
	Name string
	// ResourceParameters contains various cgroups settings to apply.
	ResourceParameters *ResourceConfig
}

CgroupConfig holds the cgroup configuration information. This is common object which is used to specify cgroup information to both systemd and raw cgroup fs implementation of the Cgroup Manager interface.

type CgroupManager

type CgroupManager interface {
	// Create creates and applies the cgroup configurations on the cgroup.
	// It just creates the leaf cgroups.
	// It expects the parent cgroup to already exist.
	Create(*CgroupConfig) error
	// Destroys the cgroup.
	Destroy(*CgroupConfig) error
	// Update cgroup configuration.
	Update(*CgroupConfig) error
	// Exists checks if the cgroup already exists
	Exists(string) bool
}

CgroupManager allows for cgroup management. Supports Cgroup Creation ,Deletion and Updates.

func NewCgroupManager

func NewCgroupManager(cs *CgroupSubsystems) CgroupManager

NewCgroupManager is a factory method that returns a CgroupManager

type CgroupSubsystems

type CgroupSubsystems struct {
	// Cgroup subsystem mounts.
	// e.g.: "/sys/fs/cgroup/cpu" -> ["cpu", "cpuacct"]
	Mounts []libcontainercgroups.Mount

	// Cgroup subsystem to their mount location.
	// e.g.: "cpu" -> "/sys/fs/cgroup/cpu"
	MountPoints map[string]string
}

CgroupSubsystems holds information about the mounted cgroup subsytems

func GetCgroupSubsystems

func GetCgroupSubsystems() (*CgroupSubsystems, error)

GetCgroupSubsystems returns information about the mounted cgroup subsystems

type ContainerManager

type ContainerManager interface {
	// Runs the container manager's housekeeping.
	// - Ensures that the Docker daemon is in a container.
	// - Creates the system container where all non-containerized processes run.
	Start(*api.Node) error

	// Returns resources allocated to system cgroups in the machine.
	// These cgroups include the system and Kubernetes services.
	SystemCgroupsLimit() api.ResourceList

	// Returns a NodeConfig that is being used by the container manager.
	GetNodeConfig() NodeConfig

	// Returns internal Status.
	Status() Status

	// NewPodContainerManager is a factory method which returns a podContainerManager object
	// Returns a noop implementation if qos cgroup hierarchy is not enabled
	NewPodContainerManager() PodContainerManager

	// GetMountedSubsystems returns the mounted cgroup subsytems on the node
	GetMountedSubsystems() *CgroupSubsystems

	// GetQOSContainersInfo returns the names of top level QoS containers
	GetQOSContainersInfo() QOSContainersInfo
}

Manages the containers running on a machine.

func NewContainerManager

func NewContainerManager(mountUtil mount.Interface, cadvisorInterface cadvisor.Interface, nodeConfig NodeConfig) (ContainerManager, error)

TODO(vmarmol): Add limits to the system containers. Takes the absolute name of the specified containers. Empty container name disables use of the specified container.

func NewStubContainerManager

func NewStubContainerManager() ContainerManager

type KernelTunableBehavior

type KernelTunableBehavior string

const (
	KernelTunableWarn   KernelTunableBehavior = "warn"
	KernelTunableError  KernelTunableBehavior = "error"
	KernelTunableModify KernelTunableBehavior = "modify"
)

type NodeConfig

type NodeConfig struct {
	RuntimeCgroupsName    string
	SystemCgroupsName     string
	KubeletCgroupsName    string
	ContainerRuntime      string
	CgroupsPerQOS         bool
	CgroupRoot            string
	ProtectKernelDefaults bool
}

type PodContainerManager

type PodContainerManager interface {
	// getPodContainerName returns the pod container's absolute name
	GetPodContainerName(*api.Pod) string

	// EnsureExists takes a pod as argument and makes sure that
	// pod cgroup exists if qos cgroup hierarchy flag is enabled.
	// If the pod cgroup doesen't already exist this method creates it.
	EnsureExists(*api.Pod) error

	Exists(*api.Pod) bool

	//Destroy takes a pod as argument and destroys the pod's container.
	Destroy(string) error
}

PodContainerManager stores and manages pod level containers The Pod workers interact with the PodContainerManager to create and destroy containers for the pod.

type QOSContainersInfo

type QOSContainersInfo struct {
	Guaranteed string
	BestEffort string
	Burstable  string
}

QOSContainersInfo stores the names of containers per qos

func InitQOS

func InitQOS(rootContainer string, subsystems *CgroupSubsystems) (QOSContainersInfo, error)

InitQOS creates the top level qos cgroup containers We create top level QoS containers for only Burstable and Best Effort and not Guaranteed QoS class. All guaranteed pods are nested under the RootContainer by default. InitQOS is called only once during kubelet bootstrapping. TODO(@dubstack) Add support for cgroup-root to work on both systemd and cgroupfs drivers. Currently we only support systems running cgroupfs driver

type ResourceConfig

type ResourceConfig struct {
	// Memory limit (in bytes).
	Memory *int64
	// CPU shares (relative weight vs. other containers).
	CpuShares *int64
	// CPU hardcap limit (in usecs). Allowed cpu time in a given period.
	CpuQuota *int64
}

ResourceConfig holds information about all the supported cgroup resource parameters.

type Status

type Status struct {
	// Any soft requirements that were unsatisfied.
	SoftRequirements error
}