Add API docs for multiple PriorityClasses marked as globalDefault

This commit is contained in:
Bobby (Babak) Salamat 2018-02-16 17:49:29 -08:00
parent 6b292822f5
commit 5f7354679e
2 changed files with 7 additions and 1 deletions

View File

@ -44,8 +44,11 @@ type PriorityClass struct {
// receive when they have the name of this class in their pod spec.
Value int32
// GlobalDefault specifies whether this PriorityClass should be considered as
// globalDefault specifies whether this PriorityClass should be considered as
// the default priority for pods that do not have any priority class.
// Only one PriorityClass with can be marked as `globalDefault`. Due to race conditions, more than
// one PriorityClasses might be created with their `globalDefault` field set to true. In that case,
// the smallest value of such global default PriorityClasses will be used as the default priority.
// +optional
GlobalDefault bool

View File

@ -39,6 +39,9 @@ type PriorityClass struct {
// globalDefault specifies whether this PriorityClass should be considered as
// the default priority for pods that do not have any priority class.
// Only one PriorityClass with can be marked as `globalDefault`. Due to race conditions, more than
// one PriorityClasses might be created with their `globalDefault` field set to true. In that case,
// the smallest value of such global default PriorityClasses will be used as the default priority.
// +optional
GlobalDefault bool `json:"globalDefault,omitempty" protobuf:"bytes,3,opt,name=globalDefault"`