consts

Documentation

Overview

Package consts is the package that defines those universal const vars if const vars are not used specifically by a certain file, ie. may be used by other components or imported by other projects, then they should be defined here.

Index

• Constants
• type ContainerName
• type KatalystComponent
• type PodContainerName

Constants

const (
	// OwnerReferenceIndex is the lookup name for the index function
	OwnerReferenceIndex = "owner-reference-index"
	// TargetReferenceIndex is the lookup name for the index function
	TargetReferenceIndex = "target-reference-index"
	// VPANameIndex is the lookup name for the index function
	VPANameIndex = "vpa-name-index"
)

const (
	EventReasonEvictFailed              = "EvictFailed"
	EventReasonEvictCreated             = "EvictCreated"
	EventReasonEvictExceededGracePeriod = "EvictExceededGracePeriod"
	EventReasonEvictSucceeded           = "EvictSucceeded"
)

const variables for pod eviction reason identifier in event.

const (
	ObjectFieldNameSpec   = "spec"
	ObjectFieldNameStatus = "status"
)

common fields for ordinary k8s objects.

const (
	// EvictionPluginThresholdMetRPCTimeoutInSecs is timeout duration in secs for ThresholdMet RPC
	EvictionPluginThresholdMetRPCTimeoutInSecs = 10
	// EvictionPluginGetTopEvictionPodsRPCTimeoutInSecs is timeout duration in secs for GetTopEvictionPods RPC
	EvictionPluginGetTopEvictionPodsRPCTimeoutInSecs = 10
	// EvictionPluginGetEvictPodsRPCTimeoutInSecs is timeout duration in secs for GetEvictPods RPC
	EvictionPluginGetEvictPodsRPCTimeoutInSecs = 10
)

const (
	KatalystCustomConfigTargetFinalizerKCC  = "kcct.katalyst.kubewharf.io/kcc-controller"
	KatalystCustomConfigTargetFinalizerCNC  = "kcct.katalyst.kubewharf.io/cnc-controller"
	KatalystCustomConfigTargetFinalizerKCCT = "kcct.katalyst.kubewharf.io/kcct-controller"
)

const variables for kcc target finalizer

const (
	KCCTargetConfFieldNameLabelSelector        = "nodeLabelSelector"
	KCCTargetConfFieldEphemeralSelector        = "ephemeralSelector"
	KCCTargetConfFieldNameRevisionHistoryLimit = "revisionHistoryLimit"
	KCCTargetConfFieldNameConfig               = "config"

	KCCTargetConfFieldNameNodeNames    = "nodeNames"
	KCCTargetConfFieldNameLastDuration = "lastDuration"
)

generic spec fields for configuration CRD (referred by KCC)

const (
	KCCTargetConfFieldNameCollisionCount     = "collisionCount"
	KCCTargetConfFieldNameObservedGeneration = "observedGeneration"
)

generic status fields for configuration CRD (referred by KCC)

const (
	MetricLoad1MinSystem  = "cpu.load.1min.system"
	MetricLoad5MinSystem  = "cpu.load.5min.system"
	MetricLoad15MinSystem = "cpu.load.15min.system"
)

System compute metrics

const (
	MetricMemTotalSystem     = "mem.total.system"
	MetricMemUsedSystem      = "mem.used.system"
	MetricMemFreeSystem      = "mem.free.system"
	MetricMemShmemSystem     = "mem.shmem.system"
	MetricMemBufferSystem    = "mem.buffer.system"
	MetricMemAvailableSystem = "mem.available.system"

	MetricMemDirtySystem       = "mem.dirty.system"
	MetricMemWritebackSystem   = "mem.writeback.system"
	MetricMemKswapdstealSystem = "mem.kswapdsteal.system"

	MetricMemSwapTotalSystem       = "mem.swap.total.system"
	MetricMemSwapFreeSystem        = "mem.swap.free.system"
	MetricMemSlabReclaimableSystem = "mem.slab.reclaimable.system"

	MetricMemScaleFactorSystem = "mem.scale.factor.system"
)

