feat: CNI provider deployment via variables instead of labels

Author: jimmidyson

api/v1alpha1/clusterconfig_types.go

@@ -7,9 +7,14 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 
+	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/openapi/patterns"
 )
 
+const (
+	CNIProviderCalico = "calico"
+)
+
 //+kubebuilder:object:root=true
 
 // ClusterConfig is the Schema for the clusterconfigs API.
@@ -33,6 +38,9 @@ type ClusterConfigSpec struct {
 
 	// +optional
 	ExtraAPIServerCertSANs ExtraAPIServerCertSANs `json:"extraAPIServerCertSANs,omitempty"`
+
+	// +optional
+	CNI *CNI `json:"cni,omitempty"`
 }
 
 func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
@@ -47,6 +55,7 @@ func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
 					OpenAPIV3Schema,
 				"proxy":                  HTTPProxy{}.VariableSchema().OpenAPIV3Schema,
 				"extraAPIServerCertSANs": ExtraAPIServerCertSANs{}.VariableSchema().OpenAPIV3Schema,
+				"cni":                    CNI{}.VariableSchema().OpenAPIV3Schema,
 			},
 		},
 	}
@@ -128,6 +137,33 @@ func (ExtraAPIServerCertSANs) VariableSchema() clusterv1.VariableSchema {
 	}
 }
 
+// CNI required for providing CNI configuration.
+type CNI struct {
+	Provider string `json:"provider,omitempty"`
+}
+
+func (CNI) VariableSchema() clusterv1.VariableSchema {
+	supportedCNIProviders := []string{CNIProviderCalico}
+
+	cniProviderEnumVals, err := variables.ValuesToEnumJSON(supportedCNIProviders...)
+	if err != nil {
+		panic(err)
+	}
+
+	return clusterv1.VariableSchema{
+		OpenAPIV3Schema: clusterv1.JSONSchemaProps{
+			Type: "object",
+			Properties: map[string]clusterv1.JSONSchemaProps{
+				"provider": {
+					Description: "CNI provider to deploy",
+					Type:        "string",
+					Enum:        cniProviderEnumVals,
+				},
+			},
+		},
+	}
+}
+
 // +kubebuilder:object:root=true
 func init() {
 	SchemeBuilder.Register(&ClusterConfig{})

api/v1alpha1/zz_generated.deepcopy.go

@@ -29,15 +29,10 @@ spec:
         imagePullPolicy: "{{ .Values.image.pullPolicy }}"
         args:
         - --webhook-cert-dir=/runtimehooks-certs/
-        - --calicocni.defaultsNamespace=$(POD_NAMESPACE)
+        - --calicocni.defaultsNamespace={{ .Release.Namespace }}
         {{- range $key, $value := .Values.extraArgs }}
         - --{{ $key }}={{ $value }}
         {{- end }}
-        env:
-        - name: POD_NAMESPACE
-          valueFrom:
-            fieldRef:
-              fieldPath: metadata.namespace
 {{- if .Values.env }}
 {{- range $key, $value := .Values.env }}
         - name: "{{ $key }}"

charts/capi-runtime-extensions/templates/deployment.yaml

@@ -116,7 +116,7 @@ func main() {
 
 		servicelbgc.New(mgr.GetClient()),
 
-		calico.New(mgr.GetClient(), calicoCNIConfig),
+		calico.New(mgr.GetClient(), calicoCNIConfig, clusterconfig.VariableName, "cni"),
 
 		httpproxy.NewVariable(),
 		httpproxy.NewPatch(mgr.GetClient(), httpproxy.VariableName),

cmd/main.go

@@ -0,0 +1,25 @@
+// Copyright 2023 D2iQ, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package variables
+
+import (
+	"encoding/json"
+	"fmt"
+
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+)
+
+func ValuesToEnumJSON[T any](vals ...T) ([]apiextensionsv1.JSON, error) {
+	enumJSON := make([]apiextensionsv1.JSON, 0, len(vals))
+
+	for _, v := range vals {
+		enumVal, err := json.Marshal(v)
+		if err != nil {
+			return nil, fmt.Errorf("failed to marshal enum value: %v", v)
+		}
+		enumJSON = append(enumJSON, apiextensionsv1.JSON{Raw: enumVal})
+	}
+
+	return enumJSON, nil
+}

common/pkg/capi/clustertopology/variables/enums.go

@@ -0,0 +1,71 @@
+// Copyright 2023 D2iQ, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+package variables
+
+import (
+	"testing"
+
+	"github.com/onsi/gomega"
+)
+
+func TestValuesToEnumJSON(t *testing.T) {
+	t.Parallel()
+
+	testCases := []struct {
+		name     string
+		input    []interface{}
+		expected []interface{}
+	}{{
+		name:     "Empty input",
+		input:    []any{},
+		expected: []interface{}{},
+	}, {
+		name:     "Single value",
+		input:    []any{"value1"},
+		expected: []interface{}{`"value1"`},
+	}, {
+		name:     "Multiple values",
+		input:    []interface{}{"value1", "value2", "value3"},
+		expected: []interface{}{`"value1"`, `"value2"`, `"value3"`},
+	}, {
+		name:     "Multiple integer values",
+		input:    []interface{}{1, 2, 3},
+		expected: []interface{}{`1`, `2`, `3`},
+	}, {
+		name:     "Multiple integer array values",
+		input:    []interface{}{[]int{1, 2}, []int{2, 3}, []int{49, 64}},
+		expected: []interface{}{`[1,2]`, `[2,3]`, `[49,64]`},
+	}, {
+		name: "Multiple string array values",
+		input: []interface{}{
+			[]string{"value1", "value2"},
+			[]string{"value2", "value3"},
+			[]string{"value49", "value64"},
+		},
+		expected: []interface{}{
+			`["value1","value2"]`,
+			`["value2","value3"]`,
+			`["value49","value64"]`,
+		},
+	}}
+
+	for i := range testCases {
+		tt := testCases[i]
+
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			g := gomega.NewWithT(t)
+
+			// Call the function under test
+			jsonData, err := ValuesToEnumJSON(tt.input...)
+			g.Expect(err).NotTo(gomega.HaveOccurred())
+
+			// Assert the result
+			g.Expect(jsonData).To(gomega.HaveLen(len(tt.expected)))
+			for i, expected := range tt.expected {
+				g.Expect(string(jsonData[i].Raw)).To(gomega.Equal(expected))
+			}
+		})
+	}
+}

common/pkg/capi/clustertopology/variables/eums_test.go

@@ -8,6 +8,7 @@ import (
 
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/exp/runtime/topologymutation"
 )
 
@@ -45,3 +46,21 @@ func Get[T any](
 	err = json.Unmarshal(jsonValue, &value)
 	return value, err == nil, err
 }
+
+// ClusterVariablesToVariablesMap converts a list of ClusterVariables to a map of JSON (name is the map key).
+// See: https://github.com/kubernetes-sigs/cluster-api/blob/v1.5.1/internal/controllers/topology/cluster/patches/variables/variables.go#L445
+//
+//nolint:lll // Long URLs in comments above. Adding nolint:lll here because it doesn't work in comment lines. See: https://github.com/golangci/golangci-lint/issues/3983
+func ClusterVariablesToVariablesMap(
+	variables []v1beta1.ClusterVariable,
+) map[string]apiextensionsv1.JSON {
+	if variables == nil {
+		return nil
+	}
+
+	variablesMap := make(map[string]apiextensionsv1.JSON, len(variables))
+	for i := range variables {
+		variablesMap[variables[i].Name] = variables[i].Value
+	}
+	return variablesMap
+}