DeploymentStatus readyReplicas docstring needs clarification. about api HOT 6 CLOSED

/good-first-issue

from api.

@nikhita:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

from api.

/assign

from api.

@briantkennedy As I understood, the documentation should be clarified to describe that a pod is defined as ready when it's passing the defined probes. Is that correct?

By reviewing the mentioned page Deployment, I saw that ReplicaSet#ReplicaSetStatus, ReplicationController#ReplicationControllerStatus, and DaemonSet#DaemonSetStatus have similar descriptions with an equivalent grade of unclarity.

I would suggest rewriting all those docs to something like readyReplicas is the number of Pods targeted by this Deployment that have a Ready Condition. equivalent to the docs of StatefulSet#StatefulSetStatus.

If you approve this, I will open a PR and do it for all the mentioned docs.

from api.

Thanks for taking a look. You are correct, adding the criteria for ready is what I'm looking for. For clarity, what are the defined probes you are referring to?

from api.

I'm referring to the readiness probes. Thanks for the Feedback, the PR will follow soon.

from api.