Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move AWS Service annotation details to reference page #38551

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Dec 19, 2022

https://kubernetes.io/docs/concepts/services-networking/service/ has a bunch of specific details for one cloud provider, AWS.

These belong elsewhere; there are already good homes at https://cloud-provider-aws.sigs.k8s.io/service_controller/ and https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/, so we can omit them from the Service page.

I updated https://kubernetes.io/docs/reference/labels-annotations-taints/ to list all the AWS annotations for Services, and I marked all of those as deprecated because they include .beta. in the subdomain part of the label key (which is a generally deprecated practice).

Preview of the revised Service page.

Open question, though: should we link from https://kubernetes.io/docs/concepts/services-networking/service/ to https://cloud-provider-aws.sigs.k8s.io/service_controller/ and to https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/?

marking as Draft because of the open question

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 19, 2022
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Dec 19, 2022
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Dec 19, 2022
@netlify
Copy link

netlify bot commented Dec 19, 2022

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 5a98033
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6499f7a9826842000867c266
😎 Deploy Preview https://deploy-preview-38551--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 23, 2022
@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from 9036146 to a4cf09b Compare February 23, 2023 12:22
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 23, 2023
@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from a4cf09b to 48a832a Compare February 23, 2023 14:59
@tengqm
Copy link
Contributor

tengqm commented Feb 26, 2023

This is NICE.
/lgtm
I'm not sure the beta in the annotations means that they are deprecated though.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 26, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: f037617245669dd1c40ddd33483da17a3ae40c36

@sftim
Copy link
Contributor Author

sftim commented Feb 27, 2023

I understood that all annotations with alpha or beta in their name were deprecated and that SIGs should look to move away.

Since I opened this PR, I found https://cloud-provider-aws.sigs.k8s.io/service_controller/ and also https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/

  1. We can hyperlink to these
  2. I can file enhancement issues against the AWS and Azure cloud provider code to recommend using a non-beta annotation, ideally one that doesn't use a kubernetes.io domain.

@tengqm
Copy link
Contributor

tengqm commented Mar 1, 2023

My take is that most of the providers of those APIs are cautious about the "maturity level" of their technologies.
"Alpha", "Beta" are an indication of technology maturity. An "Alpha" version of something may be widely used, and a "Beta" release might be deprecated a long time ago. Similarly, a "v1" release might become EOL several years ago.
I cannot tell if a "Beta" thing is deprecated or not. If it is deprecated, we must already have a more mature thing as a replacement. That's the reason I think we may need double confirm at this.

@sftim
Copy link
Contributor Author

sftim commented Mar 2, 2023

I'll ask SIG Architecture how we should mark 'em.
Also, I'll hyperlink to the provider docs.

The thing that makes them deprecated isn't the beta status, it's putting the status in the annotation key. The modern way is to use the same key, without an alpha or beta substring, all the way to GA.

@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from 48a832a to ee4c1f7 Compare April 14, 2023 13:39
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 14, 2023
@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from bd45bb2 to 6144923 Compare April 14, 2023 13:54
@sftim sftim marked this pull request as ready for review April 14, 2023 14:11
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 14, 2023
@sftim
Copy link
Contributor Author

sftim commented Apr 14, 2023

Ok, I think this is ready for review.

@sftim
Copy link
Contributor Author

sftim commented Apr 14, 2023

I just went with marking all but one actually-deprecated annotation as beta.

@sftim
Copy link
Contributor Author

sftim commented Apr 20, 2023

Changes since last LGTM

@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch 2 times, most recently from a7405a5 to 8f87def Compare May 15, 2023 17:49
@sftim
Copy link
Contributor Author

sftim commented May 15, 2023

All changes since #38551 (comment) are just rebases.

@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from 8f87def to 7706e48 Compare May 15, 2023 17:55
@tengqm
Copy link
Contributor

tengqm commented May 16, 2023

/approve

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 16, 2023
@k8s-ci-robot
Copy link
Contributor

[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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 16, 2023
@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from 7706e48 to 9edd20b Compare May 16, 2023 08:04
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 16, 2023
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 3, 2023
@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from 9edd20b to bca32b1 Compare June 10, 2023 08:43
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 10, 2023
@sftim sftim force-pushed the 20221219_migrate_aws_specifics_from_service branch from bca32b1 to 5a98033 Compare June 26, 2023 20:40
@windsonsea
Copy link
Member

wow, half a year passed.
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 30, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: c548d94c05dbb2cc1c90d4996bb32e7468aa2602

@k8s-ci-robot k8s-ci-robot merged commit c5ee829 into kubernetes:main Jun 30, 2023
@sftim sftim deleted the 20221219_migrate_aws_specifics_from_service branch June 30, 2023 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants