v1

Documentation

Overview

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

Index

• Variables
• type ConfigMap
  • func (c *ConfigMap) Data() string
  • func (in *ConfigMap) DeepCopy() *ConfigMap
  • func (in *ConfigMap) DeepCopyInto(out *ConfigMap)
• type NodeFeatureDiscovery
  • func (in *NodeFeatureDiscovery) DeepCopy() *NodeFeatureDiscovery
  • func (in *NodeFeatureDiscovery) DeepCopyInto(out *NodeFeatureDiscovery)
  • func (in *NodeFeatureDiscovery) DeepCopyObject() runtime.Object
• type NodeFeatureDiscoveryList
  • func (in *NodeFeatureDiscoveryList) DeepCopy() *NodeFeatureDiscoveryList
  • func (in *NodeFeatureDiscoveryList) DeepCopyInto(out *NodeFeatureDiscoveryList)
  • func (in *NodeFeatureDiscoveryList) DeepCopyObject() runtime.Object
• type NodeFeatureDiscoverySpec
  • func (in *NodeFeatureDiscoverySpec) DeepCopy() *NodeFeatureDiscoverySpec
  • func (in *NodeFeatureDiscoverySpec) DeepCopyInto(out *NodeFeatureDiscoverySpec)
• type NodeFeatureDiscoveryStatus
  • func (in *NodeFeatureDiscoveryStatus) DeepCopy() *NodeFeatureDiscoveryStatus
  • func (in *NodeFeatureDiscoveryStatus) DeepCopyInto(out *NodeFeatureDiscoveryStatus)
• type OperandSpec
  • func (in *OperandSpec) DeepCopy() *OperandSpec
  • func (in *OperandSpec) DeepCopyInto(out *OperandSpec)
  • func (o *OperandSpec) ImagePath() string
  • func (o *OperandSpec) ImagePolicy(pullPolicy string) corev1.PullPolicy

Variables

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

	// 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
)

Types

type ConfigMap

type ConfigMap struct {
	// BinaryData holds the NFD configuration file
	ConfigData string `json:"configData"`
}

ConfigMap describes configuration options for the NFD worker

func (*ConfigMap) Data

func (c *ConfigMap) Data() string

Data returns a valid ConfigMap name

func (*ConfigMap) DeepCopy

func (in *ConfigMap) DeepCopy() *ConfigMap

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

func (*ConfigMap) DeepCopyInto

func (in *ConfigMap) DeepCopyInto(out *ConfigMap)

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

type NodeFeatureDiscovery

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

	Spec   NodeFeatureDiscoverySpec   `json:"spec,omitempty"`
	Status NodeFeatureDiscoveryStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:path=nodefeaturediscoveries,scope=Namespaced

NodeFeatureDiscovery is the Schema for the nodefeaturediscoveries API

func (*NodeFeatureDiscovery) DeepCopy

func (in *NodeFeatureDiscovery) DeepCopy() *NodeFeatureDiscovery

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

func (*NodeFeatureDiscovery) DeepCopyInto

func (in *NodeFeatureDiscovery) DeepCopyInto(out *NodeFeatureDiscovery)

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

func (*NodeFeatureDiscovery) DeepCopyObject

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

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

type NodeFeatureDiscoveryList

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

+kubebuilder:object:root=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

NodeFeatureDiscoveryList contains a list of NodeFeatureDiscovery

func (*NodeFeatureDiscoveryList) DeepCopy

func (in *NodeFeatureDiscoveryList) DeepCopy() *NodeFeatureDiscoveryList

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

func (*NodeFeatureDiscoveryList) DeepCopyInto

func (in *NodeFeatureDiscoveryList) DeepCopyInto(out *NodeFeatureDiscoveryList)

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

func (*NodeFeatureDiscoveryList) DeepCopyObject

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

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

type NodeFeatureDiscoverySpec

