Documentation
¶
Overview ¶
Package v1alpha1 provides alpha API for Katalyst Node API objects.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type Allocation
- type CNRCondition
- type CNRConditionType
- type CustomNodeResource
- type CustomNodeResourceList
- type CustomNodeResourceSpec
- type CustomNodeResourceStatus
- type NumaStatus
- type Property
- type SocketStatus
- type Taint
- type TaintEffect
- type TopologyStatus
Constants ¶
const ( // GroupName is the group name used in this package GroupName string = "node.katalyst.kubewharf.io" )
const (
ResourceNameKatalystCNR = "customnoderesources"
)
ResourceNameKatalystCNR is used to construct standard gvr
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 Allocation ¶
type Allocation struct {
Consumer string `json:"consumer"`
// +optional
Requests *v1.ResourceList `json:"requests,omitempty"`
}
func (*Allocation) DeepCopy ¶
func (in *Allocation) DeepCopy() *Allocation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Allocation.
func (*Allocation) DeepCopyInto ¶
func (in *Allocation) DeepCopyInto(out *Allocation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CNRCondition ¶
type CNRCondition struct {
// Type is the type of the condition.
Type CNRConditionType `json:"type"`
// Status of the condition, one of True, False, Unknown.
Status v1.ConditionStatus `json:"status" `
// Last time we got an update on a given condition.
// +optional
LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime,omitempty"`
// (brief) reason for the condition's last transition.
// +optional
Reason string `json:"reason,omitempty"`
// Human-readable message indicating details about last transition.
// +optional
Message string `json:"message,omitempty"`
}
CNRCondition contains condition information for a cnr.
func (*CNRCondition) DeepCopy ¶
func (in *CNRCondition) DeepCopy() *CNRCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CNRCondition.
func (*CNRCondition) DeepCopyInto ¶
func (in *CNRCondition) DeepCopyInto(out *CNRCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CNRConditionType ¶
type CNRConditionType string
const ( CNRAgentReady CNRConditionType = "AgentReady" CNRAgentNotFound CNRConditionType = "AgentNotFound" )
type CustomNodeResource ¶
type CustomNodeResource struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of a CustomNodeResource.
// +optional
Spec CustomNodeResourceSpec `json:"spec,omitempty"`
// Status represents the current information about a CustomNodeResource.
// This data may not be up-to-date.
// +optional
Status CustomNodeResourceStatus `json:"status,omitempty"`
}
CustomNodeResource captures information about a custom defined node resource CustomNodeResource objects are non-namespaced.
func (*CustomNodeResource) DeepCopy ¶
func (in *CustomNodeResource) DeepCopy() *CustomNodeResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeResource.
func (*CustomNodeResource) DeepCopyInto ¶
func (in *CustomNodeResource) DeepCopyInto(out *CustomNodeResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomNodeResource) DeepCopyObject ¶
func (in *CustomNodeResource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomNodeResourceList ¶
type CustomNodeResourceList struct {
metav1.TypeMeta `json:",inline"`
// Standard list metadata
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ListMeta `json:"metadata,omitempty"`
// items is the list of CNRs
Items []CustomNodeResource `json:"items"`
}
CustomNodeResourceList is a collection of CustomNodeResource objects.
func (*CustomNodeResourceList) DeepCopy ¶
func (in *CustomNodeResourceList) DeepCopy() *CustomNodeResourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeResourceList.
func (*CustomNodeResourceList) DeepCopyInto ¶
func (in *CustomNodeResourceList) DeepCopyInto(out *CustomNodeResourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomNodeResourceList) DeepCopyObject ¶
func (in *CustomNodeResourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomNodeResourceSpec ¶
type CustomNodeResourceSpec struct {
// +optional
NodeResourceProperties []*Property `json:"nodeResourceProperties,omitempty"`
// customized taint for katalyst, which may affect partial tasks
// +optional
Taints []*Taint `json:"taints,omitempty"`
}
func (*CustomNodeResourceSpec) DeepCopy ¶
func (in *CustomNodeResourceSpec) DeepCopy() *CustomNodeResourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeResourceSpec.
func (*CustomNodeResourceSpec) DeepCopyInto ¶
func (in *CustomNodeResourceSpec) DeepCopyInto(out *CustomNodeResourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomNodeResourceStatus ¶
type CustomNodeResourceStatus struct {
// +optional
ResourceAllocatable *v1.ResourceList `json:"resourceAllocatable,omitempty"`
// +optional
ResourceCapacity *v1.ResourceList `json:"resourceCapacity,omitempty"`
// +optional
TopologyStatus *TopologyStatus `json:"topologyStatus,omitempty"`
// Conditions is an array of current observed cnr conditions.
// +optional
Conditions []CNRCondition `json:"conditions,omitempty"`
}
func (*CustomNodeResourceStatus) DeepCopy ¶
func (in *CustomNodeResourceStatus) DeepCopy() *CustomNodeResourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomNodeResourceStatus.
func (*CustomNodeResourceStatus) DeepCopyInto ¶
func (in *CustomNodeResourceStatus) DeepCopyInto(out *CustomNodeResourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NumaStatus ¶
type NumaStatus struct {
NumaID int `json:"numaID"`
// +optional
Allocatable *v1.ResourceList `json:"allocatable,omitempty"`
// +optional
Capacity *v1.ResourceList `json:"capacity,omitempty"`
// +optional
Allocations []*Allocation `json:"allocations,omitempty"`
}
func (*NumaStatus) DeepCopy ¶
func (in *NumaStatus) DeepCopy() *NumaStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaStatus.
func (*NumaStatus) DeepCopyInto ¶
func (in *NumaStatus) DeepCopyInto(out *NumaStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Property ¶
type Property struct {
// property name
PropertyName string `json:"propertyName"`
// values of the specific property
// +optional
PropertyValues []string `json:"propertyValues,omitempty"`
// values of the quantity-types property
// +optional
PropertyQuantity *resource.Quantity `json:"propertyQuantity,omitempty"`
}
func (*Property) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Property.
func (*Property) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SocketStatus ¶
type SocketStatus struct {
SocketID int `json:"socketID"`
// +optional
Numas []*NumaStatus `json:"numas,omitempty"`
}
func (*SocketStatus) DeepCopy ¶
func (in *SocketStatus) DeepCopy() *SocketStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SocketStatus.
func (*SocketStatus) DeepCopyInto ¶
func (in *SocketStatus) DeepCopyInto(out *SocketStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Taint ¶
type Taint struct {
// Required. The taint key to be applied to a node.
Key string `json:"key,omitempty"`
// Required. The taint value corresponding to the taint key.
// +optional
Value string `json:"value,omitempty"`
// Required. The effect of the taint on pods
// that do not tolerate the taint.
// Valid effects are NoScheduleForReclaimedTasks.
Effect TaintEffect `json:"effect,omitempty"`
}
func (*Taint) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Taint.
func (*Taint) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaintEffect ¶
type TaintEffect string
const ( // TaintEffectNoScheduleForReclaimedTasks // Do not allow new pods using reclaimed resources to schedule onto the node unless they tolerate the taint, // but allow all pods submitted to Kubelet without going through the scheduler // to start, and allow all already-running pods to continue running. // Enforced by the scheduler. TaintEffectNoScheduleForReclaimedTasks TaintEffect = "NoScheduleForReclaimedTasks" )
type TopologyStatus ¶
type TopologyStatus struct {
// +optional
Sockets []*SocketStatus `json:"sockets,omitempty"`
}
func (*TopologyStatus) DeepCopy ¶
func (in *TopologyStatus) DeepCopy() *TopologyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TopologyStatus.
func (*TopologyStatus) DeepCopyInto ¶
func (in *TopologyStatus) DeepCopyInto(out *TopologyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.