v1alpha1

package
v0.4.16-0rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the nodetopology v1alpha1 API group +kubebuilder:object:generate=true +groupName=nodetopology.openshift.io

Index

Constants

View Source
const (
	Separator = '/'
)

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "nodetopology.openshift.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme

	// SchemeGroupVersion is DEPRECATED, needed for the client generation
	SchemeGroupVersion = GroupVersion
)

Functions

This section is empty.

Types

type InfoRefreshMode

type InfoRefreshMode string

+kubebuilder:validation:Enum=Periodic;Events;PeriodicAndEvents

var (
	// InfoRefreshPeriodic is the default. Periodically polls the state and reports it.
	InfoRefreshPeriodic InfoRefreshMode = "Periodic"

	// InfoRefreshEvents reports a new state each time a pod lifecycle event is received.
	InfoRefreshEvents InfoRefreshMode = "Events"

	// InfoRefreshPeriodicAndEvents enables both periodic and event-based reporting.
	InfoRefreshPeriodicAndEvents InfoRefreshMode = "PeriodicAndEvents"
)

type MachineConfigPool

type MachineConfigPool struct {
	// Name the name of the machine config pool
	Name string `json:"name"`
	// Conditions represents the latest available observations of MachineConfigPool current state.
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Optional conditions reported for this NodeGroup"
	Conditions []mcov1.MachineConfigPoolCondition `json:"conditions,omitempty"`
	// NodeGroupConfig represents the latest available configuration applied to this MachineConfigPool
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Optional configuration enforced on this NodeGroup"
	Config *NodeGroupConfig `json:"config,omitempty"`
}

MachineConfigPool defines the observed state of each MachineConfigPool selected by node groups

func (*MachineConfigPool) DeepCopy

func (in *MachineConfigPool) DeepCopy() *MachineConfigPool

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineConfigPool.

func (*MachineConfigPool) DeepCopyInto

func (in *MachineConfigPool) DeepCopyInto(out *MachineConfigPool)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NUMAResourcesOperator

type NUMAResourcesOperator struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NUMAResourcesOperatorSpec   `json:"spec,omitempty"`
	Status NUMAResourcesOperatorStatus `json:"status,omitempty"`
}

NUMAResourcesOperator is the Schema for the numaresourcesoperators API +operator-sdk:csv:customresourcedefinitions:displayName="NUMA Resources Operator",resources={{DaemonSet,v1,rte-daemonset,ConfigMap,v1,rte-configmap}}

func (*NUMAResourcesOperator) ConvertFrom

func (dst *NUMAResourcesOperator) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1) to this version.

func (*NUMAResourcesOperator) ConvertFromV1Rote

func (dst *NUMAResourcesOperator) ConvertFromV1Rote(src *nropv1.NUMAResourcesOperator) error

func (*NUMAResourcesOperator) ConvertTo

func (src *NUMAResourcesOperator) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this NUMAResourcesOperator to the Hub version (v1).

func (*NUMAResourcesOperator) ConvertToV1NodeGroups

func (src *NUMAResourcesOperator) ConvertToV1NodeGroups(dst *nropv1.NUMAResourcesOperator) error

func (*NUMAResourcesOperator) ConvertToV1Rote

func (src *NUMAResourcesOperator) ConvertToV1Rote(dst *nropv1.NUMAResourcesOperator) error

func (*NUMAResourcesOperator) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesOperator.

func (*NUMAResourcesOperator) DeepCopyInto

func (in *NUMAResourcesOperator) DeepCopyInto(out *NUMAResourcesOperator)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NUMAResourcesOperator) DeepCopyObject

func (in *NUMAResourcesOperator) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NUMAResourcesOperatorList

type NUMAResourcesOperatorList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NUMAResourcesOperator `json:"items"`
}

NUMAResourcesOperatorList contains a list of NUMAResourcesOperator

func (*NUMAResourcesOperatorList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesOperatorList.

func (*NUMAResourcesOperatorList) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NUMAResourcesOperatorList) DeepCopyObject

