Skip to content

Allow configuring API server LB rule name and health probe in AzureCluster #5828

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+696 −78
Open

Allow configuring API server LB rule name and health probe in AzureCluster #5828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions api/v1beta1/azurecluster_default.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ const (
DefaultOutboundRuleIdleTimeoutInMinutes = 4
// DefaultAzureCloud is the public cloud that will be used by most users.
DefaultAzureCloud = "AzurePublicCloud"
// DefaultLoadBalancingRuleName is the default load balancer rule name.
DefaultLoadBalancingRuleName = "LBRuleHTTPS"
// DefaultHealthProbeName is the default health probe name.
DefaultHealthProbeName = "HTTPSProbe"
)

func (c *AzureCluster) setDefaults() {
Expand Down Expand Up @@ -303,6 +307,13 @@ func (c *AzureCluster) setAPIServerLBDefaults() {
}
}
c.SetAPIServerLBBackendPoolNameDefault()

if lb.LoadBalancingRule.Name == "" {
lb.LoadBalancingRule.Name = DefaultLoadBalancingRuleName
}
if lb.HealthProbe.Name == "" {
lb.HealthProbe.Name = DefaultHealthProbeName
}
}

// SetNodeOutboundLBDefaults sets the default values for the NodeOutboundLB.
Expand Down
171 changes: 169 additions & 2 deletions api/v1beta1/azurecluster_default_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,14 @@ func TestVnetDefaults(t *testing.T) {
},
},
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,

SKU: SKUStandard,
Type: Public,
},
},
Expand Down Expand Up @@ -1321,6 +1326,12 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "cluster-test-public-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Public,
Expand Down Expand Up @@ -1370,6 +1381,12 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "cluster-test-public-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Public,
Expand Down Expand Up @@ -1414,6 +1431,12 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "cluster-test-internal-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Internal,
Expand Down Expand Up @@ -1460,6 +1483,12 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "cluster-test-internal-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Internal,
Expand Down Expand Up @@ -1508,6 +1537,12 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "custom-backend-pool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Internal,
Expand Down Expand Up @@ -1557,6 +1592,12 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "custom-backend-pool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Internal,
Expand Down Expand Up @@ -1630,6 +1671,132 @@ func TestAPIServerLBDefaults(t *testing.T) {
BackendPool: BackendPool{
Name: "cluster-test-public-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Public,
IdleTimeoutInMinutes: ptr.To[int32](DefaultOutboundRuleIdleTimeoutInMinutes),
},
},
},
},
},
},
{
name: "load balancer with custom rule and probe names",
cluster: &AzureCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "cluster-test",
},
Spec: AzureClusterSpec{
ControlPlaneEnabled: true,
NetworkSpec: NetworkSpec{
APIServerLB: &LoadBalancerSpec{
LoadBalancingRule: LoadBalancingRule{
Name: "CustomLBRule",
},
HealthProbe: HealthProbe{
Name: "CustomProbe",
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
Type: Public,
},
},
},
},
},
output: &AzureCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "cluster-test",
},
Spec: AzureClusterSpec{
ControlPlaneEnabled: true,
NetworkSpec: NetworkSpec{
APIServerLB: &LoadBalancerSpec{
Name: "cluster-test-public-lb",
FrontendIPs: []FrontendIP{
{
Name: "cluster-test-public-lb-frontEnd",
PublicIP: &PublicIPSpec{
Name: "pip-cluster-test-apiserver",
DNSName: "",
},
},
},
BackendPool: BackendPool{
Name: "cluster-test-public-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: "CustomLBRule",
},
HealthProbe: HealthProbe{
Name: "CustomProbe",
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Public,
IdleTimeoutInMinutes: ptr.To[int32](DefaultOutboundRuleIdleTimeoutInMinutes),
},
},
},
},
},
},
{
name: "load balancer with empty rule and probe names should use defaults",
cluster: &AzureCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "cluster-test",
},
Spec: AzureClusterSpec{
ControlPlaneEnabled: true,
NetworkSpec: NetworkSpec{
APIServerLB: &LoadBalancerSpec{
LoadBalancingRule: LoadBalancingRule{
Name: "",
},
HealthProbe: HealthProbe{
Name: "",
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
Type: Public,
},
},
},
},
},
output: &AzureCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "cluster-test",
},
Spec: AzureClusterSpec{
ControlPlaneEnabled: true,
NetworkSpec: NetworkSpec{
APIServerLB: &LoadBalancerSpec{
Name: "cluster-test-public-lb",
FrontendIPs: []FrontendIP{
{
Name: "cluster-test-public-lb-frontEnd",
PublicIP: &PublicIPSpec{
Name: "pip-cluster-test-apiserver",
DNSName: "",
},
},
},
BackendPool: BackendPool{
Name: "cluster-test-public-lb-backendPool",
},
LoadBalancingRule: LoadBalancingRule{
Name: DefaultLoadBalancingRuleName,
},
HealthProbe: HealthProbe{
Name: DefaultHealthProbeName,
},
LoadBalancerClassSpec: LoadBalancerClassSpec{
SKU: SKUStandard,
Type: Public,
Expand Down
34 changes: 24 additions & 10 deletions api/v1beta1/azurecluster_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,11 @@ func validateSecurityRule(rule SecurityRule, fldPath *field.Path) (allErrs field
return allErrs
}

func validateAPIServerLB(lb *LoadBalancerSpec, old *LoadBalancerSpec, cidrs []string, fldPath *field.Path) field.ErrorList {
func immutableAzureClusterFieldError(fldPath *field.Path, fieldName string) *field.Error {
return field.Forbidden(fldPath, fmt.Sprintf("%s should not be modified after AzureCluster creation.", fieldName))
}

func validateAPIServerLB(lb, old *LoadBalancerSpec, cidrs []string, fldPath *field.Path) field.ErrorList {
var allErrs field.ErrorList

lbClassSpec := lb.LoadBalancerClassSpec
Expand All @@ -406,9 +410,19 @@ func validateAPIServerLB(lb *LoadBalancerSpec, old *LoadBalancerSpec, cidrs []st
if err := validateLoadBalancerName(lb.Name, fldPath.Child("name")); err != nil {
allErrs = append(allErrs, err)
}
// Name should be immutable.
if old != nil && old.Name != "" && old.Name != lb.Name {
allErrs = append(allErrs, field.Forbidden(fldPath.Child("name"), "API Server load balancer name should not be modified after AzureCluster creation."))
if old != nil {
// Name should be immutable.
if old.Name != "" && old.Name != lb.Name {
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath, "API Server load balancer name"))
}
if (old.LoadBalancingRule.Name != "" && old.LoadBalancingRule.Name != lb.LoadBalancingRule.Name) ||
(old.LoadBalancingRule.Name == "" && lb.LoadBalancingRule.Name != DefaultLoadBalancingRuleName) {
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath.Child("loadBalancingRule").Child("name"), "Load balancer rule name"))
}
if (old.HealthProbe.Name != "" && old.HealthProbe.Name != lb.HealthProbe.Name) ||
(old.HealthProbe.Name == "" && lb.HealthProbe.Name != DefaultHealthProbeName) {
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath.Child("healthProbe").Child("name"), "Health probe name"))
}
}

publicIPCount, privateIPCount := 0, 0
Expand Down Expand Up @@ -458,7 +472,7 @@ func validateAPIServerLB(lb *LoadBalancerSpec, old *LoadBalancerSpec, cidrs []st
}

if old != nil && len(old.FrontendIPs) != 0 && old.FrontendIPs[0].PrivateIPAddress != lb.FrontendIPs[0].PrivateIPAddress {
allErrs = append(allErrs, field.Forbidden(fldPath.Child("name"), "API Server load balancer private IP should not be modified after AzureCluster creation."))
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath.Child("name"), "API Server load balancer private IP"))
}
}
}
Expand All @@ -484,11 +498,11 @@ func validateNodeOutboundLB(lb *LoadBalancerSpec, old *LoadBalancerSpec, apiserv
}

