controller_common

package
v0.0.0-...-b592269 Latest Latest
Warning

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

Go to latest
Published: Dec 23, 2025 License: Apache-2.0, Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// NvidiaAnnotationHashKey indicates annotation name for last applied hash by the operator
	NvidiaAnnotationHashKey = "nvidia.com/last-applied-hash"
	// NvidiaAnnotationGenerationKey indicates annotation name for last applied generation by the operator
	// This is used to detect manual changes to resources
	NvidiaAnnotationGenerationKey = "nvidia.com/last-applied-generation"
)

Variables

This section is empty.

Functions

func AddFinalizer

func AddFinalizer(obj client.Object)

func AppendUniqueImagePullSecrets

func AppendUniqueImagePullSecrets(existing, additional []corev1.LocalObjectReference) []corev1.LocalObjectReference

AppendUniqueImagePullSecrets appends secrets to existing, skipping any that already exist by name.

func ContainsFinalizer

func ContainsFinalizer(obj client.Object) bool

func CopySpec

func CopySpec(source, destination client.Object) error

CopySpec copies only the Spec field from source to destination using Unstructured

func DetectGroveAvailability

func DetectGroveAvailability(ctx context.Context, mgr ctrl.Manager) bool

DetectGroveAvailability checks if Grove is available by checking if the Grove API group is registered This approach uses the discovery client which is simpler and more reliable

func DetectKaiSchedulerAvailability

func DetectKaiSchedulerAvailability(ctx context.Context, mgr ctrl.Manager) bool

DetectKaiSchedulerAvailability checks if Kai-scheduler is available by checking if the scheduling.run.ai API group is registered This approach uses the discovery client which is simpler and more reliable

func DetectLWSAvailability

func DetectLWSAvailability(ctx context.Context, mgr ctrl.Manager) bool

DetectLWSAvailability checks if LWS is available by checking if the LWS API group is registered This approach uses the discovery client which is simpler and more reliable

func DetectVolcanoAvailability

func DetectVolcanoAvailability(ctx context.Context, mgr ctrl.Manager) bool

detectVolcanoAvailability checks if Volcano is available by checking if the Volcano API group is registered This approach uses the discovery client which is simpler and more reliable

func EphemeralDeploymentEventFilter

func EphemeralDeploymentEventFilter(config Config) predicate.Predicate

func GetResourceHash

func GetResourceHash(obj any) (string, error)

GetResourceHash returns a consistent hash for the given object spec

func GetResourcesConfig

func GetResourcesConfig(resources *v1alpha1.Resources) (*corev1.ResourceRequirements, error)

func GetSpecHash

func GetSpecHash(obj client.Object) (string, error)

func HandleFinalizer

func HandleFinalizer[T client.Object](ctx context.Context, obj T, writer client.Writer, finalizer Finalizer[T]) (bool, error)

func RemoveFinalizer

func RemoveFinalizer(obj client.Object)

func ScaleResource

func ScaleResource(ctx context.Context, scaleClient scale.ScalesGetter, gvr schema.GroupVersionResource, namespace, name string, replicas int32) error

ScaleResource scales any Kubernetes resource using the Scale subresource

func SortKeys

func SortKeys(obj interface{}) interface{}

SortKeys recursively sorts the keys of a map to ensure consistent serialization

func SyncResource

func SyncResource[T client.Object](ctx context.Context, r Reconciler, parentResource client.Object, generateResource ResourceGenerator[T]) (modified bool, res T, err error)

Types

type Config

type Config struct {
	// Enable resources filtering, only the resources belonging to the given namespace will be handled.
	RestrictedNamespace string
	Grove               GroveConfig
	LWS                 LWSConfig
	KaiScheduler        KaiSchedulerConfig
	EtcdAddress         string
	NatsAddress         string
	IngressConfig       IngressConfig
	// ModelExpressURL is the URL of the Model Express server to inject into all pods
	ModelExpressURL string
	// PrometheusEndpoint is the URL of the Prometheus endpoint to use for metrics
	PrometheusEndpoint string
	MpiRun             MpiRunConfig
	// RBAC configuration for cross-namespace resource management
	RBAC RBACConfig
	// ExcludedNamespaces is a thread-safe set of namespaces to exclude (cluster-wide mode only)
	ExcludedNamespaces ExcludedNamespacesInterface

	// DiscoveryBackend is the discovery backend to use. Default is "kubernetes" for Kubernetes API service discovery. Set to "etcd" to use ETCD for discovery.
	DiscoveryBackend string

	// WebhooksEnabled indicates whether admission webhooks are enabled
	// When true, controllers skip validation (webhooks handle it)
	// When false, controllers perform validation (defense in depth)
	WebhooksEnabled bool
}

