Documentation
¶
Index ¶
Constants ¶
View Source
const ( CPU = policy.CPU Memory = policy.Memory AmountAbsent = policy.AmountAbsent AmountQuantity = policy.AmountQuantity AmountCPUSet = policy.AmountCPUSet )
View Source
const ( CPUTopologyLevelUndefined = "" CPUTopologyLevelSystem = "system" CPUTopologyLevelPackage = "package" CPUTopologyLevelDie = "die" CPUTopologyLevelNuma = "numa" CPUTopologyLevelL2Cache = "l2cache" CPUTopologyLevelCore = "core" CPUTopologyLevelThread = "thread" )
Variables ¶
View Source
var (
CPUTopologyLevelCount = len(cpuTopologyLevelValues)
)
Functions ¶
This section is empty.
Types ¶
type AmountKind ¶
type AmountKind = policy.AmountKind
type BalloonDef ¶
type BalloonDef struct {
// Name of the balloon definition.
Name string `json:"name"`
// Namespaces control which namespaces are assigned into
// balloon instances from this definition. This is used by
// namespace assign methods.
Namespaces []string `json:"namespaces,omitempty"`
// GroupBy groups containers into same balloon instances if
// their GroupBy expressions evaluate to the same group.
// Expressions are strings where key references like
// ${pod/labels/mylabel} will be substituted with
// corresponding values.
GroupBy string `json:"groupBy,omitempty"`
// MatchExpressions specifies one or more expressions which are evaluated
// to see if a container should be assigned into balloon instances from
// this definition.
MatchExpressions []resmgr.Expression `json:"matchExpressions,omitempty"`
// MaxCpus specifies the maximum number of CPUs exclusively
// usable by containers in a balloon. Balloon size will not be
// inflated larger than MaxCpus.
MaxCpus int `json:"maxCPUs,omitempty"`
// MinCpus specifies the minimum number of CPUs exclusively
// usable by containers in a balloon. When new balloon is created,
// this will be the number of CPUs reserved for it even if a container
// would request less.
MinCpus int `json:"minCPUs,omitempty"`
// MemoryTypes lists memory types allowed to containers in a
// balloon. Supported types are: DRAM, HBM, PMEM. By default
// all memory types in the system are allowed.
// +listType=set
// +kubebuilder:validation:items:XValidation:rule="self == 'DRAM' || self == 'HBM' || self == 'PMEM'",messageExpression="\"invalid memory type: \" + self + \", expected DRAM, HBM, or PMEM\""
MemoryTypes []string `json:"memoryTypes,omitempty"`
// PinMemory controls pinning containers to memory nodes.
// Overrides the policy level PinMemory setting in this balloon type.
PinMemory *bool `json:"pinMemory,omitempty"`
// AllocatorPriority (High, Normal, Low, None)
// This parameter is passed to CPU allocator when creating or
// resizing a balloon. At init, balloons with highest priority
// CPUs are allocated first.
// +kubebuilder:validation:Enum=high;normal;low;none
// +kubebuilder:default=high
// +kubebuilder:validation:Format:string
AllocatorPriority CPUPriority `json:"allocatorPriority,omitempty"`
// PreferSpreadOnPhysicalCores is the balloon type specific
// parameter of the policy level parameter with the same name.
PreferSpreadOnPhysicalCores *bool `json:"preferSpreadOnPhysicalCores,omitempty"`
// HideHyperthreads allows containers in a balloon use only
// one hyperthread from each physical CPU core in the
// balloon. For instance, if a balloon contains 16 logical
// CPUs from 8 physical cores and this option is true, then
// containers in the balloon will be allowed to use 8 logical
// CPUs, one from each physical core. This option is best used
// with PreferSpreadOnPhysicalCores=false in order to allocate
// all hyperthreads of each physical core into the same
// balloon, but allow containers to use only one hyperthread
// from each core. This will ensure that hidden hyperthreads
// will remain completely idle as they cannot be allocated to
// other balloons.
HideHyperthreads *bool `json:"hideHyperthreads,omitempty"`
// AllocatorTopologyBalancing is the balloon type specific
// parameter of the policy level parameter with the same name.
AllocatorTopologyBalancing *bool `json:"allocatorTopologyBalancing,omitempty"`
// CpuClass controls how CPUs of a balloon are (re)configured
// whenever a balloon is created, inflated or deflated.
CpuClass string `json:"cpuClass,omitempty"`
// MinBalloons is the number of balloon instances that always
// exist even if they would become empty. At init this number
// of instances will be created before assigning any
// containers.
MinBalloons int `json:"minBalloons,omitempty"`
// MaxBalloons is the maximum number of balloon instances that
// is allowed to co-exist. If reached, new balloons cannot be
// created anymore.
MaxBalloons int `json:"maxBalloons,omitempty"`
// PreferSpreadingPods: containers of the same pod may be
// placed on separate balloons. The default is false: prefer
// placing containers of a pod to the same balloon(s).
PreferSpreadingPods bool `json:"preferSpreadingPods,omitempty"`
// PreferPerNamespaceBalloon: if true, containers in different
// namespaces are preferably placed in separate balloons,
// even if the balloon type is the same for all of them. On
// the other hand, containers in the same namespace will be
// placed in the same balloon instances. The default is false:
// namespaces have no effect on placement.
PreferPerNamespaceBalloon bool `json:"preferPerNamespaceBalloon,omitempty"`
// PreferNewBalloons: prefer creating new balloons over adding
// containers to existing balloons. The default is false:
// prefer using filling free capacity and possibly inflating
// existing balloons before creating new ones.
PreferNewBalloons bool `json:"preferNewBalloons,omitempty"`
// CPUs, that is CPUs not in any balloon, in the same
// <topology-level> as any CPU in the balloon, then allow
// workloads to run on those (shared) CPUs in addition to the
// (dedicated) CPUs of the balloon.
// +kubebuilder:validation:Enum="";system;package;die;numa;l2cache;core;thread
// +kubebuilder:validation:Format:string
ShareIdleCpusInSame CPUTopologyLevel `json:"shareIdleCPUsInSame,omitempty"`
// PreferCloseToDevices: prefer creating new balloons of this
// type close to listed devices.
PreferCloseToDevices []string `json:"preferCloseToDevices,omitempty"`
// PreferFarFromDevices: prefer creating new balloons of this
// type far from listed devices.
// TODO: PreferFarFromDevices is considered too untested for usage. Hence,
// for the time being we prevent its usage through CRDs.
PreferFarFromDevices []string `json:"-"`
// preferIsolCpus: prefer kernel isolated cpus
// +kubebuilder:default=false
PreferIsolCpus bool `json:"preferIsolCpus,omitempty"`
// preferCoreType: prefer performance or efficient (P/E) CPU cores on
// hybrid architectures.
// +optional
// +kubebuilder:validation:Enum=efficient;performance
PreferCoreType string `json:"preferCoreType,omitempty"`
}
BalloonDef contains a balloon definition. +k8s:deepcopy-gen=true
func (*BalloonDef) DeepCopy ¶
func (in *BalloonDef) DeepCopy() *BalloonDef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BalloonDef.
func (*BalloonDef) DeepCopyInto ¶
func (in *BalloonDef) DeepCopyInto(out *BalloonDef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CPUPriority ¶
type CPUPriority string
const ( PriorityHigh CPUPriority = "high" PriorityNormal CPUPriority = "normal" PriorityLow CPUPriority = "low" PriorityNone CPUPriority = "none" )
func (CPUPriority) Value ¶
func (p CPUPriority) Value() cpuallocator.CPUPriority
type CPUTopologyLevel ¶
type CPUTopologyLevel string
func (CPUTopologyLevel) String ¶
func (l CPUTopologyLevel) String() string
func (CPUTopologyLevel) Value ¶
func (l CPUTopologyLevel) Value() int
type Config ¶
type Config struct {
// PinCPU controls pinning containers to CPUs.
// +kubebuilder:default=true
PinCPU *bool `json:"pinCPU,omitempty"`
// PinMemory controls pinning containers to memory nodes.
// +kubebuilder:default=true
PinMemory *bool `json:"pinMemory,omitempty"`
// IdleCpuClass controls how unusded CPUs outside any a
// balloons are (re)configured.
IdleCpuClass string `json:"idleCPUClass,omitempty"`
// ReservedPoolNamespaces is a list of namespace globs that
// will be allocated to reserved CPUs.
ReservedPoolNamespaces []string `json:"reservedPoolNamespaces,omitempty"`
// If AllocatorTopologyBalancing is true, balloons are
// allocated and resized so that all topology elements
// (packages, dies, numa nodes, cores) have roughly same
// amount of allocations. The default is false: balloons are
// packed tightly to optimize power efficiency. The value set
// here can be overridden with the balloon type specific
// setting with the same name.
AllocatorTopologyBalancing bool `json:"allocatorTopologyBalancing,omitempty"`
// PreferSpreadOnPhysicalCores prefers allocating logical CPUs
// (possibly hyperthreads) for a balloon from separate physical CPU
// cores. This prevents workloads in the balloon from interfering with
// themselves as they do not compete on the resources of the same CPU
// cores. On the other hand, it allows more interference between
// workloads in different balloons. The default is false: balloons
// are packed tightly to a minimum number of physical CPU cores. The
// value set here is the default for all balloon types, but it can be
// overridden with the balloon type specific setting with the same
// name.
PreferSpreadOnPhysicalCores bool `json:"preferSpreadOnPhysicalCores,omitempty"`
// BallonDefs contains balloon type definitions.
BalloonDefs []*BalloonDef `json:"balloonTypes,omitempty"`
// Available/allowed (CPU) resources to use.
AvailableResources Constraints `json:"availableResources,omitempty"`
// Reserved (CPU) resources for kube-system namespace.
// +kubebuilder:validation:Required
ReservedResources Constraints `json:"reservedResources"`
// Preserve specifies containers whose resource pinning must not be
// modified by the policy.
Preserve *ContainerMatchConfig `json:"preserve,omitempty"`
}
+k8s:deepcopy-gen=true
func (*Config) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Config.
func (*Config) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Constraints ¶
type Constraints = policy.Constraints
type ContainerMatchConfig ¶ added in v0.8.0
type ContainerMatchConfig struct {
// MatchExpressions specifies one or more expressions.
MatchExpressions []resmgr.Expression `json:"matchExpressions,omitempty"`
}
ContainerMatchConfig contains container matching configurations. +k8s:deepcopy-gen=true
func (*ContainerMatchConfig) DeepCopy ¶ added in v0.8.0
func (in *ContainerMatchConfig) DeepCopy() *ContainerMatchConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContainerMatchConfig.
func (*ContainerMatchConfig) DeepCopyInto ¶ added in v0.8.0
func (in *ContainerMatchConfig) DeepCopyInto(out *ContainerMatchConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ContainerMatchConfig) MatchContainer ¶ added in v0.8.0
func (cmc *ContainerMatchConfig) MatchContainer(c cache.Container) (string, error)
Source Files
Click to show internal directories.
Click to hide internal directories.