Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify ready #103782

Merged
merged 7 commits into from
Aug 5, 2021
Merged

Clarify ready #103782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dec78eb
Clarify ReadyReplicas docs
matthiasgubler Jul 19, 2021
b6380c4
Clarify NumberReady docs
matthiasgubler Jul 19, 2021
6d27bd8
Autogenerate docs
matthiasgubler Jul 19, 2021
3b9f087
Fix doc text with PR feedback
matthiasgubler Jul 27, 2021
7664cc7
Autogen docs
matthiasgubler Jul 27, 2021
0d63e6d
Apply suggestions from code review
matthiasgubler Jul 29, 2021
d803311
Autogen docs
matthiasgubler Jul 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions api/openapi-spec/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions staging/src/k8s.io/api/apps/v1/generated.proto
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions staging/src/k8s.io/api/apps/v1/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ type StatefulSetStatus struct {
// replicas is the number of Pods created by the StatefulSet controller.
Replicas int32 `json:"replicas" protobuf:"varint,2,opt,name=replicas"`

// readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
// readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,3,opt,name=readyReplicas"`

// currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
Expand Down Expand Up @@ -451,7 +451,7 @@ type DeploymentStatus struct {
// +optional
UpdatedReplicas int32 `json:"updatedReplicas,omitempty" protobuf:"varint,3,opt,name=updatedReplicas"`

// Total number of ready pods targeted by this deployment.
// readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.
// +optional
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,7,opt,name=readyReplicas"`

Expand Down Expand Up @@ -640,8 +640,8 @@ type DaemonSetStatus struct {
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
DesiredNumberScheduled int32 `json:"desiredNumberScheduled" protobuf:"varint,3,opt,name=desiredNumberScheduled"`

// The number of nodes that should be running the daemon pod and have one
// or more of the daemon pod running and ready.
// numberReady is the number of nodes that should be running the daemon pod and have one
// or more of the daemon pod running with a Ready Condition.
NumberReady int32 `json:"numberReady" protobuf:"varint,4,opt,name=numberReady"`

// The most recent generation observed by the daemon set controller.
Expand Down Expand Up @@ -828,7 +828,7 @@ type ReplicaSetStatus struct {
// +optional
FullyLabeledReplicas int32 `json:"fullyLabeledReplicas,omitempty" protobuf:"varint,2,opt,name=fullyLabeledReplicas"`

// The number of ready replicas for this replica set.
// readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.
// +optional
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,4,opt,name=readyReplicas"`

Expand Down
8 changes: 4 additions & 4 deletions staging/src/k8s.io/api/apps/v1/types_swagger_doc_generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions staging/src/k8s.io/api/apps/v1beta1/generated.proto
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions staging/src/k8s.io/api/apps/v1beta1/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ type StatefulSetStatus struct {
// replicas is the number of Pods created by the StatefulSet controller.
Replicas int32 `json:"replicas" protobuf:"varint,2,opt,name=replicas"`

// readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
// readyReplicas is the number of pods created by this StatefulSet controller with a Ready Condition.
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,3,opt,name=readyReplicas"`

// currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
Expand Down Expand Up @@ -525,7 +525,7 @@ type DeploymentStatus struct {
// +optional
UpdatedReplicas int32 `json:"updatedReplicas,omitempty" protobuf:"varint,3,opt,name=updatedReplicas"`

// Total number of ready pods targeted by this deployment.
// readyReplicas is the number of pods targeted by this Deployment controller with a Ready Condition.
// +optional
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,7,opt,name=readyReplicas"`

Expand Down
4 changes: 2 additions & 2 deletions staging/src/k8s.io/api/apps/v1beta1/types_swagger_doc_generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions staging/src/k8s.io/api/apps/v1beta2/generated.proto
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions staging/src/k8s.io/api/apps/v1beta2/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ type StatefulSetStatus struct {
// replicas is the number of Pods created by the StatefulSet controller.
Replicas int32 `json:"replicas" protobuf:"varint,2,opt,name=replicas"`

// readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
// readyReplicas is the number of pods created by this StatefulSet controller with a Ready Condition.
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,3,opt,name=readyReplicas"`

// currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
Expand Down Expand Up @@ -503,7 +503,7 @@ type DeploymentStatus struct {
// +optional
UpdatedReplicas int32 `json:"updatedReplicas,omitempty" protobuf:"varint,3,opt,name=updatedReplicas"`

// Total number of ready pods targeted by this deployment.
// readyReplicas is the number of pods targeted by this Deployment controller with a Ready Condition.
// +optional
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,7,opt,name=readyReplicas"`

Expand Down Expand Up @@ -696,8 +696,8 @@ type DaemonSetStatus struct {
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
DesiredNumberScheduled int32 `json:"desiredNumberScheduled" protobuf:"varint,3,opt,name=desiredNumberScheduled"`

// The number of nodes that should be running the daemon pod and have one
// or more of the daemon pod running and ready.
// Total number of nodes that should be running the daemon pod and have one
// or more of the daemon pod running with a Ready Condition by passing the readinessProbe.
NumberReady int32 `json:"numberReady" protobuf:"varint,4,opt,name=numberReady"`

// The most recent generation observed by the daemon set controller.
Expand Down Expand Up @@ -900,7 +900,7 @@ type ReplicaSetStatus struct {
// +optional
FullyLabeledReplicas int32 `json:"fullyLabeledReplicas,omitempty" protobuf:"varint,2,opt,name=fullyLabeledReplicas"`

// The number of ready replicas for this replica set.
// readyReplicas is the number of pods targeted by this ReplicaSet controller with a Ready Condition.
// +optional
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,4,opt,name=readyReplicas"`

Expand Down