System memory metrics

const (
	MetricIOReadSystem  = "io.read.system"
	MetricIOWriteSystem = "io.write.system"
	MetricIOBusySystem  = "io.busy.system"
)

System blkio metrics

const (
	MetricMemTotalNuma     = "mem.total.numa"
	MetricMemUsedNuma      = "mem.used.numa"
	MetricMemFreeNuma      = "mem.free.numa"
	MetricMemShmemNuma     = "mem.shmem.numa"
	MetricMemAvailableNuma = "mem.available.numa"
	MetricMemFilepageNuma  = "mem.filepage.numa"

	MetricMemBandwidthNuma       = "mem.bandwidth.numa"
	MetricMemBandwidthMaxNuma    = "mem.bandwidth.max.numa"
	MetricMemBandwidthTheoryNuma = "mem.bandwidth.theory.numa"
	MetricMemBandwidthReadNuma   = "mem.bandwidth.read.numa"
	MetricMemBandwidthWriteNuma  = "mem.bandwidth.write.numa"

	MetricMemLatencyReadNuma  = "mem.latency.read.numa"
	MetricMemLatencyWriteNuma = "mem.latency.write.numa"
)

System numa metrics

const (
	MetricCPUUsage       = "cpu.usage.cpu"
	MetricCPUSchedwait   = "cpu.schedwait.cpu"
	MetricCPUIOWaitRatio = "cpu.iowait.ratio.cpu"
)

System cpu compute metrics

const (
	MetricCPULimitContainer      = "cpu.limit.container"
	MetricCPUUsageContainer      = "cpu.usage.container"
	MetricCPUUsageRatioContainer = "cpu.usage.ratio.container"
	MetricCPUUsageUserContainer  = "cpu.usage.user.container"
	MetricCPUUsageSysContainer   = "cpu.usage.sys.container"

	MetricCPUShareContainer           = "cpu.share.container"
	MetricCPUQuotaContainer           = "cpu.quota.container"
	MetricCPUPeriodContainer          = "cpu.period.container"
	MetricCPUNrThrottledContainer     = "cpu.nr.throttled.container"
	MetricCPUThrottledPeriodContainer = "cpu.throttled.period.container"
	MetricCPUThrottledTimeContainer   = "cpu.throttled.time.container"

	MetricCPUNrRunnableContainer        = "cpu.nr.runnable.container"
	MetricCPUNrUninterruptibleContainer = "cpu.nr.uninterruptible.container"
	MetricCPUNrIOWaitContainer          = "cpu.nr.iowait.container"

	MetricLoad1MinContainer  = "cpu.load.1min.container"
	MetricLoad5MinContainer  = "cpu.load.5min.container"
	MetricLoad15MinContainer = "cpu.load.15min.container"

	MetricOCRReadDRAMsContainer = "cpu.read.drams.container"
	MetricIMCWriteContainer     = "cpu.imc.write.container"
	MetricStoreAllInsContainer  = "cpu.store.allins.container"
	MetricStoreInsContainer     = "cpu.store.ins.container"

	MetricUpdateTimeContainer = "cpu.updatetime.container"
)

Cgroup cpu metrics

const (
	MetricMemLimitContainer     = "mem.limit.container"
	MetricMemUsageContainer     = "mem.usage.container"
	MetricMemUsageUserContainer = "mem.usage.user.container"
	MetricMemUsageSysContainer  = "mem.usage.sys.container"
	MetricMemRssContainer       = "mem.rss.container"
	MetricMemCacheContainer     = "mem.cache.container"
	MetricMemShmemContainer     = "mem.shmem.container"

	MetricMemDirtyContainer       = "mem.dirty.container"
	MetricMemWritebackContainer   = "mem.writeback.container"
	MetricMemPgfaultContainer     = "mem.pgfault.container"
	MetricMemPgmajfaultContainer  = "mem.pgmajfault.container"
	MetricMemAllocstallContainer  = "mem.allocstall.container"
	MetricMemKswapdstealContainer = "mem.kswapdstall.container"

	MetricMemOomContainer         = "mem.oom.container"
	MetricMemScaleFactorContainer = "mem.scalefactor.container"

	MetricMemBandwidthReadContainer  = "mem.bandwidth.read.container"
	MetricMemBandwidthWriteContainer = "mem.bandwidth.write.container"
)

