📖added supported labels and annotations refrence document #7418

hackeramitkumar · 2022-10-17T15:19:12Z

What this PR does / why we need it:
I have added all the supported labels and annotation in a single refrence document. I have added a .md file in refrence section , which contains two tables one for labels and another for annotations.

Fixes #5394

k8s-ci-robot · 2022-10-17T15:19:20Z

Hi @hackeramitkumar. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

killianmuldoon

/ok-to-test

killianmuldoon

Thanks for taking this on! I've got a few changes that might help to make this easier to read and understand.

killianmuldoon · 2022-10-17T15:20:33Z

docs/book/src/SUMMARY.md

@@ -108,3 +108,4 @@
    - [Code Review in Cluster API](./REVIEWING.md)
    - [Version Support](./reference/versions.md)
    - [Roadmap](./roadmap.md)
+    - [Supported Labels/Annotations](./reference/labels_and_annotations.md)


Could we also add a link to this in the API reference? i.e. ./reference/api_reference.md

killianmuldoon · 2022-10-17T15:20:45Z

docs/book/src/reference/labels_and_annotations.md

+
+|label     |note     |
+|:--------:|:--------:|
+| cluster.x-k8s.io/cluster-name| this label is set on machines linked to a cluster and external objects(bootstrap and infrastructure providers) |


Suggested change

| cluster.x-k8s.io/cluster-name| this label is set on machines linked to a cluster and external objects(bootstrap and infrastructure providers) |

| cluster.x-k8s.io/cluster-name| this label is set on machines linked to a cluster and external objects (bootstrap and infrastructure providers) |

killianmuldoon · 2022-10-17T15:25:04Z

docs/book/src/reference/labels_and_annotations.md

+
+|annotation     | note     |
+|:--------:|:--------:|
+| topology.cluster.x-k8s.io/managed-field-paths   |  this annotation is used to store the list of paths managed by the topology controller. changes to those paths will be considered authoritative.  |


Suggested change

| topology.cluster.x-k8s.io/managed-field-paths | this annotation is used to store the list of paths managed by the topology controller. changes to those paths will be considered authoritative. |

| topology.cluster.x-k8s.io/managed-field-paths | This annotation is used to store the list of paths managed by the topology controller. changes to those paths will be considered authoritative. |

Could you capitalize the first letter of sentences throughout?

docs/book/src/reference/labels_and_annotations.md

docs/book/src/SUMMARY.md

alexander-demicev

good to see labels being documented

docs/book/src/reference/labels_and_annotations.md

hackeramitkumar · 2022-10-19T08:40:34Z

@alexander-demichev please review the PR. I have now made changes according to you and killianmuldoon.

fabriziopandini · 2022-10-19T09:10:07Z

This is a great start, thank you!
Let's also open an issue for a follow up iteration where we should add two columns to those tables:

Object the label/annotation applies to
Managed by Cluster API or by users

Ideally, we should also define some consistent sort criteria for both tables

alexander-demicev

/lgtm

killianmuldoon

/lgtm

furkatgofurov7

Minor nits, otherwise lgtm:

docs/book/src/reference/labels_and_annotations.md

CecileRobertMichon

Depending on which one merges first, we should add #7107 to this doc

cc @jackfrancis

hackeramitkumar · 2022-10-20T13:05:32Z

@furkatgofurov7 , You have to add a "/" before lgtm.

fabriziopandini

/lgtm
Please open an issue to track follow up work as per the comment above

hackeramitkumar · 2022-10-21T13:27:17Z

/lgtm Please open an issue to track follow up work as per the comment above

Yeah sure.

docs/book/src/reference/labels_and_annotations.md

hackeramitkumar · 2022-10-24T13:00:09Z

@sbueringer , I have removed "topology.cluster.x-k8s.io/managed-field-paths" annotation and made all the columns to left justified. Please review it.

sbueringer · 2022-11-03T07:53:04Z

