consts

Documentation

Index

• Constants

Constants

const (
	CgroupV1 = "v1"
	CgroupV2 = "v2"
)

const variables indicate cgroup versions

const (
	PodAnnotationInplaceUpdateResourcesKey = "pod.kubernetes.io/resizeResources"

	PodAnnotationInplaceUpdateResizePolicyKey     = "pod.kubernetes.io/resizePolicy"
	PodAnnotationInplaceUpdateResizePolicyRestart = "Restart"
)

const variables for pod annotations about vpa in-place resource update.

const (
	PodAnnotationQoSLevelKey = "katalyst.kubewharf.io/qos_level"

	PodAnnotationQoSLevelReclaimedCores = "reclaimed_cores"
	PodAnnotationQoSLevelSharedCores    = "shared_cores"
	PodAnnotationQoSLevelDedicatedCores = "dedicated_cores"
	PodAnnotationQoSLevelSystemCores    = "system_cores"
)

const variables for pod annotations about qos level

const (
	PodAnnotationMemoryEnhancementKey = "katalyst.kubewharf.io/memory_enhancement"

	PodAnnotationMemoryEnhancementRssOverUseThreshold = "rss_overuse_threshold"

	PodAnnotationMemoryEnhancementNumaBinding       = "numa_binding"
	PodAnnotationMemoryEnhancementNumaBindingEnable = "true"

	PodAnnotationMemoryEnhancementNumaExclusive       = "numa_exclusive"
	PodAnnotationMemoryEnhancementNumaExclusiveEnable = "true"
)

const variables for pod annotations about qos level enhancement in memory

const (
	PodAnnotationCPUEnhancementKey = "katalyst.kubewharf.io/cpu_enhancement"

	PodAnnotationCPUEnhancementCPUSet = "cpuset_pool"

	PodAnnotationCPUEnhancementSuppressionToleranceRate = "suppression_tolerance_rate"
)

const variables for pod annotations about qos level enhancement in cpu

const (
	PodAnnotationNetworkEnhancementKey = "katalyst.kubewharf.io/network_enhancement"

	PodAnnotationNetworkEnhancementNamespaceType              = "namespace_type"
	PodAnnotationNetworkEnhancementNamespaceTypeHost          = "host_ns"
	PodAnnotationNetworkEnhancementNamespaceTypeHostPrefer    = "host_ns_preferred"
	PodAnnotationNetworkEnhancementNamespaceTypeNotHost       = "anti_host_ns"
	PodAnnotationNetworkEnhancementNamespaceTypeNotHostPrefer = "anti_host_ns_preferred"

	PodAnnotationNetworkEnhancementAffinityRestricted     = "topology_affinity_restricted"
	PodAnnotationNetworkEnhancementAffinityRestrictedTrue = "true"
)

const variables for pod annotations about qos level enhancement in network

const (
	ReclaimedResourceMilliCPU v1.ResourceName = "resource.katalyst.kubewharf.io/reclaimed_millicpu"
	ReclaimedResourceMemory   v1.ResourceName = "resource.katalyst.kubewharf.io/reclaimed_memory"
)

const variables for resource names of reclaimed resource

const (
	// WorkloadAnnotationSPDEnableKey disables for workload means that we should not
	// maintain spd CR and much less to calculate service profiling automatically
	WorkloadAnnotationSPDEnableKey = "spd.katalyst.kubewharf.io/enable"
	WorkloadAnnotationSPDEnabled   = "true"

	WorkloadAnnotationSPDNameKey = "spd.katalyst.kubewharf.io/name"
)

const variables for workload annotations about spd.

const (
	// WorkloadAnnotationVPAEnabledKey disables for workload means that
	// we won't apply the recommended resources for pod belonging to this workload;
	// However, we may still do this calculation logic and update to status if vpa
	// CR is created for this workload
	WorkloadAnnotationVPAEnabledKey = "vpa.katalyst.kubewharf.io/enable"
	WorkloadAnnotationVPAEnabled    = "true"

	WorkloadAnnotationVPANameKey = "vpa.katalyst.kubewharf.io/name"

	// WorkloadAnnotationVPASelectorKey is pod label selector for non-native workload
	WorkloadAnnotationVPASelectorKey = "vpa.katalyst.kubewharf.io/selector"
)

const variables for workload annotations about vpa.

const (
	VPAAnnotationVPARecNameKey = "vpa.katalyst.kubewharf.io/recName"

	VPAAnnotationWorkloadRetentionPolicyKey    = "vpa.katalyst.kubewharf.io/retentionPolicy"
	VPAAnnotationWorkloadRetentionPolicyRetain = "retain"
	VPAAnnotationWorkloadRetentionPolicyDelete = "delete"
)

const (
	PodAnnotationNetClassKey = "katalyst.kubewharf.io/net_class_id"
)

PodAnnotationNetClassKey is a const variable for pod annotation about net class.

const (
	PodAnnotationSPDNameKey = "spd.katalyst.kubewharf.io/name"
)

const ResourceAnnotationKeyResourceIdentifier = "katalyst.kubewharf.io/resource_identifier"

ResourceAnnotationKeyResourceIdentifier nominated the key to override the default name field in pod-resource-server (for qrm-related protocols); if the name field can't be guaranteed to be unique in some cases, we can relay on this annotation to get unique keys (to replace with the default name)

const (
	ResourceNetBandwidth v1.ResourceName = "resource.katalyst.kubewharf.io/net_bandwidth"
)

const variables for resource names of guaranteed resource