Updated docs for EndpointSliceTerminatingCondition #38390

YashPimple · 2022-12-10T17:55:25Z

Resolved Issue #38387 Stale docs for EndpointSliceTerminatingCondition

Made a new PR, similar to #37913, but targeting the main branch as per Instructed.

netlify · 2022-12-10T18:06:11Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`14420f6`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/63a3128a92dcc90009c36c99
😎 Deploy Preview	https://deploy-preview-38390--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

sftim

Thanks

LGTM

mehabhalodiya · 2022-12-21T04:19:47Z

Thanks @YashPimple

/lgtm

tengqm · 2022-12-21T04:44:27Z

content/en/docs/concepts/services-networking/endpoint-slices.md

@@ -87,16 +87,16 @@ The three conditions are `ready`, `serving`, and `terminating`.

 #### Ready

-`ready` is a condition that maps to a Pod's `Ready` condition. A running Pod with the `Ready`
-condition set to `True` should have this EndpointSlice condition also set to `true`. For
+`ready` is a condition that maps to a Pod's `ready` condition. A running Pod with the `ready`


No. Pod's condition is called Ready, not ready.

@YashPimple Please do the changes according to the suggestion. It slipped away from my sight!

sftim · 2022-12-21T11:08:16Z

/lgtm cancel

We should not use the wrong condition name.

Resolved issue kubernetes#38390 as per instructed.

k8s-ci-robot · 2022-12-21T14:05:13Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from sftim by writing /assign @sftim in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

content/en/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tengqm · 2022-12-21T15:14:15Z

content/en/docs/concepts/services-networking/endpoint-slices.md

-`ready` is a condition that maps to a Pod's `Ready` condition. A running Pod with the `Ready`
-condition set to `True` should have this EndpointSlice condition also set to `true`. For
-compatibility reasons, `ready` is NEVER `true` when a Pod is terminating. Consumers should refer
+`Ready` is a condition that maps to a Pod's `Ready` condition. A running Pod with the `Ready`


Checked the source code. For Endpoints, the unofficial condition type is ready, for Pod, the official condition type is Ready. This inconsistency is annoying, but it is the fact to be documented.

unofficial

But part of Kubernetes, right?

We might want to (separately) sprinkle some note shortcodes to point out the oddness.

sftim

From elsewhere in the file:

`Terminating` is a condition that indicates whether an endpoint is terminating.

Is that actually terminating?

sftim · 2022-12-21T17:58:03Z

content/en/docs/concepts/services-networking/endpoint-slices.md

+`Ready` is a condition that maps to a Pod's `Ready` condition. A running Pod with the `Ready`
+condition set to `true` should have this EndpointSlice condition also set to `true`. For
+compatibility reasons, `Ready` is NEVER `true` when a Pod is terminating. Consumers should refer


OK, so is this right?

Suggested change

`Ready` is a condition that maps to a Pod's `Ready` condition. A running Pod with the `Ready`

condition set to `true` should have this EndpointSlice condition also set to `true`. For

compatibility reasons, `Ready` is NEVER `true` when a Pod is terminating. Consumers should refer

For an EndpointSlice, `ready` is a condition that maps to a Pod's `Ready` condition. A running Pod with

the `Ready` condition set to `true` should have any related EndpointSlice `ready` condition (in all-lowercase)

also set to `true`. For compatibility reasons, `ready` for an EndpointSlice is **never** `true` when a Pod is

terminating. Consumers should refer

sftim · 2022-12-21T17:59:33Z

content/en/docs/concepts/services-networking/endpoint-slices.md

 this rule is for Services with `spec.publishNotReadyAddresses` set to `true`. Endpoints for these
-Services will always have the `ready` condition set to `true`.
+Services will always have the `Ready` condition set to `true`.


Suggested change

this rule is for Services with `spec.publishNotReadyAddresses` set to `true`. Endpoints for these

Services will always have the `ready` condition set to `true`.

Services will always have the `Ready` condition set to `true`.

this rule is for Services where `spec.publishNotReadyAddresses` is set to `true`. For such

Services, any endpoints always have the `ready` condition set to `true`.

(Aside: I wonder what serving is set to if a Service has .spec.publishNotReadyAddresses set to true)

sftim · 2022-12-21T18:01:19Z

content/en/docs/concepts/services-networking/endpoint-slices.md


-`serving` is identical to the `ready` condition, except it does not account for terminating states.
+`serving` is identical to the `Ready` condition, except it does not account for terminating states.


Is this right?

Suggested change

`serving` is identical to the `Ready` condition, except it does not account for terminating states.

The `serving` condition is almost identical to the `ready` condition. The difference is that

`serving` continues checking the actual Pod status during Pod termination, whereas `ready`

turns `false` the moment that the Pod starts to terminate.

sftim · 2022-12-21T18:01:37Z

content/en/docs/concepts/services-networking/endpoint-slices.md


-`serving` is identical to the `ready` condition, except it does not account for terminating states.
+`serving` is identical to the `Ready` condition, except it does not account for terminating states.
 Consumers of the EndpointSlice API should check this condition if they care about pod readiness while