@hackeramitkumar
Thank you very much!!h

/cherry-pick release-1.2

k8s-infra-cherrypick-robot · 2022-11-03T07:53:06Z

@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.2 in a new PR and assign it to you.

In response to this:

@hackeramitkumar
Thank you very much!!h

/cherry-pick release-1.2

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.

sbueringer · 2022-11-03T07:53:11Z

/lgtm
/approve

k8s-ci-robot · 2022-11-03T07:53:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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:

~~OWNERS~~ [sbueringer]

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

k8s-infra-cherrypick-robot · 2022-11-03T08:04:34Z

@sbueringer: new pull request created: #7488

In response to this:

@hackeramitkumar
Thank you very much!!h

/cherry-pick release-1.2

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.

k8s-ci-robot requested a review from JoelSpeed October 17, 2022 15:19

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

k8s-ci-robot requested a review from stmcginnis October 17, 2022 15:19

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 17, 2022

killianmuldoon reviewed Oct 17, 2022

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 17, 2022

hackeramitkumar changed the title ~~📖added supported labels and annotations~~ 📖added supported labels and annotations refrence document Oct 17, 2022

killianmuldoon reviewed Oct 17, 2022

View reviewed changes

alexander-demicev reviewed Oct 18, 2022

View reviewed changes

hackeramitkumar force-pushed the supported_labels_annotations branch from 089fc2b to 97e7b68 Compare October 18, 2022 09:28

hackeramitkumar requested review from alexander-demicev and removed request for stmcginnis and JoelSpeed October 18, 2022 09:28

hackeramitkumar force-pushed the supported_labels_annotations branch 2 times, most recently from 0f2f306 to 28adb17 Compare October 18, 2022 09:45

hackeramitkumar mentioned this pull request Oct 18, 2022

REQUEST: New membership for @hackeramitkumar kubernetes/org#3761

Closed

9 tasks

alexander-demicev reviewed Oct 19, 2022

View reviewed changes

k8s-ci-robot assigned alexander-demicev Oct 19, 2022

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

killianmuldoon approved these changes Oct 19, 2022

View reviewed changes

k8s-ci-robot assigned killianmuldoon Oct 19, 2022

furkatgofurov7 reviewed Oct 19, 2022

View reviewed changes

docs/book/src/reference/labels_and_annotations.md Show resolved Hide resolved

docs/book/src/reference/labels_and_annotations.md Outdated Show resolved Hide resolved

docs/book/src/reference/labels_and_annotations.md Outdated Show resolved Hide resolved

CecileRobertMichon reviewed Oct 19, 2022

View reviewed changes

hackeramitkumar force-pushed the supported_labels_annotations branch from 28adb17 to 1826ad1 Compare October 20, 2022 10:00

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

fabriziopandini reviewed Oct 21, 2022

View reviewed changes

k8s-ci-robot assigned fabriziopandini Oct 21, 2022

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

hackeramitkumar mentioned this pull request Oct 21, 2022

Add extra information in the supported labels and annotations tables #7441

Open

AverageMarcus reviewed Oct 24, 2022

View reviewed changes

docs/book/src/reference/labels_and_annotations.md Outdated Show resolved Hide resolved

sbueringer reviewed Oct 24, 2022

View reviewed changes

docs/book/src/reference/labels_and_annotations.md Outdated Show resolved Hide resolved

docs/book/src/reference/labels_and_annotations.md Outdated Show resolved Hide resolved

added supported labels and annotations

cfefedb

hackeramitkumar force-pushed the supported_labels_annotations branch from 1826ad1 to cfefedb Compare October 24, 2022 12:56

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

hackeramitkumar requested review from alexander-demicev, sbueringer and fabriziopandini and removed request for alexander-demicev, sbueringer and fabriziopandini October 29, 2022 03:10

k8s-ci-robot assigned sbueringer Nov 3, 2022

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

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 3, 2022

