multikueue

Documentation

Overview

Copyright 2024 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2024 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func SetupControllers(mgr ctrl.Manager, namespace string, opts ...SetupOption) error
• func SetupIndexer(ctx context.Context, indexer client.FieldIndexer, configNamespace string) error
• type ACReconciler
  • func (a *ACReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
• type KubeConfigFSWatcher
  • func (w *KubeConfigFSWatcher) AddOrUpdate(cluster, path string) error
  • func (w *KubeConfigFSWatcher) Remove(cluster string) error
  • func (w *KubeConfigFSWatcher) Start(ctx context.Context) error
  • func (w *KubeConfigFSWatcher) Started() bool
• type SetupOption
  • func WithGCInterval(i time.Duration) SetupOption
  • func WithOrigin(origin string) SetupOption
  • func WithWorkerLostTimeout(d time.Duration) SetupOption
• type SetupOptions

Constants

const (
	ControllerName                = "kueue.x-k8s.io/multikueue"
	SingleInstanceReason          = "MultiKueue"
	SingleInstanceMessage         = "only one multikueue managed admission check can be used in one ClusterQueue"
	FlavorIndependentCheckReason  = "MultiKueue"
	FlavorIndependentCheckMessage = "admission check cannot be applied at ResourceFlavor level"
)

const (
	UsingKubeConfigs             = "spec.kubeconfigs"
	UsingMultiKueueClusters      = "spec.multiKueueClusters"
	AdmissionCheckUsingConfigKey = "spec.multiKueueConfig"
)

Functions

func SetupControllers

func SetupControllers(mgr ctrl.Manager, namespace string, opts ...SetupOption) error

func SetupIndexer

func SetupIndexer(ctx context.Context, indexer client.FieldIndexer, configNamespace string) error

Types

type ACReconciler

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

ACReconciler implements the reconciler for all the admission checks controlled by multikueue. Its main task being to maintain the active state of the admission checks based on the heath of its referenced MultiKueueClusters.

func (*ACReconciler) Reconcile

func (a *ACReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

type KubeConfigFSWatcher

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

func (*KubeConfigFSWatcher) AddOrUpdate

func (w *KubeConfigFSWatcher) AddOrUpdate(cluster, path string) error

func (*KubeConfigFSWatcher) Remove

func (w *KubeConfigFSWatcher) Remove(cluster string) error

func (*KubeConfigFSWatcher) Start

func (w *KubeConfigFSWatcher) Start(ctx context.Context) error

func (*KubeConfigFSWatcher) Started

func (w *KubeConfigFSWatcher) Started() bool

type SetupOption

type SetupOption func(o *SetupOptions)

func WithGCInterval

func WithGCInterval(i time.Duration) SetupOption

WithGCInterval - sets the interval between two garbage collection runs. If 0 the garbage collection is disabled.

func WithOrigin

func WithOrigin(origin string) SetupOption

WithOrigin - sets the multikueue-origin label value used by this manager

func WithWorkerLostTimeout

func WithWorkerLostTimeout(d time.Duration) SetupOption

WithWorkerLostTimeout - sets the time for which the multikueue admission check is kept in Ready state after the connection to the admitting worker cluster is lost.

type SetupOptions

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