Feat/lb alternative names (#1693)

Closes #1662


Adds alternative names support to claudie. This PR only implements the
support at the input manifest level and the terraform service.

The templates that claudie uses will have to be adjusted individually.

The templates can use the following pattern to check if the alternative
names extension is used or not

```
	// {{- if hasExtension .Data "AlternativeNamesExtension"}}
	// ... access .AlternativeNamesExtension
	// {{- end }}
```

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: CI/CD pipeline <CI/CD-pipeline@users.noreply.github.com>

Author: 3 people

Makefile

@@ -1,7 +1,7 @@
 .PHONY: proto manager builder terraformer ansibler kubeEleven test database minio containerimgs crd crd-apply controller-gen kind-load-images
 
 # Enforce same version of protoc 
-PROTOC_VERSION = "27.1"
+PROTOC_VERSION = "29.3"
 CURRENT_VERSION = $$(protoc --version | awk '{print $$2}')
 # Generate all .proto files 
 proto:

internal/clusters/ping4_test.go

@@ -236,13 +236,7 @@ func TestPingAll(t *testing.T) {
 			}
 
 			for _, got := range got {
-				found := false
-				for _, want := range tt.want {
-					if want == got {
-						found = true
-						break
-					}
-				}
+				found := slices.Contains(tt.want, got)
 				if !found {
 					t.Fatalf("pingAll() got %v missing in want %v", got, tt.want)
 				}

internal/manifest/manifest.go

@@ -297,5 +297,12 @@ type DNS struct {
 	Provider string `validate:"required" yaml:"provider" json:"provider"`
 	// Custom hostname for your A record. If left empty, the hostname will be a random hash.
 	Hostname string `yaml:"hostname,omitempty" json:"hostname,omitempty"`
-	// Templates for setting up the DNS. (optional)
+	// Alternative names that will be created in addition to the hostname. Giving the ability
+	// to have a loadbalancer for multiple hostnames.
+	//
+	// - api.example.com
+	//
+	// - apiv2.example.com
+	// +optional
+	AlternativeNames []string `validate:"dive,required" yaml:"alternativeNames,omitempty" json:"alternativeNames,omitempty"`
 }

internal/manifest/validate_load_balancer.go

@@ -100,7 +100,10 @@ func (l *LoadBalancer) Validate(m *Manifest) error {
 			if role == apiServerRole.Name {
 				// check if this is an ApiServer LB and another ApiServer LB already exists.
 				if apiServerLBExists[cluster.TargetedK8s] {
-					return fmt.Errorf("role %q is used across multiple Load-Balancers for k8s-cluster %s. Can have only one ApiServer Load-Balancer per k8s-cluster", role, cluster.TargetedK8s)
+					return fmt.Errorf("role %q is used across multiple load-balancers for k8s-cluster %s. Can have only one kubeapi-server load-balancer per k8s-cluster", role, cluster.TargetedK8s)
+				}
+				if len(cluster.DNS.AlternativeNames) > 0 {
+					return fmt.Errorf("cannot have alternative names for the kubeapi-server load-balancer cluster %q", cluster.Name)
 				}
 
 				// this is the first LB that uses the ApiServer role.
@@ -123,6 +126,22 @@ func (l *LoadBalancer) Validate(m *Manifest) error {
 			}
 		}
 
+		// check if alternative names are unique
+		seen := make(map[string]struct{})
+		for _, n := range cluster.DNS.AlternativeNames {
+			if _, ok := seen[n]; ok {
+				return fmt.Errorf("duplicate alternative names %q specified in cluster %q, must be unique", n, cluster.Name)
+			}
+			if cluster.DNS.Hostname != "" && n == cluster.DNS.Hostname {
+				return fmt.Errorf("alternative name %q has the same value as hostname %q in cluster %q, must be unique", n, cluster.DNS.Hostname, cluster.Name)
+			}
+			if zone, ok := hostnamesPerDNS[n]; ok && zone == cluster.DNS.DNSZone {
+				return fmt.Errorf("alternative name %q used in cluster %q is used across multiple clusters for the same DNS zone %q, must be unique", n, cluster.Name, zone)
+			}
+			seen[n] = struct{}{}
+			hostnamesPerDNS[n] = cluster.DNS.DNSZone
+		}
+
 		// check if the requested hostname is unique per DNS-ZONE
 		if zone, ok := hostnamesPerDNS[cluster.DNS.Hostname]; ok && zone == cluster.DNS.DNSZone {
 			return fmt.Errorf("hostname %q used in cluster %q is used across multiple clusters for the same DNS zone %q, must be unique", cluster.DNS.Hostname, cluster.Name, zone)

internal/spectesting/spec_definitions.go

@@ -589,16 +589,8 @@ const (
 func AddNodes(count int, ci *spec.ClusterInfo, typ NodeFilter) map[string][]string {
 	affected := make(map[string][]string)
 
-	var dyn []*spec.NodePool
-	var stat []*spec.NodePool
-
-	for i := range ci.NodePools {
-		if ci.NodePools[i].GetStaticNodePool() != nil {
-			stat = append(stat, ci.NodePools[i])
-		} else {
-			dyn = append(dyn, ci.NodePools[i])
-		}
-	}
+	dyn := nodepools.Dynamic(ci.NodePools)
+	stat := nodepools.Static(ci.NodePools)
 
 	if len(dyn) == 0 {
 		panic("no dynamic nodepools")

internal/templateUtils/templates.go

@@ -6,6 +6,7 @@ import (
 	"net"
 	"os"
 	"path/filepath"
+	"reflect"
 	"strings"
 	"text/template"
 )
@@ -53,6 +54,7 @@ func LoadTemplate(tplFile string) (*template.Template, error) {
 		"replaceAll":             strings.ReplaceAll,
 		"trimPrefix":             strings.TrimPrefix,
 		"extractNetmaskFromCIDR": ExtractNetmaskFromCIDR,
+		"hasExtension":           HasExtension,
 	}).Parse(tplFile)
 	if err != nil {
 		return nil, fmt.Errorf("failed to parse the template file : %w", err)
@@ -70,3 +72,30 @@ func ExtractNetmaskFromCIDR(cidr string) string {
 	ones, _ := n.Mask.Size()
 	return fmt.Sprintf("%v", ones)
 }
+
+// HasExtensions check whether data is a struct and has the specified 'field', followed
+// by a check if the 'field' has a value.
+func HasExtension(data any, field string) bool {
+	// check that the struct 'field' exists within 'data'
+	rv := reflect.ValueOf(data)
+	for rv.Kind() == reflect.Pointer || rv.Kind() == reflect.Interface {
+		rv = rv.Elem()
+	}
+	if rv.Kind() != reflect.Struct {
+		return false
+	}
+
+	val := rv.FieldByName(field)
+	if !val.IsValid() {
+		return false
+	}
+
+	// check if the 'field' has a value.
+	for val.Kind() == reflect.Pointer || val.Kind() == reflect.Interface {
+		if val.IsZero() {
+			return false
+		}
+		val = val.Elem()
+	}
+	return true
+}

internal/templateUtils/templates_test.go

@@ -0,0 +1,98 @@
+package templateUtils
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestHasExtension(t *testing.T) {
+	type V1 struct {
+		Field1 string
+		Field2 string
+	}
+	type V2 struct {
+		Field3 string
+		Field4 string
+	}
+
+	type Base struct {
+		Base  string
+		Base1 []string
+		Base2 struct{ a, b, v string }
+	}
+
+	type ExtendedV1 struct {
+		Base
+		V1
+	}
+
+	type ExtendedV1_ struct {
+		*Base
+		Extension *V1
+	}
+
+	type ExtendedV2 struct {
+		Base
+		V1
+		V2
+	}
+
+	assert.True(t, HasExtension(Base{}, "Base"))
+	assert.False(t, HasExtension(Base{}, "V1"))
+
+	l1 := &ExtendedV1{}
+	l2 := &l1
+	l3 := &l2
+	l4 := &l3
+
+	assert.False(t, HasExtension(ExtendedV1{}, "V2"))
+	assert.True(t, HasExtension(ExtendedV1{}, "V1"))
+	assert.True(t, HasExtension(ExtendedV1{}, "Base"))
+	assert.True(t, HasExtension(ExtendedV1{}, "Base"))
+	assert.True(t, HasExtension(l4, "Base"))
+	assert.True(t, HasExtension(l4, "V1"))
+	assert.True(t, HasExtension(l4, "Field1"))
+	assert.False(t, HasExtension(l4, "V2"))
+
+	l5 := &ExtendedV2{Base: l1.Base, V1: l1.V1}
+
+	assert.True(t, HasExtension(ExtendedV2{}, "V2"))
+	assert.True(t, HasExtension(ExtendedV2{}, "V1"))
+	assert.True(t, HasExtension(ExtendedV2{}, "Base"))
+	assert.True(t, HasExtension(ExtendedV2{}, "Base"))
+	assert.True(t, HasExtension(l5, "Base"))
+	assert.True(t, HasExtension(l5, "V1"))
+	assert.True(t, HasExtension(l5, "Field1"))
+	assert.True(t, HasExtension(l5, "Field3"))
+	assert.True(t, HasExtension(l5, "Field4"))
+	assert.True(t, HasExtension(l5, "V2"))
+	assert.True(t, HasExtension(any(l5), "V2"))
+
+	assert.False(t, HasExtension(any(new(int)), "Base"))
+	assert.False(t, HasExtension(any(nil), "Base"))
+	assert.False(t, HasExtension((*ExtendedV2)(nil), "V2"))
+	assert.False(t, HasExtension(nil, "V2"))
+
+	assert.False(t, HasExtension(new(ExtendedV1_), "Base"))
+	assert.False(t, HasExtension(new(ExtendedV1_), "Extension"))
+	assert.False(t, HasExtension(&ExtendedV1_{Base: new(Base), Extension: nil}, "Extension"))
+	assert.True(t, HasExtension(&ExtendedV1_{Base: new(Base), Extension: nil}, "Base"))
+
+	tmp := new(ExtendedV1_)
+	assert.False(t, HasExtension(tmp, "Extension"))
+	assert.False(t, HasExtension(tmp, "Base"))
+	assert.False(t, HasExtension(tmp.Extension, "Field1"))
+	tmp.Extension = new(V1)
+	assert.True(t, HasExtension(tmp, "Extension"))
+	assert.True(t, HasExtension(tmp.Extension, "Field1"))
+	tmp.Base = new(Base)
+	assert.True(t, HasExtension(tmp, "Base"))
+	assert.True(t, HasExtension(tmp.Base, "Base"))
+	assert.True(t, HasExtension(tmp.Base, "Base1"))
+	assert.True(t, HasExtension(tmp.Base, "Base2"))
+	assert.True(t, HasExtension(tmp.Base.Base2, "a"))
+	assert.False(t, HasExtension(tmp.Base, "Base3"))
+	tmp.Extension = nil
+	assert.False(t, HasExtension(tmp, "Extension"))
+}

manifests/claudie/crd/claudie.io_inputmanifests.yaml

@@ -142,6 +142,15 @@ spec:
                           dns:
                             description: Specification of the loadbalancer's DNS record.
                             properties:
+                              alternativeNames:
+                                description: |-
+                                  Alternative names that will be created in addition to the hostname. Giving the ability
+                                  to have a loadbalancer for multiple hostnames.
+                                  - api.example.com
+                                  - apiv2.example.com
+                                items:
+                                  type: string
+                                type: array
                               dnsZone:
                                 description:
                                   DNS zone inside of which the records will

manifests/claudie/kustomization.yaml

@@ -57,18 +57,18 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 images:
 - name: ghcr.io/berops/claudie/ansibler
-  newTag: 053d895-3305
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/autoscaler-adapter
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/builder
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/claudie-operator
-  newTag: 053d895-3305
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/kube-eleven
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/kuber
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/manager
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306
 - name: ghcr.io/berops/claudie/terraformer
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306

manifests/testing-framework/kustomization.yaml

@@ -90,4 +90,4 @@ secretGenerator:
 
 images:
 - name: ghcr.io/berops/claudie/testing-framework
-  newTag: 52c9e17-3303
+  newTag: 7e30277-3306