func (Config) GetDiscoveryBackend

func (c Config) GetDiscoveryBackend(annotations map[string]string) string

func (Config) IsK8sDiscoveryEnabled

func (c Config) IsK8sDiscoveryEnabled(annotations map[string]string) bool

For DGD, pass in the meta annotations For DCD, pass in the spec annotations

type ExcludedNamespacesInterface

type ExcludedNamespacesInterface interface {
	Contains(namespace string) bool
}

ExcludedNamespacesInterface defines the interface for checking namespace exclusions

type Finalizer

type Finalizer[T client.Object] interface {
	FinalizeResource(ctx context.Context, obj T) error
}

type GroveConfig

type GroveConfig struct {
	// Enabled is automatically determined by checking if Grove CRDs are installed in the cluster
	Enabled bool
	// TerminationDelay configures the termination delay for Grove PodCliqueSets
	TerminationDelay time.Duration
}

type IngressConfig

type IngressConfig struct {
	VirtualServiceGateway      string
	IngressControllerClassName string
	IngressControllerTLSSecret string
	IngressHostSuffix          string
}

func (*IngressConfig) UseVirtualService

func (i *IngressConfig) UseVirtualService() bool

type KaiSchedulerConfig

type KaiSchedulerConfig struct {
	// Enabled is automatically determined by checking if Kai-scheduler CRDs are installed in the cluster
	Enabled bool
}

type LWSConfig

type LWSConfig struct {
	// Enabled is automatically determined by checking if LWS CRDs are installed in the cluster
	Enabled bool
}

type MpiRunConfig

type MpiRunConfig struct {
	// SecretName is the name of the secret containing the SSH key for MPI Run
	SecretName string
}

type RBACConfig

type RBACConfig struct {
	// PlannerClusterRoleName is the name of the ClusterRole for planner (cluster-wide mode only)
	PlannerClusterRoleName string
	// DGDRProfilingClusterRoleName is the name of the ClusterRole for DGDR profiling jobs (cluster-wide mode only)
	DGDRProfilingClusterRoleName string
}

RBACConfig holds configuration for RBAC management

type Reconciler

type Reconciler interface {
	client.Client
	GetRecorder() record.EventRecorder
}

type Resource

type Resource struct {
	// contains filtered or unexported fields
}

func NewResource

func NewResource[T client.Object](resource T, isReady func() (bool, string)) (*Resource, error)

func NewResourceWithServiceStatuses

func NewResourceWithServiceStatuses[T client.Object](resource T, isReadyAndServiceStatuses func() (bool, string, map[string]v1alpha1.ServiceReplicaStatus)) (*Resource, error)

func (*Resource) GetName

func (r *Resource) GetName() string

func (*Resource) GetServiceStatuses

func (r *Resource) GetServiceStatuses() map[string]v1alpha1.ServiceReplicaStatus

func (*Resource) IsReady

func (r *Resource) IsReady() (bool, string)

type ResourceGenerator

type ResourceGenerator[T client.Object] func(ctx context.Context) (T, bool, error)

ResourceGenerator is a function that generates a resource. it must return the resource, a boolean indicating if the resource should be deleted, and an error if the resource should be deleted, the returned resource must contain the necessary information to delete it (name and namespace)

type SpecChangeResult

type SpecChangeResult struct {
	// NewHash is the hash to set in the annotation (nil if no update needed)
	NewHash *string
	// NewGeneration is the generation to set in the annotation
	NewGeneration int64
	// NeedsUpdate indicates whether the resource needs to be updated
	NeedsUpdate bool
	// ManualChangeDetected indicates whether a manual change was detected
	ManualChangeDetected bool
}

SpecChangeResult contains the result of spec change detection

func GetSpecChangeResult

func GetSpecChangeResult(current client.Object, desired client.Object) (SpecChangeResult, error)

GetSpecChangeResult determines if a resource needs to be updated by comparing the desired spec hash with the last applied hash annotation. It also tracks generation to detect manual changes.

Returns:

  • SpecChangeResult with update information
  • error if hash computation fails

Jump to

Keyboard shortcuts

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