Skip to content

Commit a5b8fbf

Browse files
Merge pull request #212756 from phealy/slb-nodeip-support
Add IP based load balancer documentation
2 parents 0d895a0 + da967fc commit a5b8fbf

File tree

1 file changed

+76
-2
lines changed

1 file changed

+76
-2
lines changed

articles/aks/load-balancer-standard.md

Lines changed: 76 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ titleSuffix: Azure Kubernetes Service
44
description: Learn how to use a public load balancer with a Standard SKU to expose your services with Azure Kubernetes Service (AKS).
55
services: container-service
66
ms.topic: article
7+
ms.author: pahealy
8+
author: phealy
79
ms.date: 12/19/2022
8-
ms.author: jpalma
9-
author: palma21
1010

1111
#Customer intent: As a cluster operator or developer, I want to learn how to create a service in AKS that uses an Azure Load Balancer with a Standard SKU.
1212
---
@@ -114,6 +114,80 @@ You can customize different settings for your standard public load balancer at c
114114
> [!IMPORTANT]
115115
> Only one outbound IP option (managed IPs, bring your own IP, or IP prefix) can be used at a given time.
116116

117+
### Change the inbound pool type (PREVIEW)
118+
119+
AKS nodes can be referenced in the load balancer backend pools by either their IP configuration (VMSS based membership) or by their IP address only. Utilizing the IP address based backend pool membership provides higher efficiencies when updating services and provisioning load balancers, especially at high node counts. Provisioning new clusters with IP based backend pools and converting existing clusters is now supported. When combined with NAT Gateway or user-defined routing egress types, provisioning of new nodes and services will be more performant.
120+
121+
Two different pool membership types are available:
122+
123+
- `nodeIPConfiguration` - legacy VMSS IP configuration based pool membership type
124+
- `nodeIP` - IP-based membership type
125+
126+
#### Requirements
127+
128+
* The `aks-preview` extension must be at least version 0.5.103.
129+
* The AKS cluster must be version 1.23 or newer.
130+
* The AKS cluster must be using standard load balancers and virtual machine scale sets.
131+
132+
#### Limitations
133+
134+
* Clusters using IP based backend pools are limited to 2500 nodes.
135+
136+
[!INCLUDE [preview features callout](./includes/preview/preview-callout.md)]
137+
138+
#### Install the aks-preview CLI extension
139+
140+
```azurecli-interactive
141+
# Install the aks-preview extension
142+
az extension add --name aks-preview
143+
144+
# Update the extension to make sure you have the latest version installed
145+
az extension update --name aks-preview
146+
```
147+
148+
#### Register the `IPBasedLoadBalancerPreview` preview feature
149+
150+
To create an AKS cluster with IP based backend pools, you must enable the `IPBasedLoadBalancerPreview` feature flag on your subscription.
151+
152+
Register the `IPBasedLoadBalancerPreview` feature flag by using the `az feature register` command, as shown in the following example:
153+
154+
```azurecli-interactive
155+
az feature register --namespace "Microsoft.ContainerService" --name "IPBasedLoadBalancerPreview"
156+
```
157+
158+
It takes a few minutes for the status to show *Registered*. Verify the registration status by using the `az feature list` command:
159+
160+
```azurecli-interactive
161+
az feature list -o table --query "[?contains(name, 'Microsoft.ContainerService/IPBasedLoadBalancerPreview')].{Name:name,State:properties.state}"
162+
```
163+
164+
When the feature has been registered, refresh the registration of the *Microsoft.ContainerService* resource provider by using the `az provider register` command:
165+
166+
```azurecli-interactive
167+
az provider register --namespace Microsoft.ContainerService
168+
```
169+
170+
#### Create a new AKS cluster with IP-based inbound pool membership
171+
172+
```azurecli-interactive
173+
az aks create \
174+
--resource-group myResourceGroup \
175+
--name myAKSCluster \
176+
--load-balancer-backend-pool-type=nodeIP
177+
```
178+
179+
#### Update an existing AKS cluster to use IP-based inbound pool membership
180+
181+
> [!WARNING]
182+
> This operation will cause a temporary disruption to incoming service traffic in the cluster. The impact time will increase with larger clusters that have many nodes.
183+
184+
```azurecli-interactive
185+
az aks update \
186+
--resource-group myResourceGroup \
187+
--name myAKSCluster \
188+
--load-balancer-backend-pool-type=nodeIP
189+
```
190+
117191
### Scale the number of managed outbound public IPs
118192

119193
Azure Load Balancer provides outbound and inbound connectivity from a virtual network. Outbound rules make it simple to configure network address translation for the public standard load balancer.

0 commit comments

Comments
 (0)