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

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

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa8d88b
3 annotation tasks
Timberlake-Z Jan 7, 2025
0af17b5
Remove .DS_Store files
Timberlake-Z Jan 7, 2025
f01f9bc
1
Timberlake-Z Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion content/en/topics/loadbalancer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

| `service.beta.kubernetes.io/azure-shared-securityrule` | `true` or `false` | Specify that the service should be exposed using an Azure security rule that may be shared with another service, trading specificity of rules for an increase in the number of services that can be exposed. This relies on the Azure "augmented security rules" feature. | v1.10.0 and later |
| `service.beta.kubernetes.io/azure-load-balancer-resource-group` | Name of the PIP resource group | Specify the resource group of the service's PIP that are not in the same resource group as the cluster. | v1.10.0 and later |
| `service.beta.kubernetes.io/azure-allowed-service-tags` | List of allowed service tags | Specify a list of allowed [service tags](https://docs.microsoft.com/en-us/azure/virtual-network/security-overview#service-tags) separated by comma. | v1.11.0 and later |
| `service.beta.kubernetes.io/azure-allowed-ip-ranges` | List of allowed IP ranges | Specify a list of allowed IP ranges separated by comma. | v1.29.0 and later |
| `service.beta.kubernetes.io/azure-load-balancer-tcp-idle-timeout` | TCP idle timeouts in minutes | Specify the time, in minutes, for TCP connection idle timeouts to occur on the load balancer. Default and minimum value is 4. Maximum value is 30. Must be an integer. | v1.11.4, v1.12.0 and later |
| `service.beta.kubernetes.io/azure-load-balancer-tcp-idle-timeout` | TCP idle timeouts in minutes | Specify the time, in minutes, for TCP connection idle timeouts to occur on the load balancer. Default and minimum value is 4. Maximum value is 100. Must be an integer. | v1.11.4, v1.12.0 and later |
| `service.beta.kubernetes.io/azure-pip-name` | Name of PIP | Specify the PIP that will be applied to load balancer. It is used for IPv4 or IPv6 in a single stack cluster. | v1.16 and later |
| `service.beta.kubernetes.io/azure-pip-name-ipv6` | Name of IPv6 PIP | After v1.27, specify the IPv6 PIP that will be applied to load balancer in a dual stack cluster. For single stack clusters, this annotation will be ignored. | v1.27 and later |
| `service.beta.kubernetes.io/azure-pip-prefix-id` | ID of Public IP Prefix | Specify the Public IP Prefix that will be applied to load balancer. It is for IPv4 or IPv6 in a single stack cluster. | v1.21 and later with out-of-tree cloud provider |
Expand All @@ -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.

| `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)









Please note that

Expand Down
Loading