Improve the Job API comment for ready field

This commit is contained in:
Michal Wozniak 2024-05-29 14:01:28 +02:00
parent 5ceb99dc6b
commit 551464fe53
7 changed files with 10 additions and 9 deletions

View File

@ -4840,7 +4840,7 @@
"type": "string"
},
"ready": {
"description": "The number of pods which have a Ready condition.",
"description": "The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).",
"format": "int32",
"type": "integer"
},

View File

@ -459,7 +459,7 @@
"type": "string"
},
"ready": {
"description": "The number of pods which have a Ready condition.",
"description": "The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).",
"format": "int32",
"type": "integer"
},

View File

@ -537,7 +537,8 @@ type JobStatus struct {
// +optional
Terminating *int32
// The number of active pods which have a Ready condition.
// The number of active pods which have a Ready condition and are not
// terminating (without a deletionTimestamp).
// +optional
Ready *int32

View File

@ -17274,7 +17274,7 @@ func schema_k8sio_api_batch_v1_JobStatus(ref common.ReferenceCallback) common.Op
},
"ready": {
SchemaProps: spec.SchemaProps{
Description: "The number of pods which have a Ready condition.",
Description: "The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).",
Type: []string{"integer"},
Format: "int32",
},

View File

@ -467,8 +467,8 @@ message JobStatus {
// +optional
optional UncountedTerminatedPods uncountedTerminatedPods = 8;
// The number of pods which have a Ready condition.
// +optional
// The number of active pods which have a Ready condition and are not
// terminating (without a deletionTimestamp).
optional int32 ready = 9;
}

View File

@ -595,8 +595,8 @@ type JobStatus struct {
// +optional
UncountedTerminatedPods *UncountedTerminatedPods `json:"uncountedTerminatedPods,omitempty" protobuf:"bytes,8,opt,name=uncountedTerminatedPods"`
// The number of pods which have a Ready condition.
// +optional
// The number of active pods which have a Ready condition and are not
// terminating (without a deletionTimestamp).
Ready *int32 `json:"ready,omitempty" protobuf:"varint,9,opt,name=ready"`
}

View File

@ -146,7 +146,7 @@ var map_JobStatus = map[string]string{
"completedIndexes": "completedIndexes holds the completed indexes when .spec.completionMode = \"Indexed\" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as \"1,3-5,7\".",
"failedIndexes": "FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as \"1,3-5,7\". The set of failed indexes cannot overlap with the set of completed indexes.\n\nThis field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).",
"uncountedTerminatedPods": "uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.\n\nThe job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:\n\n1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding\n counter.\n\nOld jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.",
"ready": "The number of pods which have a Ready condition.",
"ready": "The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).",
}
func (JobStatus) SwaggerDoc() map[string]string {