type NodeFeatureDiscoverySpec struct {
	// +optional
	Operand OperandSpec `json:"operand"`

	// Deploy the NFD-Topology-Updater
	// NFD-Topology-Updater is a daemon responsible for examining allocated
	// resources on a worker node to account for resources available to be
	// allocated to new pod on a per-zone basis
	// https://kubernetes-sigs.github.io/node-feature-discovery/master/get-started/introduction.html#nfd-topology-updater
	// +optional
	TopologyUpdater bool `json:"topologyUpdater"`

	// Instance name. Used to separate annotation namespaces for
	// multiple parallel deployments.
	// +optional
	Instance string `json:"instance"`

	// ExtraLabelNs defines the list of of allowed extra label namespaces
	// By default, only allow labels in the default `feature.node.kubernetes.io` label namespace
	// +nullable
	// +kubebuilder:validation:Optional
	ExtraLabelNs []string `json:"extraLabelNs,omitempty"`

	// ResourceLabels defines the list of features
	// to be advertised as extended resources instead of labels.
	// +nullable
	// +kubebuilder:validation:Optional
	ResourceLabels []string `json:"resourceLabels,omitempty"`

	// LabelWhiteList defines a regular expression
	// for filtering feature labels based on their name.
	// Each label must match against the given reqular expression in order to be published.
	// +nullable
	// +kubebuilder:validation:Optional
	LabelWhiteList string `json:"labelWhiteList,omitempty"`

	// WorkerConfig describes configuration options for the NFD
	// worker.
	// +optional
	WorkerConfig ConfigMap `json:"workerConfig"`

	// PruneOnDelete defines whether the NFD-master prune should be
	// enabled or not. If enabled, the Operator will deploy an NFD-Master prune
	// job that will remove all NFD labels (and other NFD-managed assets such
	// as annotations, extended resources and taints) from the cluster nodes.
	// +optional
	PruneOnDelete bool `json:"prunerOnDelete"`

	// EnableTaints enables the enable the experimental tainting feature
	// This allows keeping nodes with specialized hardware away from running general workload i
	// and instead leave them for workloads that need the specialized hardware.
	// +optional
	EnableTaints bool `json:"enableTaints"`
}

NodeFeatureDiscoverySpec defines the desired state of NodeFeatureDiscovery +k8s:openapi-gen=true

func (*NodeFeatureDiscoverySpec) DeepCopy

func (in *NodeFeatureDiscoverySpec) DeepCopy() *NodeFeatureDiscoverySpec

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

func (*NodeFeatureDiscoverySpec) DeepCopyInto

func (in *NodeFeatureDiscoverySpec) DeepCopyInto(out *NodeFeatureDiscoverySpec)

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

type NodeFeatureDiscoveryStatus

type NodeFeatureDiscoveryStatus struct {
	// Conditions represents the latest available observations of current state.
	//
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

NodeFeatureDiscoveryStatus defines the observed state of NodeFeatureDiscovery +k8s:openapi-gen=true

func (*NodeFeatureDiscoveryStatus) DeepCopy

func (in *NodeFeatureDiscoveryStatus) DeepCopy() *NodeFeatureDiscoveryStatus

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

func (*NodeFeatureDiscoveryStatus) DeepCopyInto

func (in *NodeFeatureDiscoveryStatus) DeepCopyInto(out *NodeFeatureDiscoveryStatus)

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

type OperandSpec

type OperandSpec struct {
	// Image defines the image to pull for the
	// NFD operand
	// [defaults to registry.k8s.io/nfd/node-feature-discovery]
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:Pattern=[a-zA-Z0-9\-]+
	Image string `json:"image,omitempty"`

	// ImagePullPolicy defines Image pull policy for the
	// NFD operand image [defaults to Always]
	// +kubebuilder:validation:Optional
	ImagePullPolicy string `json:"imagePullPolicy,omitempty"`

	// ServicePort specifies the TCP port that nfd-master
	// listens for incoming requests.
	// +kubebuilder:validation:Optional
	ServicePort int `json:"servicePort"`
}

OperandSpec describes configuration options for the operand

func (*OperandSpec) DeepCopy

func (in *OperandSpec) DeepCopy() *OperandSpec

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

func (*OperandSpec) DeepCopyInto

func (in *OperandSpec) DeepCopyInto(out *OperandSpec)

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

func (*OperandSpec) ImagePath

func (o *OperandSpec) ImagePath() string

ImagePath returns a compiled full valid image string

func (*OperandSpec) ImagePolicy

func (o *OperandSpec) ImagePolicy(pullPolicy string) corev1.PullPolicy

ImagePolicy returns a valid corev1.PullPolicy from the string in the CR