sigs.k8s.io/kueue@v0.6.2/pkg/controller/constants/constants.go (about)

     1  /*
     2  Copyright 2023 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package constants
    18  
    19  const (
    20  	// QueueLabel is the label key in the workload that holds the queue name.
    21  	QueueLabel = "kueue.x-k8s.io/queue-name"
    22  
    23  	// QueueAnnotation is the annotation key in the workload that holds the queue name.
    24  	//
    25  	// DEPRECATED: Use QueueLabel as a label key.
    26  	QueueAnnotation = QueueLabel
    27  
    28  	// PrebuiltWorkloadLabel is the label key of the job holding the name of the pre-built workload to use.
    29  	PrebuiltWorkloadLabel = "kueue.x-k8s.io/prebuilt-workload-name"
    30  
    31  	// ParentWorkloadAnnotation is the annotation used to mark a kubernetes Job
    32  	// as a child of a Workload. The value is the name of the workload,
    33  	// in the same namespace. It is used when the parent workload corresponds to
    34  	// a custom job CRD composed of one or more kubernetes Jobs. When set, Kueue
    35  	// ignores this Job from admission, and takes control of its suspension
    36  	// status based on the admission status of the parent workload.
    37  	ParentWorkloadAnnotation = "kueue.x-k8s.io/parent-workload"
    38  
    39  	// JobUIDLabel is the label key in the workload resource, that holds the UID of
    40  	// the owner job.
    41  	JobUIDLabel = "kueue.x-k8s.io/job-uid"
    42  
    43  	// WorkloadPriorityClassLabel is the label key in the workload that holds the
    44  	// workloadPriorityClass name.
    45  	// This label is always mutable because it might be useful for the preemption.
    46  	WorkloadPriorityClassLabel = "kueue.x-k8s.io/priority-class"
    47  )