cm

package
v1.8.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 17, 2018 License: Apache-2.0 Imports: 50 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Uer visible keys for managing node allocatable enforcement on the node.
	NodeAllocatableEnforcementKey = "pods"
	SystemReservedEnforcementKey  = "system-reserved"
	KubeReservedEnforcementKey    = "kube-reserved"
)
View Source 
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
)
View Source 
const (
	// Taken from lmctfy https://github.com/google/lmctfy/blob/master/lmctfy/controllers/cpu_controller.cc
	MinShares     = 2
	SharesPerCPU  = 1024
	MilliCPUToCPU = 1000

	// 100000 is equivalent to 100ms
	QuotaPeriod    = 100000
	MinQuotaPeriod = 1000
)

Variables

This section is empty.

Functions

func ConvertCgroupFsNameToSystemd added in v1.5.0 

func ConvertCgroupFsNameToSystemd(cgroupfsName string) (string, error)

ConvertCgroupFsNameToSystemd converts an expanded cgroupfs name to its systemd name. For example, it will convert test.slice/test-a.slice/test-a-b.slice to become test-a-b.slice NOTE: this is public right now to allow its usage in dockermanager and dockershim, ideally both those code areas could use something from libcontainer if we get this style function upstream.

func ConvertCgroupNameToSystemd added in v1.5.0 

func ConvertCgroupNameToSystemd(cgroupName CgroupName, outputToCgroupFs bool) string

ConvertCgroupNameToSystemd converts the internal cgroup name to a systemd name. For example, the name /Burstable/pod_123-456 becomes Burstable-pod_123_456.slice If outputToCgroupFs is true, it expands the systemd name into the cgroupfs form. For example, it will return /Burstable.slice/Burstable-pod_123_456.slice in above scenario.

func EnsureDockerInContainer added in v1.5.0 

func EnsureDockerInContainer(dockerAPIVersion *utilversion.Version, oomScoreAdj int, manager *fs.Manager) error

Ensures that the Docker daemon is in the desired container. Temporarily export the function to be used by dockershim. TODO(yujuhong): Move this function to dockershim once kubelet migrates to dockershim as the default.

func HugePageLimits added in v1.8.0 

func HugePageLimits(resourceList v1.ResourceList) map[int64]int64

HugePageLimits converts the API representation to a map from huge page size (in bytes) to huge page limit (in bytes).

func MilliCPUToQuota added in v1.5.0 

func MilliCPUToQuota(milliCPU int64) (quota int64, period uint64)

MilliCPUToQuota converts milliCPU to CFS quota and period values.

func MilliCPUToShares added in v1.5.0 

func MilliCPUToShares(milliCPU int64) uint64

MilliCPUToShares converts the milliCPU to CFS shares.

func NewFakeInternalContainerLifecycle added in v1.8.0 

func NewFakeInternalContainerLifecycle() *fakeInternalContainerLifecycle

func ParseQOSReserved added in v1.6.0 

func ParseQOSReserved(m kubeletconfig.ConfigurationMap) (*map[v1.ResourceName]int64, error)

ParseQOSReserved parses the --qos-reserve-requests option

Types

type ActivePodsFunc added in v1.6.0 

type ActivePodsFunc func() []*v1.Pod

type CgroupConfig added in v1.4.0 

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 added in v1.4.0 

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 subsystems 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
	// GetResourceStats returns statistics of the specified cgroup as read from the cgroup fs.
	GetResourceStats(name CgroupName) (*ResourceStats, error)
}

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

func NewCgroupManager added in v1.4.0 

func NewCgroupManager(cs *CgroupSubsystems, cgroupDriver string) CgroupManager

NewCgroupManager is a factory method that returns a CgroupManager

type CgroupName added in v1.5.0 

type CgroupName string

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

type CgroupSubsystems added in v1.4.0 

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 subsystems

func GetCgroupSubsystems added in v1.4.0 

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(*v1.Node, ActivePodsFunc, status.PodStatusProvider, internalapi.RuntimeService) error

	// Returns resources allocated to system cgroups in the machine.
	// These cgroups include the system and Kubernetes services.
	SystemCgroupsLimit() v1.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 subsystems on the node
	GetMountedSubsystems() *CgroupSubsystems

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

	// GetNodeAllocatable returns the amount of compute resources that have to be reserved from scheduling.
	GetNodeAllocatableReservation() v1.ResourceList

	// GetCapacity returns the amount of compute resources tracked by container manager available on the node.
	GetCapacity() v1.ResourceList

	// UpdateQOSCgroups performs housekeeping updates to ensure that the top
	// level QoS containers have their desired state in a thread-safe way
	UpdateQOSCgroups() error

	// Returns RunContainerOptions with devices, mounts, and env fields populated for
	// extended resources required by container.
	GetResources(pod *v1.Pod, container *v1.Container, activePods []*v1.Pod) (*kubecontainer.RunContainerOptions, error)

	InternalContainerLifecycle() InternalContainerLifecycle
}

Manages the containers running on a machine.

func NewContainerManager 