Suggested change

Consumers of the EndpointSlice API should check this condition if they care about pod readiness while

Consumers of the EndpointSlice API should check `serving` if they care about pod readiness while

k8s-ci-robot · 2022-12-28T00:36:28Z

@YashPimple: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

mehabhalodiya · 2022-12-29T04:33:16Z

👋🏻 @YashPimple Please do the changes suggested above and rebase your PR too.

Here are some references/tips:

Another option would be:
Close this pull request, and open a new one based on the main branch that makes the same changes. In the new PR, mention that it's a replacement for PR #38390

Thank you.

sftim · 2023-01-04T00:04:08Z

Replaced by #38701

* Rebased issue #38390 * Updated endpoint-slices.md Resolved issue #38701 * Updated endpoint-slice.md * endpoint-slice.md * New endpoint-slice.md file * Updated endpoint-slice.md

* Rebased issue kubernetes#38390 * Updated endpoint-slices.md Resolved issue kubernetes#38701 * Updated endpoint-slice.md * endpoint-slice.md * New endpoint-slice.md file * Updated endpoint-slice.md

Resolved Issue kubernetes#38387 Stale docs

d59f901

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 10, 2022

k8s-ci-robot requested a review from freehan December 10, 2022 17:55

k8s-ci-robot added the language/en Issues or PRs related to English language label Dec 10, 2022

k8s-ci-robot requested a review from mehabhalodiya December 10, 2022 17:55

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Dec 10, 2022

sftim reviewed Dec 12, 2022

View reviewed changes

k8s-ci-robot assigned mehabhalodiya Dec 21, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 21, 2022

tengqm reviewed Dec 21, 2022

View reviewed changes

k8s-ci-robot assigned sftim Dec 21, 2022

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 21, 2022

Updated docs for EndpointSliceTerminatingCondition

14420f6

Resolved issue kubernetes#38390 as per instructed.

tengqm reviewed Dec 21, 2022

View reviewed changes

sftim reviewed Dec 21, 2022

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 28, 2022

YashPimple added a commit to YashPimple/website that referenced this pull request Dec 30, 2022

Rebased issue kubernetes#38390

e760fcc

YashPimple mentioned this pull request Dec 30, 2022

Updated docs for EndpointSliceTerminatingCondition #38701

Merged

YashPimple closed this Dec 30, 2022

YashPimple mentioned this pull request Mar 9, 2023

docs for EndpointSliceTerminatingCondition #39888

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated docs for EndpointSliceTerminatingCondition #38390

Updated docs for EndpointSliceTerminatingCondition #38390

YashPimple commented Dec 10, 2022

netlify bot commented Dec 10, 2022 •

edited

Loading

sftim left a comment

mehabhalodiya commented Dec 21, 2022

tengqm Dec 21, 2022

mehabhalodiya Dec 21, 2022 •

edited

Loading

sftim commented Dec 21, 2022

k8s-ci-robot commented Dec 21, 2022

tengqm Dec 21, 2022

sftim Dec 21, 2022

sftim left a comment

sftim Dec 21, 2022

sftim Dec 21, 2022

sftim Dec 21, 2022

sftim Dec 21, 2022

k8s-ci-robot commented Dec 28, 2022

mehabhalodiya commented Dec 29, 2022

sftim commented Jan 4, 2023


		`serving` is identical to the `ready` condition, except it does not account for terminating states.
		`serving` is identical to the `Ready` condition, except it does not account for terminating states.

-`serving` is identical to the `Ready` condition, except it does not account for terminating states.
+The `serving` condition is almost identical to the `ready` condition. The difference is that
+`serving` continues checking the actual Pod status during Pod termination, whereas `ready`
+turns `false` the moment that the Pod starts to terminate.

	Consumers of the EndpointSlice API should check this condition if they care about pod readiness while
	Consumers of the EndpointSlice API should check `serving` if they care about pod readiness while

Updated docs for EndpointSliceTerminatingCondition #38390

Updated docs for EndpointSliceTerminatingCondition #38390

Conversation

YashPimple commented Dec 10, 2022

netlify bot commented Dec 10, 2022 • edited Loading

✅ Pull request preview available for checking

sftim left a comment

Choose a reason for hiding this comment

mehabhalodiya commented Dec 21, 2022

tengqm Dec 21, 2022

Choose a reason for hiding this comment

mehabhalodiya Dec 21, 2022 • edited Loading

Choose a reason for hiding this comment

sftim commented Dec 21, 2022

k8s-ci-robot commented Dec 21, 2022

tengqm Dec 21, 2022

Choose a reason for hiding this comment

sftim Dec 21, 2022

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

sftim Dec 21, 2022

Choose a reason for hiding this comment

sftim Dec 21, 2022

Choose a reason for hiding this comment

sftim Dec 21, 2022

Choose a reason for hiding this comment

sftim Dec 21, 2022

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 28, 2022

mehabhalodiya commented Dec 29, 2022

sftim commented Jan 4, 2023

netlify bot commented Dec 10, 2022 •

edited

Loading

mehabhalodiya Dec 21, 2022 •

edited

Loading