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.

Sign up for GitHub

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

Jump to bottom

Add 3, modify 1 annotation for Azure load balancer doc #7960

Merged
merged 3 commits into from
Jan 8, 2025
Merged

Add 3, modify 1 annotation for Azure load balancer doc #7960

merged 3 commits into from
Jan 8, 2025

Conversation

Timberlake-Z
Copy link

@Timberlake-Z Timberlake-Z commented Jan 7, 2025 •
edited
Loading

What type of PR is this?

/kind documentation

What this PR does / why we need it:

There are 3 missing annotation for Azure load balancer, as well as 1 wrong description. Fixed in this PR

Which issue(s) this PR fixes:

Fixes #7914

Special notes for your reviewer:

Does this PR introduce a user-facing change?

None

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Jan 7, 2025
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jan 7, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 7, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @Timberlake-Z!

It looks like this is your first PR to kubernetes-sigs/cloud-provider-azure 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cloud-provider-azure has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jan 7, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @Timberlake-Z. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 7, 2025
@netlify Netlify
Copy link

netlify bot commented Jan 7, 2025 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-cloud-provide-azure ready!

Name Link
🔨 Latest commit f01f9bc
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cloud-provide-azure/deploys/677cae17a74a2300081feda5
😎 Deploy Preview https://deploy-preview-7960--kubernetes-sigs-cloud-provide-azure.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.

@nilo19
Copy link
Contributor

nilo19 commented Jan 7, 2025

Please revert DS_Store changes.

MartinForReal
MartinForReal reviewed Jan 7, 2025
View reviewed changes
content/en/.DS_Store Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 7, 2025
nilo19
nilo19 reviewed Jan 7, 2025
View reviewed changes
content/en/topics/loadbalancer.md Outdated
@@ -49,6 +50,15 @@ Below is a list of annotations supported for Kubernetes services with type `Load
| `service.beta.kubernetes.io/azure-additional-public-ips` | External public IPs besides the service's own public IP | It is mainly used for global VIP on Azure cross-region LoadBalancer | v1.20 and later with out-of-tree cloud provider |
| `service.beta.kubernetes.io/azure-disable-load-balancer-floating-ip` | `true` or `false` | Disable [Floating IP configuration](https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-floating-ip) for load balancer | v1.21 and later with out-of-tree cloud provider |
| `service.beta.kubernetes.io/azure-pip-ip-tags` | comma separated key-value pairs `a=b,c=d`, for example `RoutingPreference=Internet` | Refer to the [doc](https://learn.microsoft.com/en-us/javascript/api/@azure/arm-network/iptag?view=azure-node-latest) | v1.21 and later with out-of-tree cloud provider |
| `service.beta.kubernetes.io/azure-load-balancer-disable-tcp-reset` | `true` or `false` | Controls whether Azure Load Balancer enables TCP Reset. By default, this is set to false, meaning TCP Reset is enabled in this configuration. used. | v1.25 and later |
| `service.beta.kubernetes.io/azure-load-balancer-configurations` | comma separated list of load balancer configurations | The list of load balancer configurations the service can use. It will be omitted if multi-slb is not used. Refer to the detailed docs [here](https://cloud-provider-azure.sigs.k8s.io/topics/multislb/) | v1.28 and later |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use local links here. (../multislb)

nilo19
nilo19 reviewed Jan 7, 2025
View reviewed changes
content/en/topics/loadbalancer.md Outdated
@@ -49,6 +50,15 @@ Below is a list of annotations supported for Kubernetes services with type `Load
| `service.beta.kubernetes.io/azure-additional-public-ips` | External public IPs besides the service's own public IP | It is mainly used for global VIP on Azure cross-region LoadBalancer | v1.20 and later with out-of-tree cloud provider |
| `service.beta.kubernetes.io/azure-disable-load-balancer-floating-ip` | `true` or `false` | Disable [Floating IP configuration](https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-floating-ip) for load balancer | v1.21 and later with out-of-tree cloud provider |
| `service.beta.kubernetes.io/azure-pip-ip-tags` | comma separated key-value pairs `a=b,c=d`, for example `RoutingPreference=Internet` | Refer to the [doc](https://learn.microsoft.com/en-us/javascript/api/@azure/arm-network/iptag?view=azure-node-latest) | v1.21 and later with out-of-tree cloud provider |
| `service.beta.kubernetes.io/azure-load-balancer-disable-tcp-reset` | `true` or `false` | Controls whether Azure Load Balancer enables TCP Reset. By default, this is set to false, meaning TCP Reset is enabled in this configuration. used. | v1.25 and later |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please double check the gramma.

nilo19
nilo19 reviewed Jan 7, 2025
View reviewed changes
content/en/topics/loadbalancer.md Outdated
@@ -22,11 +22,12 @@ Below is a list of annotations supported for Kubernetes services with type `Load
| `service.beta.kubernetes.io/azure-load-balancer-internal-subnet` | Name of the subnet | Specify which subnet the internal load balancer should be bound to. It's defaulting to the subnet configured in cloud config file if not set. | v1.10.0 and later |
| `service.beta.kubernetes.io/azure-load-balancer-mode` | `auto`, `{vmset-name}` | Specify the Azure load balancer selection algorithm based on vm sets (VMSS or VMAS). There are currently three possible load balancer selection modes : default, auto or "{vmset-name}". This is only working for basic LB (see below for how it works) | v1.10.0 and later |
| `service.beta.kubernetes.io/azure-dns-label-name` | Name of the PIP DNS label | Specify the DNS label name for the service's public IP address (PIP). If it is set to empty string, DNS in PIP would be deleted. Because of a bug, before v1.15.10/v1.16.7/v1.17.3, the DNS label on PIP would also be deleted if the annotation is not specified. | v1.15.0 and later |
| `service.beta.kubernetes.io/azure-load-balancer-health-probe-protocol` | probe protocol | Determines the network protocol that the load balancer health probe use.If not set, the local service would use the HTTP and the cluster service would use the TCP by default. (service type here indicates `externalTrafficPolicy`). This setting will be overwritten by `service.beta.kubernetes.io/port_{port}_health-probe_protocol` on specified port. | v1.10.0 and later |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please double check the gramma, e.g., space should be there after a period.

@nilo19
Copy link
Contributor

nilo19 commented Jan 7, 2025

related #6550

@Timberlake-Z Timberlake-Z changed the title 3 annotation tasks Add 3, modify 1 annotation for Azure load balancer doc Jan 7, 2025
@nilo19
Copy link
Contributor

nilo19 commented Jan 8, 2025

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 8, 2025
@nilo19
Copy link
Contributor

nilo19 commented Jan 8, 2025

Thanks for enriching the documentation.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nilo19, Timberlake-Z

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 Jan 8, 2025
@k8s-ci-robot k8s-ci-robot merged commit 50d0fa3 into kubernetes-sigs:documentation Jan 8, 2025
7 checks passed
@Timberlake-Z Timberlake-Z deleted the doc-task branch January 8, 2025 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nilo19 nilo19 nilo19 left review comments

@MartinForReal MartinForReal MartinForReal left review comments

Assignees

@nilo19 nilo19

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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Timberlake-Z @k8s-ci-robot @nilo19 @MartinForReal