Documentation
¶
Index ¶
Constants ¶
const ( // DefaultPriorityWhenNoDefaultClassExists is used to set priority of pods // that do not specify any priority class and there is no priority class // marked as default. DefaultPriorityWhenNoDefaultClassExists = 0 // HighestUserDefinablePriority is the highest priority for user defined priority classes. Priority values larger than 1 billion are reserved for Kubernetes system use. HighestUserDefinablePriority = int32(1000000000) // SystemCriticalPriority is the beginning of the range of priority values for critical system components. SystemCriticalPriority = 2 * HighestUserDefinablePriority // SystemPriorityClassPrefix is the prefix reserved for system priority class names. Other priority // classes are not allowed to start with this prefix. SystemPriorityClassPrefix = "system-" // NOTE: In order to avoid conflict of names with user-defined priority classes, all the names must // start with SystemPriorityClassPrefix. SystemClusterCritical = SystemPriorityClassPrefix + "cluster-critical" SystemNodeCritical = SystemPriorityClassPrefix + "node-critical" )
const GroupName = "scheduling.k8s.io"
GroupName is the group name use in this package
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func IsKnownSystemPriorityClass ¶ added in v1.11.0
func IsKnownSystemPriorityClass(pc *PriorityClass) (bool, error)
IsKnownSystemPriorityClass checks that "pc" is equal to one of the system PriorityClasses. It ignores "description", labels, annotations, etc. of the PriorityClass.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type PriorityClass ¶
type PriorityClass struct {
metav1.TypeMeta
// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
// +optional
metav1.ObjectMeta
// The value of this priority class. This is the actual priority that pods
// receive when they have the name of this class in their pod spec.
Value int32
// globalDefault specifies whether this PriorityClass should be considered as
// the default priority for pods that do not have any priority class.
// Only one PriorityClass can be marked as `globalDefault`. However, if more than
// one PriorityClasses exists with their `globalDefault` field set to true,
// the smallest value of such global default PriorityClasses will be used as the default priority.
// +optional
GlobalDefault bool
// Description is an arbitrary string that usually provides guidelines on
// when this priority class should be used.
// +optional
Description string
}
PriorityClass defines the mapping from a priority class name to the priority integer value. The value can be any valid integer.
func SystemPriorityClasses ¶ added in v1.11.0
func SystemPriorityClasses() []*PriorityClass
SystemPriorityClasses returns the list of system priority classes. NOTE: be careful not to modify any of elements of the returned array directly.
func (*PriorityClass) DeepCopy ¶
func (in *PriorityClass) DeepCopy() *PriorityClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PriorityClass.
func (*PriorityClass) DeepCopyInto ¶
func (in *PriorityClass) DeepCopyInto(out *PriorityClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PriorityClass) DeepCopyObject ¶
func (in *PriorityClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PriorityClassList ¶
type PriorityClassList struct {
metav1.TypeMeta
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
// +optional
metav1.ListMeta
// Items is the list of PriorityClasses.
Items []PriorityClass
}
PriorityClassList is a collection of priority classes.
func (*PriorityClassList) DeepCopy ¶
func (in *PriorityClassList) DeepCopy() *PriorityClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PriorityClassList.
func (*PriorityClassList) DeepCopyInto ¶
func (in *PriorityClassList) DeepCopyInto(out *PriorityClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PriorityClassList) DeepCopyObject ¶
func (in *PriorityClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |