-
Notifications
You must be signed in to change notification settings - Fork 431
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Node Outbound Load Balancer | ||
|
||
This document describes how to configure your clusters' node outbound load balancer. | ||
|
||
### Public Clusters | ||
|
||
For public clusters ie. clusters with api server load balancer type set to `Public`, CAPZ automatically configures a node outbound load balancer with the default settings. | ||
|
||
To provider custom settings for the node outbound load balacer, use the `nodeOutboundLB` section in cluster configuration. | ||
|
||
Here is an example of a node outbound load balancer with `frontendIPsCount` set to 3. CAPZ will read this value and create 3 front end ips for this load balancer. | ||
|
||
```yaml | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha4 | ||
kind: AzureCluster | ||
metadata: | ||
name: my-public-cluster | ||
namespace: default | ||
spec: | ||
location: eastus | ||
networkSpec: | ||
apiServerLB: | ||
type: Public | ||
nodeOutboundLB: | ||
frontendIPsCount: 3 | ||
``` | ||
<aside class="note warning"> | ||
<h1> Warning </h1> | ||
Only `frontendIPsCount` is allowed to be configured for any node outbound load balancer. Trying to modify any other value will result in a validation error. | ||
|
||
</aside> | ||
|
||
### Private Clusters | ||
|
||
For private clusters ie. clusters with api server load balancer type set to `Internal`, CAPZ does not create a node outbound load balancer by default. | ||
To create a node outbound load balancer, include the `nodeOutboundLB` section with the desired settings. | ||
|
||
Here is an example of configuring a node outbound load balancer with 1 front end ip for a private cluster: | ||
|
||
```yaml | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha4 | ||
kind: AzureCluster | ||
metadata: | ||
name: my-public-cluster | ||
namespace: default | ||
spec: | ||
location: eastus | ||
networkSpec: | ||
apiServerLB: | ||
type: Internal | ||
nodeOutboundLB: | ||
frontendIPsCount: 1 | ||
``` | ||
|
||
<aside class="note warning"> | ||
|
||
<h1> Warning </h1> | ||
|
||
Only `frontendIPsCount` is allowed to be configured for any node outbound load balancer. Trying to modify any other value will result in a validation error. | ||
|
||
</aside> |