cm

Documentation

Index

• Constants
• func ConvertCgroupFsNameToSystemd(cgroupfsName string) (string, error)
• func ConvertCgroupNameToSystemd(cgroupName CgroupName, outputToCgroupFs bool) string
• func MilliCPUToQuota(milliCPU int64) (int64, int64)
• func MilliCPUToShares(milliCPU int64) int64
• type CgroupConfig
• type CgroupManager
  • func NewCgroupManager(_ interface{}) CgroupManager
• type CgroupName
• type CgroupSubsystems
  • func GetCgroupSubsystems() (*CgroupSubsystems, error)
• type ContainerManager
  • func NewContainerManager(_ mount.Interface, _ cadvisor.Interface, _ NodeConfig, failSwapOn bool) (ContainerManager, error)
  • func NewStubContainerManager() ContainerManager
• type NodeConfig
• type PodContainerManager
• type QOSContainersInfo
• type ResourceConfig
  • func ResourceConfigForPod(pod *api.Pod) *ResourceConfig
• type Status

Constants

const (
	MinShares     = 0
	SharesPerCPU  = 0
	MilliCPUToCPU = 0

	QuotaPeriod    = 0
	MinQuotaPeriod = 0
)

Functions

func ConvertCgroupFsNameToSystemd

func ConvertCgroupFsNameToSystemd(cgroupfsName string) (string, error)

func ConvertCgroupNameToSystemd

func ConvertCgroupNameToSystemd(cgroupName CgroupName, outputToCgroupFs bool) string

func MilliCPUToQuota

func MilliCPUToQuota(milliCPU int64) (int64, int64)

MilliCPUToQuota converts milliCPU to CFS quota and period values.

func MilliCPUToShares

func MilliCPUToShares(milliCPU int64) int64

MilliCPUToShares converts the milliCPU to CFS shares.

Types

type CgroupConfig

type CgroupConfig struct {
	// Fully qualified name prior to any driver specific conversions.
	Name CgroupName
	// 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
	// Destroy the cgroup.
	Destroy(*CgroupConfig) error
	// Update cgroup configuration.
	Update(*CgroupConfig) error
	// Exists checks if the cgroup already exists
	Exists(name CgroupName) bool
	// Name returns the literal cgroupfs name on the host after any driver specific conversions.
	// We would expect systemd implementation to make appropriate name conversion.
	// For example, if we pass /foo/bar
	// then systemd should convert the name to something like
	// foo.slice/foo-bar.slice
	Name(name CgroupName) string
	// CgroupName converts the literal cgroupfs name on the host to an internal identifier.
	CgroupName(name string) CgroupName
	// Pids scans through all subsytems to find pids associated with specified cgroup.
	Pids(name CgroupName) []int
	// ReduceCPULimits reduces the CPU CFS values to the minimum amount of shares.
	ReduceCPULimits(cgroupName CgroupName) error
}

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

func NewCgroupManager

func NewCgroupManager(_ interface{}) CgroupManager

type CgroupName

type CgroupName string

CgroupName is the abstract name of a cgroup prior to any driver specific conversion.

type CgroupSubsystems

type CgroupSubsystems struct {
	Mounts      []interface{}
	MountPoints map[string]string
}

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(_ mount.Interface, _ cadvisor.Interface, _ NodeConfig, failSwapOn bool) (ContainerManager, error)

func NewStubContainerManager

func NewStubContainerManager() ContainerManager

type NodeConfig

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

type PodContainerManager

type PodContainerManager interface {
	// GetPodContainerName returns the CgroupName identifer, and its literal cgroupfs form on the host.
	GetPodContainerName(*api.Pod) (CgroupName, 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 returns true if the pod cgroup exists.
	Exists(*api.Pod) bool

	// Destroy takes a pod Cgroup name as argument and destroys the pod's container.
	Destroy(name CgroupName) error

	// ReduceCPULimits reduces the CPU CFS values to the minimum amount of shares.
	ReduceCPULimits(name CgroupName) error

	// GetAllPodsFromCgroups enumerates the set of pod uids to their associated cgroup based on state of cgroupfs system.
	GetAllPodsFromCgroups() (map[types.UID]CgroupName, 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

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
	// CPU quota period.
	CpuPeriod *int64
}

ResourceConfig holds information about all the supported cgroup resource parameters.

func ResourceConfigForPod

func ResourceConfigForPod(pod *api.Pod) *ResourceConfig

ResourceConfigForPod takes the input pod and outputs the cgroup resource config.

type Status

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