Document deprecated leader annotation #42054

kundan2707 · 2023-07-17T13:46:31Z

documented unregistered annotation "control-plane.alpha.kubernetes.io/leader"
fixes: #39297

kundan2707 · 2023-07-17T13:46:56Z

/language en

content/en/docs/reference/labels-annotations-taints/_index.md

netlify · 2023-07-17T14:04:35Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`f7df84d`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6524f933d2f2be0008711795
😎 Deploy Preview	https://deploy-preview-42054--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 configuration.

kundan2707 · 2023-07-19T07:22:07Z

@windsonsea pushed the changes suggested by you

windsonsea · 2023-07-19T07:45:59Z

lgtm for the text. Could you squash your commits into a single one?

sftim · 2023-07-19T09:54:51Z

/sig api-machinery

sftim

Thanks

/retitle Document deprecated leader annotation

sftim · 2023-07-19T09:55:47Z

content/en/docs/reference/labels-annotations-taints/_index.md

+
+Type: Annotation
+
+Example: `control-plane.alpha.kubernetes.io/leader={"holderIdentity":"controller-0","leaseDurationSeconds":15,"acquireTime":"2023-01-19T13:12:57Z","renewTime":"2023-01-19T13:13:54Z","leaderTransitions":1}`


I'm afraid this isn't a valid representation of a YAML snippet. Try copying this from an actual Endpoints manifest.

@sftim this is not yaml snippet rather it is outcome of kubectl get command corresponding to this annotation

Thing is: all the other labels and annotations have their examples in the format of a YAML snippet. Let's follow that convention.

@sftim as its got deprecated i am not able to find exact example in any yaml file.
Can you help me in this?

You don't need to copy this from an actual Endpoints; another way is to make sure you are writing [a fragment of] valid YAML.

Try this:
https://learnxinyminutes.com/docs/yaml/

You've got the string value right, but you haven't quoted it, and you've used an = where YAML uses a :.

sftim · 2023-07-19T09:56:17Z

content/en/docs/reference/labels-annotations-taints/_index.md

@@ -1086,6 +1086,23 @@ has been truncated to 1000.

 If the number of backend endpoints falls below 1000, the control plane removes this annotation.

+### control-plane.alpha.kubernetes.io/leader


Suggested change

### control-plane.alpha.kubernetes.io/leader

### control-plane.alpha.kubernetes.io/leader (deprecated) {#control-plane-alpha-kubernetes-io-leader}

sftim · 2023-07-19T09:56:39Z

content/en/docs/reference/labels-annotations-taints/_index.md

+
+Used on: Endpoints
+
+The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} adds this annotation to


Suggested change

The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} adds this annotation to

The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} previously set annotation on

content/en/docs/reference/labels-annotations-taints/_index.md

sftim · 2023-07-19T09:57:36Z

content/en/docs/reference/labels-annotations-taints/_index.md

+Used on: Endpoints
+
+The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} adds this annotation to
+an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provides


Suggested change

an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provides

an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provided

@kundan2707 In your next PR, please help mark these conversations as "resolved" by clicking the "Resolve conversation" button below when you agree to the suggests and you have revised the PR accordingly.
Checking conversation resolved helps the reviewers confirm that previous discussions are clean, the current reviewer may switch to different aspects of the PR, and a new reviewer wouldn't need to check the whole history of a PR.

kundan2707 · 2023-07-19T11:49:21Z

lgtm for the text. Could you squash your commits into a single one?

@windsonsea i will squash all commits after resolving @sftim comments.

content/en/docs/reference/labels-annotations-taints/_index.md

tengqm · 2023-10-10T06:58:41Z

@kundan2707 Please check the latest comment and address it if possible.
/approve

kundan2707 · 2023-10-10T07:02:14Z

@tengqm will incorporate latest comment

k8s-ci-robot · 2023-10-10T07:12:03Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [tengqm]

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

tengqm · 2023-10-10T07:45:18Z

All feedback resolved.
/lgtm
(reapplied).

k8s-ci-robot · 2023-10-10T07:45:28Z

LGTM label has been added.

Git tree hash: e4d4741dd3db8fb85f13afb7961e244496b77734

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 17, 2023

k8s-ci-robot requested review from divya-mohan0209 and natalisucks July 17, 2023 13:46

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 17, 2023

windsonsea reviewed Jul 17, 2023

View reviewed changes

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Jul 19, 2023

sftim reviewed Jul 19, 2023

View reviewed changes

k8s-ci-robot changed the title ~~documented annotation leader~~ Document deprecated leader annotation Jul 19, 2023

kundan2707 force-pushed the annotation-leader branch from 0861b44 to f6f9e85 Compare July 23, 2023 07:35

sftim reviewed Jul 24, 2023

View reviewed changes

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 10, 2023

kundan2707 force-pushed the annotation-leader branch from f6f9e85 to d45d1b5 Compare October 10, 2023 07:10

k8s-ci-robot added the language/id Issues or PRs related to Indonesian language label Oct 10, 2023

documented annotation leader

f7df84d

kundan2707 force-pushed the annotation-leader branch from d45d1b5 to f7df84d Compare October 10, 2023 07:11

k8s-ci-robot assigned tengqm Oct 10, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 10, 2023

k8s-ci-robot merged commit 05a7760 into kubernetes:main Oct 10, 2023
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document deprecated leader annotation #42054

Document deprecated leader annotation #42054

kundan2707 commented Jul 17, 2023

kundan2707 commented Jul 17, 2023

netlify bot commented Jul 17, 2023 •

edited

Loading

kundan2707 commented Jul 19, 2023

windsonsea commented Jul 19, 2023

sftim commented Jul 19, 2023

sftim left a comment

sftim Jul 19, 2023

kundan2707 Jul 23, 2023

sftim Jul 23, 2023

kundan2707 Jul 31, 2023

sftim Aug 1, 2023

sftim Jul 19, 2023

sftim Jul 19, 2023

sftim Jul 19, 2023

tengqm Oct 10, 2023

kundan2707 commented Jul 19, 2023

tengqm commented Oct 10, 2023

kundan2707 commented Oct 10, 2023

k8s-ci-robot commented Oct 10, 2023

tengqm commented Oct 10, 2023

k8s-ci-robot commented Oct 10, 2023


		Type: Annotation

		Example: `control-plane.alpha.kubernetes.io/leader={"holderIdentity":"controller-0","leaseDurationSeconds":15,"acquireTime":"2023-01-19T13:12:57Z","renewTime":"2023-01-19T13:13:54Z","leaderTransitions":1}`

		@@ -1086,6 +1086,23 @@ has been truncated to 1000.

		If the number of backend endpoints falls below 1000, the control plane removes this annotation.

		### control-plane.alpha.kubernetes.io/leader


		Used on: Endpoints

		The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} adds this annotation to

	an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provides
	an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provided

Document deprecated leader annotation #42054

Document deprecated leader annotation #42054

Conversation

kundan2707 commented Jul 17, 2023

kundan2707 commented Jul 17, 2023

netlify bot commented Jul 17, 2023 • edited Loading

✅ Pull request preview available for checking

kundan2707 commented Jul 19, 2023

windsonsea commented Jul 19, 2023

sftim commented Jul 19, 2023

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kundan2707 commented Jul 19, 2023

tengqm commented Oct 10, 2023

kundan2707 commented Oct 10, 2023

k8s-ci-robot commented Oct 10, 2023

tengqm commented Oct 10, 2023

k8s-ci-robot commented Oct 10, 2023

netlify bot commented Jul 17, 2023 •

edited

Loading