Documentation
¶
Overview ¶
Package v1alpha1 provides alpha API for Katalyst config API objects.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type AgentConfig
- type ConfigConditionType
- type CustomNodeConfig
- type CustomNodeConfigList
- type CustomNodeConfigSpec
- type CustomNodeConfigStatus
- type EphemeralSelector
- type GenericConfigCondition
- type GenericConfigSpec
- type GenericConfigStatus
- type KatalystAgentConfig
- type KatalystAgentConfigList
- type KatalystAgentConfigSpec
- type KatalystCustomConfig
- type KatalystCustomConfigCondition
- type KatalystCustomConfigConditionType
- type KatalystCustomConfigList
- type KatalystCustomConfigSpec
- type KatalystCustomConfigStatus
- type MemoryEvictionPluginConfig
- type ReclaimedResourcesEvictionPluginConfig
- type TargetConfig
Constants ¶
const ( ResourceNameKatalystCustomConfigs = "katalystcustomconfigs" ResourceNameCustomNodeConfigs = "customnodeconfigs" ResourceNameKatalystAgentConfigs = "katalystagentconfigs" )
ResourceName const is used to construct standard gvr
const ( // GroupName is the group name used in this package GroupName string = "config.katalyst.kubewharf.io" )
Variables ¶
var ( // SchemeBuilder collects schemas to build. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme is used by generated client to add this scheme to the generated client. AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AgentConfig ¶
type AgentConfig struct {
// reclaimed resources eviction plugin options
ReclaimedResourcesEvictionPluginConfig ReclaimedResourcesEvictionPluginConfig `json:"reclaimedResourcesEvictionPluginConfig,omitempty"`
// MemoryEvictionPluginConfig is the config for memory eviction plugin
MemoryEvictionPluginConfig MemoryEvictionPluginConfig `json:"memoryEvictionPluginConfig,omitempty"`
}
func (*AgentConfig) DeepCopy ¶
func (in *AgentConfig) DeepCopy() *AgentConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AgentConfig.
func (*AgentConfig) DeepCopyInto ¶
func (in *AgentConfig) DeepCopyInto(out *AgentConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConfigConditionType ¶
type ConfigConditionType string
const ( // ConfigConditionTypeValid means this config whether is valid ConfigConditionTypeValid ConfigConditionType = "Valid" )
type CustomNodeConfig ¶
type CustomNodeConfig struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CustomNodeConfigSpec `json:"spec,omitempty"`
Status CustomNodeConfigStatus `json:"status,omitempty"`
}
CustomNodeConfig is the Schema for the customnodeconfigs API
func (*CustomNodeConfig) DeepCopy ¶
func (in *CustomNodeConfig) DeepCopy() *CustomNodeConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeConfig.
func (*CustomNodeConfig) DeepCopyInto ¶
func (in *CustomNodeConfig) DeepCopyInto(out *CustomNodeConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomNodeConfig) DeepCopyObject ¶
func (in *CustomNodeConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomNodeConfigList ¶
type CustomNodeConfigList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CustomNodeConfig `json:"items"`
}
CustomNodeConfigList contains a list of CustomNodeConfig
func (*CustomNodeConfigList) DeepCopy ¶
func (in *CustomNodeConfigList) DeepCopy() *CustomNodeConfigList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeConfigList.
func (*CustomNodeConfigList) DeepCopyInto ¶
func (in *CustomNodeConfigList) DeepCopyInto(out *CustomNodeConfigList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomNodeConfigList) DeepCopyObject ¶
func (in *CustomNodeConfigList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomNodeConfigSpec ¶
type CustomNodeConfigSpec struct {
}
func (*CustomNodeConfigSpec) DeepCopy ¶
func (in *CustomNodeConfigSpec) DeepCopy() *CustomNodeConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeConfigSpec.
func (*CustomNodeConfigSpec) DeepCopyInto ¶
func (in *CustomNodeConfigSpec) DeepCopyInto(out *CustomNodeConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomNodeConfigStatus ¶
type CustomNodeConfigStatus struct {
// KatalystCustomConfigList contains a list of target custom config
KatalystCustomConfigList []TargetConfig `json:"katalystCustomConfigList,omitempty"`
// ServiceProfileConfigList contains a list of target service Profile config
ServiceProfileConfigList []TargetConfig `json:"serviceProfileConfigList,omitempty"`
}
CustomNodeConfigStatus defines the desired state of KatalystCustomConfig
func (*CustomNodeConfigStatus) DeepCopy ¶
func (in *CustomNodeConfigStatus) DeepCopy() *CustomNodeConfigStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeConfigStatus.
func (*CustomNodeConfigStatus) DeepCopyInto ¶
func (in *CustomNodeConfigStatus) DeepCopyInto(out *CustomNodeConfigStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EphemeralSelector ¶
type EphemeralSelector struct {
// Specific nodes' name the configurations will be effected.
// +optional
NodeNames []string `json:"nodeNames,omitempty"`
// define the duration this configuration will last from creationTimestamp.
// must and only set when NodeNames already set
LastDuration *metav1.Duration `json:"lastDuration,omitempty"`
}
func (*EphemeralSelector) DeepCopy ¶
func (in *EphemeralSelector) DeepCopy() *EphemeralSelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EphemeralSelector.
func (*EphemeralSelector) DeepCopyInto ¶
func (in *EphemeralSelector) DeepCopyInto(out *EphemeralSelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GenericConfigCondition ¶
type GenericConfigCondition struct {
// Type of config condition
Type ConfigConditionType `json:"type"`
// Status of the condition, one of True, False, Unknown.
Status v1.ConditionStatus `json:"status"`
// Last time the condition transit from one status to another.
// +optional
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
// reason is the reason for the condition's last transition.
// +optional
Reason string `json:"reason,omitempty"`
// message is a human-readable explanation containing details about the transition
// +optional
Message string `json:"message,omitempty"`
}
func (*GenericConfigCondition) DeepCopy ¶
func (in *GenericConfigCondition) DeepCopy() *GenericConfigCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericConfigCondition.
func (*GenericConfigCondition) DeepCopyInto ¶
func (in *GenericConfigCondition) DeepCopyInto(out *GenericConfigCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GenericConfigSpec ¶
type GenericConfigSpec struct {
// RevisionHistoryLimit is the maximum number of revisions that will
// be maintained in the resource's revision history. The revision history
// consists of all revisions not represented by a currently applied
// Spec version. The default value is 3.
// +kubebuilder:default:=3
RevisionHistoryLimit int64 `json:"revisionHistoryLimit,omitempty"`
// NodeLabelSelector select nodes to apply these configurations
// if spec.labelKey no set, NodeLabelSelector must be empty
// the label selector must only include KatalystAgentConfig.spec
// .nodeLabelSelectorKey, otherwise it will not be synced
// This field will be immutable after it is initially set.
// +optional
NodeLabelSelector string `json:"nodeLabelSelector,omitempty"`
// EphemeralSelector is used to indicate the
// +optional
EphemeralSelector EphemeralSelector `json:"ephemeralSelector,omitempty"`
}
func (*GenericConfigSpec) DeepCopy ¶
func (in *GenericConfigSpec) DeepCopy() *GenericConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericConfigSpec.
func (*GenericConfigSpec) DeepCopyInto ¶
func (in *GenericConfigSpec) DeepCopyInto(out *GenericConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GenericConfigStatus ¶
type GenericConfigStatus struct {
// Count of hash collisions for this cr. The kcc controller
// uses this field as a collision avoidance mechanism when it needs to
// create the name for the newest ControllerRevision.
// +optional
CollisionCount *int32 `json:"collisionCount,omitempty"`
// The most recent generation observed by the kcc controller.
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// Represents the latest available observations of a config's current state.
Conditions []GenericConfigCondition `json:"conditions,omitempty"`
}
func (*GenericConfigStatus) DeepCopy ¶
func (in *GenericConfigStatus) DeepCopy() *GenericConfigStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericConfigStatus.
func (*GenericConfigStatus) DeepCopyInto ¶
func (in *GenericConfigStatus) DeepCopyInto(out *GenericConfigStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KatalystAgentConfig ¶
type KatalystAgentConfig struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KatalystAgentConfigSpec `json:"spec,omitempty"`
Status GenericConfigStatus `json:"status,omitempty"`
}
KatalystAgentConfig is the Schema for the configuration API used by katalyst agent
func (*KatalystAgentConfig) DeepCopy ¶
func (in *KatalystAgentConfig) DeepCopy() *KatalystAgentConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystAgentConfig.
func (*KatalystAgentConfig) DeepCopyInto ¶
func (in *KatalystAgentConfig) DeepCopyInto(out *KatalystAgentConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KatalystAgentConfig) DeepCopyObject ¶
func (in *KatalystAgentConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KatalystAgentConfigList ¶
type KatalystAgentConfigList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KatalystAgentConfig `json:"items"`
}
KatalystAgentConfigList contains a list of KatalystAgentConfig
func (*KatalystAgentConfigList) DeepCopy ¶
func (in *KatalystAgentConfigList) DeepCopy() *KatalystAgentConfigList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystAgentConfigList.
func (*KatalystAgentConfigList) DeepCopyInto ¶
func (in *KatalystAgentConfigList) DeepCopyInto(out *KatalystAgentConfigList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KatalystAgentConfigList) DeepCopyObject ¶
func (in *KatalystAgentConfigList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KatalystAgentConfigSpec ¶
type KatalystAgentConfigSpec struct {
GenericConfigSpec `json:",inline"`
// Config is custom field for agent configuration
// all configuration crd should contain a field named with `config`
Config AgentConfig `json:"config,omitempty"`
}
KatalystAgentConfigSpec defines the desired state of KatalystAgentConfig
func (*KatalystAgentConfigSpec) DeepCopy ¶
func (in *KatalystAgentConfigSpec) DeepCopy() *KatalystAgentConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystAgentConfigSpec.
func (*KatalystAgentConfigSpec) DeepCopyInto ¶
func (in *KatalystAgentConfigSpec) DeepCopyInto(out *KatalystAgentConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KatalystCustomConfig ¶
type KatalystCustomConfig struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KatalystCustomConfigSpec `json:"spec,omitempty"`
Status KatalystCustomConfigStatus `json:"status,omitempty"`
}
KatalystCustomConfig is the Schema for the custom configuration API in katalyst
func (*KatalystCustomConfig) DeepCopy ¶
func (in *KatalystCustomConfig) DeepCopy() *KatalystCustomConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystCustomConfig.
func (*KatalystCustomConfig) DeepCopyInto ¶
func (in *KatalystCustomConfig) DeepCopyInto(out *KatalystCustomConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KatalystCustomConfig) DeepCopyObject ¶
func (in *KatalystCustomConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KatalystCustomConfigCondition ¶
type KatalystCustomConfigCondition struct {
// Type of KatalystCustomConfig condition
Type KatalystCustomConfigConditionType `json:"type"`
// Status of the condition, one of True, False, Unknown.
Status v1.ConditionStatus `json:"status"`
// Last time the condition transit from one status to another.
// +optional
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
// reason is the reason for the condition's last transition.
// +optional
Reason string `json:"reason,omitempty"`
// message is a human-readable explanation containing details about the transition
// +optional
Message string `json:"message,omitempty"`
}
func (*KatalystCustomConfigCondition) DeepCopy ¶
func (in *KatalystCustomConfigCondition) DeepCopy() *KatalystCustomConfigCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystCustomConfigCondition.
func (*KatalystCustomConfigCondition) DeepCopyInto ¶
func (in *KatalystCustomConfigCondition) DeepCopyInto(out *KatalystCustomConfigCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KatalystCustomConfigConditionType ¶
type KatalystCustomConfigConditionType string
const (
KatalystCustomConfigConditionTypeValid KatalystCustomConfigConditionType = "Valid"
)
type KatalystCustomConfigList ¶
type KatalystCustomConfigList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KatalystCustomConfig `json:"items"`
}
KatalystCustomConfigList contains a list of KatalystCustomConfig
func (*KatalystCustomConfigList) DeepCopy ¶
func (in *KatalystCustomConfigList) DeepCopy() *KatalystCustomConfigList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystCustomConfigList.
func (*KatalystCustomConfigList) DeepCopyInto ¶
func (in *KatalystCustomConfigList) DeepCopyInto(out *KatalystCustomConfigList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KatalystCustomConfigList) DeepCopyObject ¶
func (in *KatalystCustomConfigList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KatalystCustomConfigSpec ¶
type KatalystCustomConfigSpec struct {
// the GVR of target config type
TargetType metav1.GroupVersionResource `json:"targetType"`
// whether disable revisionHistory for the KatalystCustomConfig resource
// +kubebuilder:default:=true
// +optional
DisableRevisionHistory bool `json:"disableRevisionHistory,omitempty"`
// key of node label to select which nodes will be effected by the KatalystCustomConfig resource
// +optional
NodeLabelSelectorKey string `json:"nodeLabelSelectorKey,omitempty"`
}
KatalystCustomConfigSpec defines the desired state of KatalystCustomConfig
func (*KatalystCustomConfigSpec) DeepCopy ¶
func (in *KatalystCustomConfigSpec) DeepCopy() *KatalystCustomConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystCustomConfigSpec.
func (*KatalystCustomConfigSpec) DeepCopyInto ¶
func (in *KatalystCustomConfigSpec) DeepCopyInto(out *KatalystCustomConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KatalystCustomConfigStatus ¶
type KatalystCustomConfigStatus struct {
// ObservedGeneration is the generation as observed by the controller consuming the KatalystCustomConfig.
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// InvalidTargetConfigList is a name list of invalid Config
InvalidTargetConfigList []string `json:"invalidTargetConfigList,omitempty"`
// Represents the latest available observations of a KatalystCustomConfig's current state.
Conditions []KatalystCustomConfigCondition `json:"conditions,omitempty"`
}
KatalystCustomConfigStatus defines the observed state of KatalystCustomConfig
func (*KatalystCustomConfigStatus) DeepCopy ¶
func (in *KatalystCustomConfigStatus) DeepCopy() *KatalystCustomConfigStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KatalystCustomConfigStatus.
func (*KatalystCustomConfigStatus) DeepCopyInto ¶
func (in *KatalystCustomConfigStatus) DeepCopyInto(out *KatalystCustomConfigStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MemoryEvictionPluginConfig ¶
type MemoryEvictionPluginConfig struct {
// EnableNumaLevelDetection is whether to enable numa-level detection
EnableNumaLevelDetection *bool `json:"enableNumaLevelDetection,omitempty"`
// EnableSystemLevelDetection is whether to enable system-level detection
EnableSystemLevelDetection *bool `json:"enableSystemLevelDetection,omitempty"`
// NumaFreeBelowWatermarkTimesThreshold is the threshold for the number of times NUMA's free memory falls below the watermark
NumaFreeBelowWatermarkTimesThreshold *int `json:"numaFreeBelowWatermarkTimesThreshold,omitempty"`
// NumaFreeBelowWatermarkTimesThreshold is the threshold for the rate of kswapd reclaiming rate
SystemKswapdRateThreshold *int `json:"systemKswapdRateThreshold,omitempty"`
// SystemKswapdRateExceedCountThreshold is the threshold for the number of times the kswapd reclaiming rate exceeds the threshold
SystemKswapdRateExceedTimesThreshold *int `json:"systemKswapdRateExceedTimesThreshold,omitempty"`
// NumaEvictionRankingMetrics is the metrics used to rank pods for eviction at the NUMA level
NumaEvictionRankingMetrics []string `json:"numaEvictionRankingMetrics,omitempty"`
// SystemEvictionRankingMetrics is the metrics used to rank pods for eviction at the system level
SystemEvictionRankingMetrics []string `json:"systemEvictionRankingMetrics,omitempty"`
// GracePeriod is the grace period of memory eviction
GracePeriod *int64 `json:"gracePeriod,omitempty"`
}
func (*MemoryEvictionPluginConfig) DeepCopy ¶
func (in *MemoryEvictionPluginConfig) DeepCopy() *MemoryEvictionPluginConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MemoryEvictionPluginConfig.
func (*MemoryEvictionPluginConfig) DeepCopyInto ¶
func (in *MemoryEvictionPluginConfig) DeepCopyInto(out *MemoryEvictionPluginConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReclaimedResourcesEvictionPluginConfig ¶
type ReclaimedResourcesEvictionPluginConfig struct {
// eviction threshold rate for reclaimed resources
EvictionThreshold map[v1.ResourceName]float64 `json:"evictionThreshold,omitempty"`
}
func (*ReclaimedResourcesEvictionPluginConfig) DeepCopy ¶
func (in *ReclaimedResourcesEvictionPluginConfig) DeepCopy() *ReclaimedResourcesEvictionPluginConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReclaimedResourcesEvictionPluginConfig.
func (*ReclaimedResourcesEvictionPluginConfig) DeepCopyInto ¶
func (in *ReclaimedResourcesEvictionPluginConfig) DeepCopyInto(out *ReclaimedResourcesEvictionPluginConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TargetConfig ¶
type TargetConfig struct {
// ConfigType gvr of target config
ConfigType metav1.GroupVersionResource `json:"configType"`
// ConfigName name of target config
ConfigName string `json:"configName"`
// ConfigNamespace namespace of target config
ConfigNamespace string `json:"configNamespace"`
// Hash is current hash value of target config.
// The agent will first check whether the local config hash and
// the target config hash are equal, only if not, it will try to
// update the local config from the remote.
Hash string `json:"hash"`
}
TargetConfig current hash for specific gvk config object
func (*TargetConfig) DeepCopy ¶
func (in *TargetConfig) DeepCopy() *TargetConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetConfig.
func (*TargetConfig) DeepCopyInto ¶
func (in *TargetConfig) DeepCopyInto(out *TargetConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.