Skip to content

Commit 6ceb458

Browse files
committed
Add IP based load balancer documentation
1 parent 5c0bd3a commit 6ceb458

File tree

1 file changed

+73
-3
lines changed

1 file changed

+73
-3
lines changed

articles/aks/load-balancer-standard.md

Lines changed: 73 additions & 3 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.date: 11/14/2020
8-
ms.author: jpalma
9-
author: palma21
7+
ms.date: 9/27/2022
8+
ms.author: pahealy
9+
author: phealy
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
---
@@ -87,6 +87,76 @@ When using the Standard SKU public load balancer, there's a set of options that
8787
> [!IMPORTANT]
8888
> Only one outbound IP option (managed IPs, bring your own IP, or IP Prefix) can be used at a given time.
8989
90+
### Change the outbound pool type (PREVIEW)
91+
92+
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.
93+
94+
Two different pool membership types are available:
95+
96+
- `nodeIPConfiguration` - legacy VMSS IP configuration based pool membership type
97+
- `nodeIP` - IP-based membership type
98+
99+
#### Requirements
100+
101+
* The `aks-preview` extension must be at least version 0.5.103.
102+
* The AKS cluster must be version 1.23 or newer.
103+
* The AKS cluster must be using standard load balancers and virtual machine scale sets.
104+
105+
[!INCLUDE [preview features callout](./includes/preview/preview-callout.md)]
106+
107+
#### Install the aks-preview CLI extension
108+
109+
```azurecli-interactive
110+
# Install the aks-preview extension
111+
az extension add --name aks-preview
112+
113+
# Update the extension to make sure you have the latest version installed
114+
az extension update --name aks-preview
115+
```
116+
117+
#### Register the `IPBasedLoadBalancerPreview` preview feature
118+
119+
To create an AKS cluster with API Server VNet Integration, you must enable the `IPBasedLoadBalancerPreview` feature flag on your subscription.
120+
121+
Register the `IPBasedLoadBalancerPreview` feature flag by using the `az feature register` command, as shown in the following example:
122+
123+
```azurecli-interactive
124+
az feature register --namespace "Microsoft.ContainerService" --name "IPBasedLoadBalancerPreview"
125+
```
126+
127+
It takes a few minutes for the status to show *Registered*. Verify the registration status by using the `az feature list` command:
128+
129+
```azurecli-interactive
130+
az feature list -o table --query "[?contains(name, 'Microsoft.ContainerService/IPBasedLoadBalancerPreview')].{Name:name,State:properties.state}"
131+
```
132+
133+
When the feature has been registered, refresh the registration of the *Microsoft.ContainerService* resource provider by using the `az provider register` command:
134+
135+
```azurecli-interactive
136+
az provider register --namespace Microsoft.ContainerService
137+
```
138+
139+
#### Create a new AKS cluster with IP-based outbound pool membership
140+
141+
```azurecli-interactive
142+
az aks create \
143+
--resource-group myResourceGroup \
144+
--name myAKSCluster \
145+
--load-balancer-backend-pool-type=nodeIP
146+
```
147+
148+
#### Update an existing AKS cluster to use IP-based outbound pool membership
149+
150+
> [!WARNING]
151+
> 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.
152+
153+
```azurecli-interactive
154+
az aks update \
155+
--resource-group myResourceGroup \
156+
--name myAKSCluster \
157+
--load-balancer-backend-pool-type=nodeIP
158+
```
159+
90160
### Scale the number of managed outbound public IPs
91161

92162
Azure Load Balancer provides outbound connectivity from a virtual network in addition to inbound. Outbound rules make it simple to configure public Standard Load Balancer's outbound network address translation.

0 commit comments

Comments
 (0)