Documentation
¶
Index ¶
- Constants
- func ConvertCgroupFsNameToSystemd(cgroupfsName string) (string, error)
- func ConvertCgroupNameToSystemd(cgroupName CgroupName, outputToCgroupFs bool) string
- func EnsureDockerInContainer(dockerAPIVersion *utilversion.Version, oomScoreAdj int, manager *fs.Manager) error
- func MilliCPUToQuota(milliCPU int64) (quota int64, period int64)
- func MilliCPUToShares(milliCPU int64) int64
- func ParseQOSReserved(m componentconfig.ConfigurationMap) (*map[v1.ResourceName]int64, error)
- type ActivePodsFunc
- type CgroupConfig
- type CgroupManager
- type CgroupName
- type CgroupSubsystems
- type ContainerManager
- type KernelTunableBehavior
- type MemoryStats
- type NodeAllocatableConfig
- type NodeConfig
- type PodContainerManager
- type QOSContainerManager
- type QOSContainersInfo
- type ResourceConfig
- type ResourceStats
- type Status
Constants ¶
const ( // Uer visible keys for managing node allocatable enforcement on the node. NodeAllocatableEnforcementKey = "pods" SystemReservedEnforcementKey = "system-reserved" KubeReservedEnforcementKey = "kube-reserved" )
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 )
const ( // Taken from lmctfy https://github.com/google/lmctfy/blob/master/lmctfy/controllers/cpu_controller.cc MilliCPUToCPU = 1000 // 100000 is equivalent to 100ms QuotaPeriod = 100000 MinQuotaPeriod = 1000 )
Variables ¶
This section is empty.
Functions ¶
func ConvertCgroupFsNameToSystemd ¶ added in v1.5.1
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.1
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.1
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 MilliCPUToQuota ¶ added in v1.5.1
MilliCPUToQuota converts milliCPU to CFS quota and period values.
func MilliCPUToShares ¶ added in v1.5.1
MilliCPUToShares converts the milliCPU to CFS shares.
func ParseQOSReserved ¶ added in v1.6.0
func ParseQOSReserved(m componentconfig.ConfigurationMap) (*map[v1.ResourceName]int64, error)
ParseQOSReserved parses the --qos-reserve-requests option
Types ¶
type ActivePodsFunc ¶ added in v1.6.0
type CgroupConfig ¶ added in v1.4.2
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.2
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 // 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.2
func NewCgroupManager(cs *CgroupSubsystems, cgroupDriver string) CgroupManager
NewCgroupManager is a factory method that returns a CgroupManager
type CgroupName ¶ added in v1.5.1
type CgroupName string
CgroupName is the abstract name of a cgroup prior to any driver specific conversion.
type CgroupSubsystems ¶ added in v1.4.2
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 ¶ added in v1.4.2
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) 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 subsytems 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 // UpdateQOSCgroups performs housekeeping updates to ensure that the top // level QoS containers have their desired state in a thread-safe way UpdateQOSCgroups() error }
Manages the containers running on a machine.
func NewContainerManager ¶
func NewContainerManager(mountUtil mount.Interface, cadvisorInterface cadvisor.Interface, nodeConfig NodeConfig, failSwapOn 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 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 stastistics 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 PodContainerManager ¶ added in v1.4.2
type PodContainerManager interface { // GetPodContainerName returns the CgroupName identifer, 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 doesen'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.2
QOSContainersInfo stores the names of containers per qos
type ResourceConfig ¶ added in v1.4.2
type ResourceConfig struct { // Memory limit (in bytes). Memory *int64 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 ¶ added in v1.5.1
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 stastistics from various cgroup subsystems