v1beta1

Documentation

Overview

Package v1beta1 contains API Schema definitions for the config v1beta1 API group +kubebuilder:object:generate=true +groupName=config.kueue.x-k8s.io

Index

• Constants
• Variables
• func SetDefaults_Configuration(cfg *Configuration)
• type ClientConnection
  • func (in *ClientConnection) DeepCopy() *ClientConnection
  • func (in *ClientConnection) DeepCopyInto(out *ClientConnection)
• type Configuration
  • func (in *Configuration) DeepCopy() *Configuration
  • func (in *Configuration) DeepCopyInto(out *Configuration)
  • func (in *Configuration) DeepCopyObject() runtime.Object
• type Integrations
  • func (in *Integrations) DeepCopy() *Integrations
  • func (in *Integrations) DeepCopyInto(out *Integrations)
• type InternalCertManagement
  • func (in *InternalCertManagement) DeepCopy() *InternalCertManagement
  • func (in *InternalCertManagement) DeepCopyInto(out *InternalCertManagement)
• type WaitForPodsReady
  • func (in *WaitForPodsReady) DeepCopy() *WaitForPodsReady
  • func (in *WaitForPodsReady) DeepCopyInto(out *WaitForPodsReady)

Constants

const (
	DefaultNamespace              = "kueue-system"
	DefaultWebhookServiceName     = "kueue-webhook-service"
	DefaultWebhookSecretName      = "kueue-webhook-server-cert"
	DefaultWebhookPort            = 9443
	DefaultHealthProbeBindAddress = ":8081"
	DefaultMetricsBindAddress     = ":8080"
	DefaultLeaderElectionID       = "c1f6bfd2.kueue.x-k8s.io"
	DefaultClientConnectionQPS    = 20.0
	DefaultClientConnectionBurst  = 30
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "config.kueue.x-k8s.io", Version: "v1beta1"}

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

Functions

func SetDefaults_Configuration

func SetDefaults_Configuration(cfg *Configuration)

SetDefaults_Configuration sets default values for ComponentConfig.

Types

type ClientConnection

type ClientConnection struct {
	// QPS controls the number of queries per second allowed for K8S api server
	// connection.
	QPS *float32 `json:"qps,omitempty"`

	// Burst allows extra queries to accumulate when a client is exceeding its rate.
	Burst *int32 `json:"burst,omitempty"`
}

func (*ClientConnection) DeepCopy

func (in *ClientConnection) DeepCopy() *ClientConnection

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

func (*ClientConnection) DeepCopyInto

func (in *ClientConnection) DeepCopyInto(out *ClientConnection)

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

type Configuration

type Configuration struct {
	metav1.TypeMeta `json:",inline"`

	// Namespace is the namespace in which kueue is deployed. It is used as part of DNSName of the webhook Service.
	// Defaults to kueue-system.
	Namespace *string `json:"namespace,omitempty"`

	// ControllerManagerConfigurationSpec returns the configurations for controllers
	cfg.ControllerManagerConfigurationSpec `json:",inline"`

	// ManageJobsWithoutQueueName controls whether or not Kueue reconciles
	// batch/v1.Jobs that don't set the annotation kueue.x-k8s.io/queue-name.
	// If set to true, then those jobs will be suspended and never started unless
	// they are assigned a queue and eventually admitted. This also applies to
	// jobs created before starting the kueue controller.
	// Defaults to false; therefore, those jobs are not managed and if they are created
	// unsuspended, they will start immediately.
	ManageJobsWithoutQueueName bool `json:"manageJobsWithoutQueueName"`

	// InternalCertManagement is configuration for internalCertManagement
	InternalCertManagement *InternalCertManagement `json:"internalCertManagement,omitempty"`

	// WaitForPodsReady is configuration to provide simple all-or-nothing
	// scheduling semantics for jobs to ensure they get resources assigned.
	// This is achieved by blocking the start of new jobs until the previously
	// started job has all pods running (ready).
	WaitForPodsReady *WaitForPodsReady `json:"waitForPodsReady,omitempty"`

	// ClientConnection provides additional configuration options for Kubernetes
	// API server client.
	ClientConnection *ClientConnection `json:"clientConnection,omitempty"`

	// Integrations provide configuration options for AI/ML/Batch frameworks
	// integrations (including K8S job).
	Integrations *Integrations `json:"integrations,omitempty"`
}

Configuration is the Schema for the kueueconfigurations API

func (*Configuration) DeepCopy

func (in *Configuration) DeepCopy() *Configuration

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

func (*Configuration) DeepCopyInto

func (in *Configuration) DeepCopyInto(out *Configuration)

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

func (*Configuration) DeepCopyObject

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

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

type Integrations

type Integrations struct {
	// List of framework names to be enabled.
	// Possible options:
	//  - "batch/job"
	//  - "kubeflow.org/mpijob"
	Frameworks []string `json:"frameworks,omitempty"`
}

func (*Integrations) DeepCopy

func (in *Integrations) DeepCopy() *Integrations

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

func (*Integrations) DeepCopyInto

func (in *Integrations) DeepCopyInto(out *Integrations)

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

type InternalCertManagement

type InternalCertManagement struct {

	// Enable controls whether to enable internal cert management or not.
	// Defaults to true. If you want to use a third-party management, e.g. cert-manager,
	// set it to false. See the user guide for more information.
	Enable *bool `json:"enable,omitempty"`

	// WebhookServiceName is the name of the Service used as part of the DNSName.
	// Defaults to kueue-webhook-service.
	WebhookServiceName *string `json:"webhookServiceName,omitempty"`

	// WebhookSecretName is the name of the Secret used to store CA and server certs.
	// Defaults to kueue-webhook-server-cert.
	WebhookSecretName *string `json:"webhookSecretName,omitempty"`
}

func (*InternalCertManagement) DeepCopy

func (in *InternalCertManagement) DeepCopy() *InternalCertManagement

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

func (*InternalCertManagement) DeepCopyInto

func (in *InternalCertManagement) DeepCopyInto(out *InternalCertManagement)

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

type WaitForPodsReady

type WaitForPodsReady struct {
	// Enable when true, indicates that each admitted workload
	// blocks the admission of all other workloads from all queues until it is in the
	// `PodsReady` condition. If false, all workloads start as soon as they are
	// admitted and do not block admission of other workloads. The PodsReady
	// condition is only added if this setting is enabled. It defaults to false.
	Enable bool `json:"enable,omitempty"`

	// Timeout defines the time for an admitted workload to reach the
	// PodsReady=true condition. When the timeout is reached, the workload admission
	// is cancelled and requeued in the same cluster queue. Defaults to 5min.
	// +optional
	Timeout *metav1.Duration `json:"timeout,omitempty"`
}

func (*WaitForPodsReady) DeepCopy

func (in *WaitForPodsReady) DeepCopy() *WaitForPodsReady

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

func (*WaitForPodsReady) DeepCopyInto

func (in *WaitForPodsReady) DeepCopyInto(out *WaitForPodsReady)

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