if old != nil && old.ID != lb.ID {
allErrs = append(allErrs, field.Forbidden(fldPath.Child("id"), "Node outbound load balancer ID should not be modified after AzureCluster creation."))
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath.Child("id"), "Node outbound load balancer ID"))
}

if old != nil && old.Name != lb.Name {
allErrs = append(allErrs, field.Forbidden(fldPath.Child("name"), "Node outbound load balancer Name should not be modified after AzureCluster creation."))
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath.Child("name"), "Node outbound load balancer Name"))
}

if old != nil && old.FrontendIPsCount == lb.FrontendIPsCount {
Expand Down Expand Up @@ -598,12 +612,12 @@ func validateClassSpecForAPIServerLB(lb LoadBalancerClassSpec, old *LoadBalancer

// SKU should be immutable.
if old != nil && old.SKU != "" && old.SKU != lb.SKU {
allErrs = append(allErrs, field.Forbidden(apiServerLBPath.Child("sku"), "API Server load balancer SKU should not be modified after AzureCluster creation."))
allErrs = append(allErrs, immutableAzureClusterFieldError(apiServerLBPath.Child("sku"), "API Server load balancer SKU"))
}

// Type should be immutable.
if old != nil && old.Type != "" && old.Type != lb.Type {
allErrs = append(allErrs, field.Forbidden(apiServerLBPath.Child("type"), "API Server load balancer type should not be modified after AzureCluster creation."))
allErrs = append(allErrs, immutableAzureClusterFieldError(apiServerLBPath.Child("type"), "API Server load balancer type"))
}

// IdletimeoutInMinutes should be immutable.
Expand Down Expand Up @@ -633,7 +647,7 @@ func validateClassSpecForNodeOutboundLB(lb *LoadBalancerClassSpec, old *LoadBala
}

if old != nil && old.SKU != lb.SKU {
allErrs = append(allErrs, field.Forbidden(fldPath.Child("sku"), "Node outbound load balancer SKU should not be modified after AzureCluster creation."))
allErrs = append(allErrs, immutableAzureClusterFieldError(fldPath.Child("sku"), "Node outbound load balancer SKU"))
}

if old != nil && old.Type != lb.Type {
Expand Down
Loading
Loading