func (in *NUMAResourcesOperatorList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NUMAResourcesOperatorSpec

type NUMAResourcesOperatorSpec struct {
	// Group of Nodes to enable RTE on
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Group of nodes to enable RTE on"
	NodeGroups []NodeGroup `json:"nodeGroups,omitempty"`
	// Optional Resource Topology Exporter image URL
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Optional RTE image URL",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	ExporterImage string `json:"imageSpec,omitempty"`
	// Valid values are: "Normal", "Debug", "Trace", "TraceAll".
	// Defaults to "Normal".
	// +optional
	// +kubebuilder:default=Normal
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="RTE log verbosity"
	LogLevel operatorv1.LogLevel `json:"logLevel,omitempty"`
	// Optional Namespace/Name glob patterns of pod to ignore at node level
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Optional ignore pod namespace/name glob patterns"
	PodExcludes []NamespacedName `json:"podExcludes,omitempty"`
}

NUMAResourcesOperatorSpec defines the desired state of NUMAResourcesOperator

func (*NUMAResourcesOperatorSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesOperatorSpec.

func (*NUMAResourcesOperatorSpec) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NUMAResourcesOperatorStatus

type NUMAResourcesOperatorStatus struct {
	// DaemonSets of the configured RTEs, one per node group
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="RTE DaemonSets"
	DaemonSets []NamespacedName `json:"daemonsets,omitempty"`
	// MachineConfigPools resolved from configured node groups
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="RTE MCPs from node groups"
	MachineConfigPools []MachineConfigPool `json:"machineconfigpools,omitempty"`
	// Conditions show the current state of the NUMAResourcesOperator Operator
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Condition reported"
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

NUMAResourcesOperatorStatus defines the observed state of NUMAResourcesOperator

func (*NUMAResourcesOperatorStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesOperatorStatus.

func (*NUMAResourcesOperatorStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NUMAResourcesScheduler

type NUMAResourcesScheduler struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NUMAResourcesSchedulerSpec   `json:"spec,omitempty"`
	Status NUMAResourcesSchedulerStatus `json:"status,omitempty"`
}

NUMAResourcesScheduler is the Schema for the numaresourcesschedulers API +operator-sdk:csv:customresourcedefinitions:displayName="NUMA Aware Scheduler",resources={{Deployment,v1,secondary-scheduler-deployment}}

func (*NUMAResourcesScheduler) ConvertFrom

func (dst *NUMAResourcesScheduler) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the Hub version (v1) to this version.

func (*NUMAResourcesScheduler) ConvertFromV1Rote

func (dst *NUMAResourcesScheduler) ConvertFromV1Rote(src *nropv1.NUMAResourcesScheduler) error

func (*NUMAResourcesScheduler) ConvertTo

func (src *NUMAResourcesScheduler) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this NUMAResourcesScheduler to the Hub version (v1).

func (*NUMAResourcesScheduler) ConvertToV1Rote

func (src *NUMAResourcesScheduler) ConvertToV1Rote(dst *nropv1.NUMAResourcesScheduler) error

func (*NUMAResourcesScheduler) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesScheduler.

func (*NUMAResourcesScheduler) DeepCopyInto

func (in *NUMAResourcesScheduler) DeepCopyInto(out *NUMAResourcesScheduler)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NUMAResourcesScheduler) DeepCopyObject

func (in *NUMAResourcesScheduler) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NUMAResourcesSchedulerList

type NUMAResourcesSchedulerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NUMAResourcesScheduler `json:"items"`
}

NUMAResourcesSchedulerList contains a list of NUMAResourcesScheduler

func (*NUMAResourcesSchedulerList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesSchedulerList.

func (*NUMAResourcesSchedulerList) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NUMAResourcesSchedulerList) DeepCopyObject

func (in *NUMAResourcesSchedulerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NUMAResourcesSchedulerSpec

type NUMAResourcesSchedulerSpec struct {
	// Scheduler container image URL
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Scheduler container image URL",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	SchedulerImage string `json:"imageSpec"`
	// Scheduler name to be used in pod templates
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Scheduler name",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	SchedulerName string `json:"schedulerName,omitempty"`
	// Valid values are: "Normal", "Debug", "Trace", "TraceAll".
	// Defaults to "Normal".
	// +optional
	// +kubebuilder:default=Normal
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Scheduler log verbosity"
	LogLevel operatorv1.LogLevel `json:"logLevel,omitempty"`
	// Set the cache resync period. Use explicit 0 to disable.
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Scheduler cache resync period setting",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	CacheResyncPeriod *metav1.Duration `json:"cacheResyncPeriod,omitempty"`
}

NUMAResourcesSchedulerSpec defines the desired state of NUMAResourcesScheduler

func (*NUMAResourcesSchedulerSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesSchedulerSpec.

func (*NUMAResourcesSchedulerSpec) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NUMAResourcesSchedulerStatus

type NUMAResourcesSchedulerStatus struct {
	// Deployment of the secondary scheduler, namespaced name
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Scheduler deployment"
	Deployment NamespacedName `json:"deployment,omitempty"`
	// Scheduler name to be used in pod templates
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Scheduler name"
	SchedulerName string `json:"schedulerName,omitempty"`
	// Conditions show the current state of the NUMAResourcesOperator Operator
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

NUMAResourcesSchedulerStatus defines the observed state of NUMAResourcesScheduler

func (*NUMAResourcesSchedulerStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NUMAResourcesSchedulerStatus.

func (*NUMAResourcesSchedulerStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NamespacedName

type NamespacedName struct {
	Namespace string `json:"namespace,omitempty"`
	Name      string `json:"name,omitempty"`
}

NamespacedName comprises a resource name, with a mandatory namespace, rendered as "<namespace>/<name>".

func (*NamespacedName) DeepCopy

func (in *NamespacedName) DeepCopy() *NamespacedName

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespacedName.

func (*NamespacedName) DeepCopyInto

func (in *NamespacedName) DeepCopyInto(out *NamespacedName)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (NamespacedName) String

func (n NamespacedName) String() string

String returns the general purpose string representation

type NodeGroup

type NodeGroup struct {
	// MachineConfigPoolSelector defines label selector for the machine config pool
	// +optional
	MachineConfigPoolSelector *metav1.LabelSelector `json:"machineConfigPoolSelector,omitempty"`
	// DisablePodsFingerprinting defines if pod fingerprint should be omitted for the machines belonging to this group (DEPRECATED: use Config instead)
	// +optional
	DisablePodsFingerprinting *bool `json:"disablePodsFingerprinting,omitempty"`
	// Config defines the RTE behavior for this NodeGroup
	// +optional
	Config *NodeGroupConfig `json:"config,omitempty"`
}

NodeGroup defines group of nodes that will run resource topology exporter daemon set You can choose the group of node by MachineConfigPoolSelector or by NodeSelector

func (*NodeGroup) DeepCopy

func (in *NodeGroup) DeepCopy() *NodeGroup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeGroup.

func (*NodeGroup) DeepCopyInto

func (in *NodeGroup) DeepCopyInto(out *NodeGroup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (NodeGroup) NormalizeConfig

func (nodeGroup NodeGroup) NormalizeConfig() NodeGroupConfig

type NodeGroupConfig

type NodeGroupConfig struct {
	// PodsFingerprinting defines if pod fingerprint should be reported for the machines belonging to this group
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Enable or disable the pods fingerprinting setting",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	PodsFingerprinting *PodsFingerprintingMode `json:"podsFingerprinting,omitempty"`
	// InfoRefreshMode sets the mechanism which will be used to refresh the topology info.
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Topology info mechanism setting",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	InfoRefreshMode *InfoRefreshMode `json:"infoRefreshMode,omitempty"`
	// InfoRefreshPeriod sets the topology info refresh period. Use explicit 0 to disable.
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Topology info refresh period setting",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	InfoRefreshPeriod *metav1.Duration `json:"infoRefreshPeriod,omitempty"`
}

NodeGroupConfig exposes topology info reporting setting per node group

func DefaultNodeGroupConfig

func DefaultNodeGroupConfig() NodeGroupConfig

func (*NodeGroupConfig) DeepCopy

func (in *NodeGroupConfig) DeepCopy() *NodeGroupConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeGroupConfig.

func (*NodeGroupConfig) DeepCopyInto

func (in *NodeGroupConfig) DeepCopyInto(out *NodeGroupConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeGroupConfig) Default

func (ngc *NodeGroupConfig) Default()

func (NodeGroupConfig) Merge

func (current NodeGroupConfig) Merge(updated NodeGroupConfig) NodeGroupConfig

func (*NodeGroupConfig) ResetFromNodeGroup

func (conf *NodeGroupConfig) ResetFromNodeGroup(ng NodeGroup)

type PodsFingerprintingMode

type PodsFingerprintingMode string

+kubebuilder:validation:Enum=Enabled;Disabled

var (
	// PodsFingerprintingDisabled disables the pod fingerprinting reporting.
	PodsFingerprintingDisabled PodsFingerprintingMode = "Disabled"

	// PodsFingerprintingEnabled enables the pod fingerprint considering all the pods running on nodes. It is the default.
	PodsFingerprintingEnabled PodsFingerprintingMode = "Enabled"
)

Directories

Path Synopsis
helper

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL