Merge pull request #8956 from enxebre/doc-MinReadySeconds

🌱 Adjust MinReadySeconds docs to reality

Author: k8s-ci-robot

api/v1beta1/machinedeployment_types.go

@@ -121,10 +121,8 @@ type MachineDeploymentSpec struct {
 	// +optional
 	Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"`
 
-	// Minimum number of seconds for which a newly created machine should
-	// be ready.
-	// Defaults to 0 (machine will be considered available as soon as it
-	// is ready)
+	// MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available.
+	// Defaults to 0 (machine will be considered available as soon as the Node is ready)
 	// +optional
 	MinReadySeconds *int32 `json:"minReadySeconds,omitempty"`
 

api/v1beta1/machineset_types.go

@@ -46,8 +46,8 @@ type MachineSetSpec struct {
 	// +kubebuilder:default=1
 	Replicas *int32 `json:"replicas,omitempty"`
 
-	// MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready.
-	// Defaults to 0 (machine will be considered available as soon as it is ready)
+	// MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available.
+	// Defaults to 0 (machine will be considered available as soon as the Node is ready)
 	// +optional
 	MinReadySeconds int32 `json:"minReadySeconds,omitempty"`