Cgroup memory metrics

const (
	MetricBlkioReadIopsContainer  = "blkio.read.iops.container"
	MetricBlkioWriteIopsContainer = "blkio.write.iops.container"
	MetricBlkioReadBpsContainer   = "blkio.read.bps.container"
	MetricBlkioWriteBpsContainer  = "blkio.write.bps.container"
)

Cgroup blkio metrics

const (
	MetricNetTcpSendByteContainer = "net.tcp.send.byte.container"
	MetricNetTcpSendPpsContainer  = "net.tcp.send.pps.container"
	MetricNetTcpRecvByteContainer = "net.tcp.recv.byte.container"
	MetricNetTcpRecvPpsContainer  = "net.tcp.recv.pps.container"
)

Cgroup net metrics

const (
	MetricCPUCpiContainer          = "cpu.cpi.container"
	MetricCPUCyclesContainer       = "cpu.cycles.container"
	MetricCPUInstructionsContainer = "cpu.instructions.container"
	MetricCPUICacheMissContainer   = "cpu.icachemiss.container"
	MetricCPUL2CacheMissContainer  = "cpu.l2cachemiss.container"
	MetricCPUL3CacheMissContainer  = "cpu.l3cachemiss.container"
)

Cgroup perf metrics

const (
	MetricsMemTotalPerNumaContainer = "mem.total.numa.container"
	MetricsMemFilePerNumaContainer  = "mem.file.numa.container"
	MetricsMemAnonPerNumaContainer  = "mem.anon.numa.container"
)

Cgroup per numa metrics

const EventActionEvicting = "Evicting"

EventActionEvicting is const variable for pod eviction action identifier in event.

const (
	KatalystCustomConfigAnnotationKeyConfigHash = "kcc.katalyst.kubewharf.io/config.hash"
)

KatalystCustomConfigAnnotationKeyConfigHash defines const variables for kcc annotations about config hash.

const (
	KatalystCustomConfigFinalizerKCC = "kcc.katalyst.kubewharf.io/kcc-controller"
)

KatalystCustomConfigFinalizerKCC defines const variables for kcc finalizer

const KatalystNodeDomainPrefix = "node.katalyst.kubewharf.io"

KatalystNodeDomainPrefix domain prefix for taint, label, annotation keys.

const KeySeparator = "/"

KeySeparator : to split parts of a key

const (
	// KubeletQoSResourceManagerCheckpoint is the name of the checkpoint file for kubelet QoS resource manager
	KubeletQoSResourceManagerCheckpoint = "kubelet_qrm_checkpoint"
)

const (
	ServiceProfileDescriptorAnnotationKeyConfigHash = "spd.katalyst.kubewharf.io/config.hash"
)

ServiceProfileDescriptorAnnotationKeyConfigHash defines const variables for spd annotations about config hash.

Types

type ContainerName

type ContainerName string

type KatalystComponent

type KatalystComponent string

KatalystComponent defines the component name that current process is running as.

const (
	KatalystComponentAgent      KatalystComponent = "agent"
	KatalystComponentController KatalystComponent = "controller"
	KatalystComponentWebhook    KatalystComponent = "webhook"
	KatalystComponentMetric     KatalystComponent = "metric"
	KatalystComponentScheduler  KatalystComponent = "scheduler"
)

type PodContainerName

type PodContainerName string