k8s-ci-robot merged commit 2122310 into kubernetes-sigs:main Nov 3, 2022

k8s-ci-robot added this to the v1.3 milestone Nov 3, 2022

k8s-infra-cherrypick-robot mentioned this pull request Nov 3, 2022

[release-1.2] 📖added supported labels and annotations refrence document #7488

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖added supported labels and annotations refrence document #7418

📖added supported labels and annotations refrence document #7418

hackeramitkumar commented Oct 17, 2022

k8s-ci-robot commented Oct 17, 2022

killianmuldoon left a comment

killianmuldoon left a comment

killianmuldoon Oct 17, 2022

hackeramitkumar Oct 19, 2022

killianmuldoon Oct 17, 2022

hackeramitkumar Oct 19, 2022

killianmuldoon Oct 17, 2022

hackeramitkumar Oct 19, 2022

alexander-demicev left a comment

hackeramitkumar commented Oct 19, 2022

fabriziopandini commented Oct 19, 2022

alexander-demicev left a comment

killianmuldoon left a comment

furkatgofurov7 left a comment

CecileRobertMichon left a comment

hackeramitkumar commented Oct 20, 2022

fabriziopandini left a comment

hackeramitkumar commented Oct 21, 2022

hackeramitkumar commented Oct 24, 2022

sbueringer commented Nov 3, 2022

k8s-infra-cherrypick-robot commented Nov 3, 2022

sbueringer commented Nov 3, 2022

k8s-ci-robot commented Nov 3, 2022

k8s-infra-cherrypick-robot commented Nov 3, 2022

	\| cluster.x-k8s.io/cluster-name\| this label is set on machines linked to a cluster and external objects(bootstrap and infrastructure providers) \|
	\| cluster.x-k8s.io/cluster-name\| this label is set on machines linked to a cluster and external objects (bootstrap and infrastructure providers) \|

	\| topology.cluster.x-k8s.io/managed-field-paths \| this annotation is used to store the list of paths managed by the topology controller. changes to those paths will be considered authoritative. \|
	\| topology.cluster.x-k8s.io/managed-field-paths \| This annotation is used to store the list of paths managed by the topology controller. changes to those paths will be considered authoritative. \|

📖added supported labels and annotations refrence document #7418

📖added supported labels and annotations refrence document #7418

Conversation

hackeramitkumar commented Oct 17, 2022

k8s-ci-robot commented Oct 17, 2022

killianmuldoon left a comment

Choose a reason for hiding this comment

killianmuldoon left a comment

Choose a reason for hiding this comment

killianmuldoon Oct 17, 2022

Choose a reason for hiding this comment

hackeramitkumar Oct 19, 2022

Choose a reason for hiding this comment

killianmuldoon Oct 17, 2022

Choose a reason for hiding this comment

hackeramitkumar Oct 19, 2022

Choose a reason for hiding this comment

killianmuldoon Oct 17, 2022

Choose a reason for hiding this comment

hackeramitkumar Oct 19, 2022

Choose a reason for hiding this comment

alexander-demicev left a comment

Choose a reason for hiding this comment

hackeramitkumar commented Oct 19, 2022

fabriziopandini commented Oct 19, 2022

alexander-demicev left a comment

Choose a reason for hiding this comment

killianmuldoon left a comment

Choose a reason for hiding this comment

furkatgofurov7 left a comment

Choose a reason for hiding this comment

CecileRobertMichon left a comment

Choose a reason for hiding this comment

hackeramitkumar commented Oct 20, 2022

fabriziopandini left a comment

Choose a reason for hiding this comment

hackeramitkumar commented Oct 21, 2022

hackeramitkumar commented Oct 24, 2022

sbueringer commented Nov 3, 2022

k8s-infra-cherrypick-robot commented Nov 3, 2022

sbueringer commented Nov 3, 2022

k8s-ci-robot commented Nov 3, 2022

k8s-infra-cherrypick-robot commented Nov 3, 2022