Skip to content

Commit 5fb670b

Browse files
committed
add docs for control plane outbound lb
1 parent e5c40a4 commit 5fb670b

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [AAD Integration](./topics/aad-integration.md)
99
- [API Server Endpoint](./topics/api-server-endpoint.md)
1010
- [Cloud Provider Config](./topics/cloud-provider-config.md)
11+
- [Control Plane Outbound Load Balancer](./topics/control-plane-outbound-lb.md)
1112
- [Custom Private DNS Zone Name](./topics/custom-dns.md)
1213
- [Custom Images](./topics/custom-images.md)
1314
- [Data Disks](./topics/data-disks.md)
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Control Plane Outbound Load Balancer
2+
3+
This document describes how to configure your clusters' control plane outbound load balancer.
4+
5+
### Public Clusters
6+
7+
For public clusters ie. clusters with api server load balancer type set to `Public`, CAPZ automatically does not support adding a control plane outbound load balancer.
8+
This is because the api server load balancer already allows for outbound traffic in public clusters.
9+
10+
### Private Clusters
11+
12+
For private clusters ie. clusters with api server load balancer type set to `Internal`, CAPZ does not create a control plane outbound load balancer by default.
13+
To create a control plane outbound load balancer, include the `controlPlaneOutboundLB` section with the desired settings.
14+
15+
Here is an example of configuring a control plane outbound load balancer with 1 front end ip for a private cluster:
16+
17+
```yaml
18+
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha4
19+
kind: AzureCluster
20+
metadata:
21+
name: my-private-cluster
22+
namespace: default
23+
spec:
24+
location: eastus
25+
networkSpec:
26+
apiServerLB:
27+
type: Internal
28+
controlPlaneOutboundLB:
29+
frontendIPsCount: 1
30+
```
31+
32+
<aside class="note warning">
33+
34+
<h1> Warning </h1>
35+
36+
The field `controlPlaneOutboundLB` cannot be modified after cluster creation. Trying to do so will result in a validation error.
37+
38+
</aside>

0 commit comments

Comments
 (0)