func NewContainerManager(mountUtil mount.Interface, cadvisorInterface cadvisor.Interface, nodeConfig NodeConfig, failSwapOn bool, devicePluginEnabled bool, recorder record.EventRecorder) (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 DevicePluginHandler added in v1.8.0 

type DevicePluginHandler interface {
	// Start starts device plugin registration service.
	Start() error
	// Devices returns all of registered devices keyed by resourceName.
	Devices() map[string][]*pluginapi.Device
	// Allocate attempts to allocate all of required extended resources for
	// the input container, issues an Allocate rpc request for each of such
	// resources, and returns their AllocateResponses on success.
	Allocate(pod *v1.Pod, container *v1.Container, activePods []*v1.Pod) ([]*pluginapi.AllocateResponse, error)
}

type DevicePluginHandlerImpl added in v1.8.0 

type DevicePluginHandlerImpl struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewDevicePluginHandlerImpl added in v1.8.0 

func NewDevicePluginHandlerImpl(updateCapacityFunc func(v1.ResourceList)) (*DevicePluginHandlerImpl, error)

NewDevicePluginHandler create a DevicePluginHandler updateCapacityFunc is called to update ContainerManager capacity when device capacity changes.

func (*DevicePluginHandlerImpl) Allocate added in v1.8.0 

func (h *DevicePluginHandlerImpl) Allocate(pod *v1.Pod, container *v1.Container, activePods []*v1.Pod) ([]*pluginapi.AllocateResponse, error)

func (*DevicePluginHandlerImpl) Devices added in v1.8.0 

func (h *DevicePluginHandlerImpl) Devices() map[string][]*pluginapi.Device

func (*DevicePluginHandlerImpl) Start added in v1.8.0 

func (h *DevicePluginHandlerImpl) Start() error

type DevicePluginHandlerStub added in v1.8.0 

type DevicePluginHandlerStub struct{}

A simple stub implementation for DevicePluginHandler.

func NewDevicePluginHandlerStub added in v1.8.0 

func NewDevicePluginHandlerStub() (*DevicePluginHandlerStub, error)

func (*DevicePluginHandlerStub) Allocate added in v1.8.0 

func (h *DevicePluginHandlerStub) Allocate(pod *v1.Pod, container *v1.Container, activePods []*v1.Pod) ([]*pluginapi.AllocateResponse, error)

func (*DevicePluginHandlerStub) Devices added in v1.8.0 

func (h *DevicePluginHandlerStub) Devices() map[string][]*pluginapi.Device

func (*DevicePluginHandlerStub) Start added in v1.8.0 

func (h *DevicePluginHandlerStub) Start() error

type InternalContainerLifecycle added in v1.8.0 

type InternalContainerLifecycle interface {
	PreStartContainer(pod *v1.Pod, container *v1.Container, containerID string) error
	PreStopContainer(containerID string) error
	PostStopContainer(containerID string) error
}

type KernelTunableBehavior 

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

type MemoryStats added in v1.6.0 

type MemoryStats struct {
	// Memory usage (in bytes).
	Usage int64
}

MemoryStats holds the on-demand statistics from the memory cgroup

type NodeAllocatableConfig added in v1.6.0 

type NodeAllocatableConfig struct {
	KubeReservedCgroupName   string
	SystemReservedCgroupName string
	EnforceNodeAllocatable   sets.String
	KubeReserved             v1.ResourceList
	SystemReserved           v1.ResourceList
	HardEvictionThresholds   []evictionapi.Threshold
}

type NodeConfig 

type NodeConfig struct {
	RuntimeCgroupsName    string
	SystemCgroupsName     string
	KubeletCgroupsName    string
	ContainerRuntime      string
	CgroupsPerQOS         bool
	CgroupRoot            string
	CgroupDriver          string
	ProtectKernelDefaults bool
	NodeAllocatableConfig
	ExperimentalQOSReserved               map[v1.ResourceName]int64
	ExperimentalCPUManagerPolicy          string
	ExperimentalCPUManagerReconcilePeriod time.Duration
}

type PodContainerManager added in v1.4.0 

type PodContainerManager interface {
	// GetPodContainerName returns the CgroupName identifier, and its literal cgroupfs form on the host.
	GetPodContainerName(*v1.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 doesn't already exist this method creates it.
	EnsureExists(*v1.Pod) error

	// Exists returns true if the pod cgroup exists.
	Exists(*v1.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 QOSContainerManager added in v1.6.0 

type QOSContainerManager interface {
	Start(func() v1.ResourceList, ActivePodsFunc) error
	GetQOSContainersInfo() QOSContainersInfo
	UpdateCgroups() error
}

func NewQOSContainerManager added in v1.6.0 

func NewQOSContainerManager(subsystems *CgroupSubsystems, cgroupRoot string, nodeConfig NodeConfig) (QOSContainerManager, error)

type QOSContainersInfo added in v1.4.0 

type QOSContainersInfo struct {
	Guaranteed string
	BestEffort string
	Burstable  string
}

QOSContainersInfo stores the names of containers per qos

type ResourceConfig added in v1.4.0 

type ResourceConfig struct {
	// Memory limit (in bytes).
	Memory *int64
	// CPU shares (relative weight vs. other containers).
	CpuShares *uint64
	// CPU hardcap limit (in usecs). Allowed cpu time in a given period.
	CpuQuota *int64
	// CPU quota period.
	CpuPeriod *uint64
	// HugePageLimit map from page size (in bytes) to limit (in bytes)
	HugePageLimit map[int64]int64
}

ResourceConfig holds information about all the supported cgroup resource parameters.

func ResourceConfigForPod added in v1.5.0 

func ResourceConfigForPod(pod *v1.Pod) *ResourceConfig

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

type ResourceStats added in v1.6.0 

type ResourceStats struct {
	// Memory statistics.
	MemoryStats *MemoryStats
}

ResourceStats holds on-demand statistics from various cgroup subsystems

type Status 

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

Source Files

View all Source files

Directories

Path Synopsis
state
topology
Package topology contains helpers for the CPU manager.
 Package topology contains helpers for the CPU manager.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.