Load provider definition dynamically

Author: s3rj1k

.gitignore

@@ -31,3 +31,6 @@ vendor
 
 # mkdocs folder
 mkdocs
+
+# Loadable providers
+templates/provider/kcm/files/

Dockerfile

@@ -30,6 +30,7 @@ RUN go mod download
 COPY cmd/main.go cmd/main.go
 COPY api/ api/
 COPY internal/ internal/
+COPY providers/ providers/
 
 # Build
 # the GOARCH has not a default value to allow the binary be built according to the host where the command

Makefile

@@ -149,8 +149,13 @@ $(IMAGES_PACKAGE_DIR): | $(LOCALBIN)
 
 TEMPLATE_FOLDERS = $(patsubst $(TEMPLATES_DIR)/%,%,$(wildcard $(TEMPLATES_DIR)/*))
 
+.PHONY: load-providers
+load-providers:
+	@mkdir -p $(PROVIDER_TEMPLATES_DIR)/kcm/files/providers
+	@cp -a providers/*.yml $(PROVIDER_TEMPLATES_DIR)/kcm/files/providers/
+
 .PHONY: helm-package
-helm-package: $(CHARTS_PACKAGE_DIR) $(EXTENSION_CHARTS_PACKAGE_DIR) helm
+helm-package: $(CHARTS_PACKAGE_DIR) $(EXTENSION_CHARTS_PACKAGE_DIR) helm load-providers
 	@make $(patsubst %,package-%-tmpl,$(TEMPLATE_FOLDERS))
 
 package-%-tmpl:
@@ -226,7 +231,11 @@ endif
 .PHONY: kind-deploy
 kind-deploy: kind
 	@if ! $(KIND) get clusters | grep -q "^$(KIND_CLUSTER_NAME)$$"; then \
-		$(KIND) create cluster -n $(KIND_CLUSTER_NAME); \
+		if [ -n "$(KIND_CONFIG_PATH)" ]; then \
+			$(KIND) create cluster -n $(KIND_CLUSTER_NAME) --config "$(KIND_CONFIG_PATH)"; \
+		else \
+			$(KIND) create cluster -n $(KIND_CLUSTER_NAME); \
+		fi \
 	fi
 
 .PHONY: kind-undeploy

cmd/main.go

@@ -17,7 +17,9 @@ package main
 import (
 	"crypto/tls"
 	"flag"
+	"fmt"
 	"os"
+	"strings"
 
 	hcv2 "github.com/fluxcd/helm-controller/api/v2"
 	sourcev1 "github.com/fluxcd/source-controller/api/v1"
@@ -37,8 +39,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
 	kcmv1 "github.com/K0rdent/kcm/api/v1alpha1"
+	"github.com/K0rdent/kcm/internal/build"
 	"github.com/K0rdent/kcm/internal/controller"
 	"github.com/K0rdent/kcm/internal/helm"
+	"github.com/K0rdent/kcm/internal/providers"
 	"github.com/K0rdent/kcm/internal/telemetry"
 	"github.com/K0rdent/kcm/internal/utils"
 	kcmwebhook "github.com/K0rdent/kcm/internal/webhook"
@@ -115,6 +119,24 @@ func main() {
 		Development: true,
 	}
 	opts.BindFlags(flag.CommandLine)
+
+	flag.Usage = func() {
+		var defaultUsage strings.Builder
+		{
+			oldOutput := flag.CommandLine.Output()
+			flag.CommandLine.SetOutput(&defaultUsage)
+			flag.PrintDefaults()
+			flag.CommandLine.SetOutput(oldOutput)
+		}
+
+		_, _ = fmt.Fprintf(os.Stderr, "Usage of %s:\n", os.Args[0])
+		_, _ = fmt.Fprint(os.Stderr, defaultUsage.String())
+		_, _ = fmt.Fprintf(os.Stderr, "\nSupported providers:\n")
+		for _, el := range providers.List() {
+			_, _ = fmt.Fprintf(os.Stderr, "  - %s\n", el)
+		}
+		_, _ = fmt.Fprintf(os.Stderr, "\nVersion: %s\n", build.Version)
+	}
 	flag.Parse()
 
 	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

config/dev/aks-credentials.yaml

@@ -25,3 +25,13 @@ spec:
     kind: Secret
     name: azure-aks-credential
     namespace: ${NAMESPACE}
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: azure-cluster-identity-resource-template
+  namespace: ${NAMESPACE}
+  labels:
+    k0rdent.mirantis.com/component: "kcm"
+  annotations:
+    projectsveltos.io/template: "true"

config/dev/aws-credentials.yaml

@@ -37,3 +37,13 @@ spec:
     kind: AWSClusterStaticIdentity
     name: aws-cluster-identity
     namespace: ${NAMESPACE}
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: aws-cluster-identity-resource-template
+  namespace: ${NAMESPACE}
+  labels:
+    k0rdent.mirantis.com/component: "kcm"
+  annotations:
+    projectsveltos.io/template: "true"

internal/providers/azure.go internal/projectroot/path.go

@@ -12,28 +12,20 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package providers
+package projectroot
 
 import (
-	"k8s.io/apimachinery/pkg/runtime/schema"
+	"path/filepath"
+	"runtime"
 )
 
-type ProviderAzure struct{}
+// WARNING: This path resolution is dependent on the source file's location
+// in the project structure. Moving this file to a different directory will
+// change the resolved path. When refactoring or restructuring the project,
+// ensure to update this path resolution accordingly.
+var (
+	_, b, _, _ = runtime.Caller(0)
 
-var _ ProviderModule = (*ProviderAzure)(nil)
-
-func init() {
-	Register(&ProviderAzure{})
-}
-
-func (*ProviderAzure) GetName() string {
-	return "azure"
-}
-
-func (*ProviderAzure) GetClusterGVK() schema.GroupVersionKind {
-	return schema.GroupVersionKind{}
-}
-
-func (*ProviderAzure) GetClusterIdentityKinds() []string {
-	return []string{"AzureClusterIdentity"}
-}
+	// Path is root folder of this project.
+	Path = filepath.Join(filepath.Dir(b), "../..")
+)

internal/providers/aws.go

@@ -15,25 +15,30 @@
 package providers
 
 import (
-	"k8s.io/apimachinery/pkg/runtime/schema"
-)
+	"cmp"
+	"fmt"
+	"os"
+	"path/filepath"
+	"testing"
 
-type ProvidervSphere struct{}
+	"github.com/K0rdent/kcm/internal/projectroot"
+)
 
-var _ ProviderModule = (*ProvidervSphere)(nil)
+const EnvProvidersPathGlob = "PROVIDERS_PATH_GLOB"
 
 func init() {
-	Register(&ProvidervSphere{})
-}
+	var baseDir string
 
-func (*ProvidervSphere) GetName() string {
-	return "vsphere"
-}
+	if testing.Testing() {
+		baseDir = projectroot.Path
+	}
 
-func (*ProvidervSphere) GetClusterGVK() schema.GroupVersionKind {
-	return schema.GroupVersionKind{}
-}
+	providersGlob := cmp.Or(
+		os.Getenv(EnvProvidersPathGlob),
+		filepath.Join(baseDir, "providers", "*.yml"),
+	)
 
-func (*ProvidervSphere) GetClusterIdentityKinds() []string {
-	return []string{"VSphereClusterIdentity"}
+	if err := RegisterProvidersFromGlob(providersGlob); err != nil {
+		panic(fmt.Sprintf("failed to register providers: %v", err))
+	}
 }

internal/providers/vsphere.go internal/providers/loader.go

@@ -0,0 +1,91 @@
+// Copyright 2024
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package providers
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"slices"
+
+	"gopkg.in/yaml.v3"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+// GVK represents the GroupVersionKind structure in YAML.
+type GVK struct {
+	Group   string `yaml:"group"`
+	Version string `yaml:"version"`
+	Kind    string `yaml:"kind"`
+}
+
+// YAMLProviderDefinition represents a YAML-based provider configuration.
+type YAMLProviderDefinition struct {
+	Name                 string   `yaml:"name"`
+	ClusterGVK           GVK      `yaml:"clusterGVK"`
+	ClusterIdentityKinds []string `yaml:"clusterIdentityKinds"`
+}
+
+var _ ProviderModule = (*YAMLProviderDefinition)(nil)
+
+func (p *YAMLProviderDefinition) GetName() string {
+	return p.Name
+}
+
+func (p *YAMLProviderDefinition) GetClusterGVK() schema.GroupVersionKind {
+	return schema.GroupVersionKind{
+		Group:   p.ClusterGVK.Group,
+		Version: p.ClusterGVK.Version,
+		Kind:    p.ClusterGVK.Kind,
+	}
+}
+
+func (p *YAMLProviderDefinition) GetClusterIdentityKinds() []string {
+	return slices.Clone(p.ClusterIdentityKinds)
+}
+
+// RegisterFromYAML registers a provider from a YAML file.
+func RegisterFromYAML(yamlFile string) error {
+	data, err := os.ReadFile(yamlFile)
+	if err != nil {
+		return fmt.Errorf("failed to read YAML file: %w", err)
+	}
+
+	var ypd YAMLProviderDefinition
+
+	if err := yaml.Unmarshal(data, &ypd); err != nil {
+		return fmt.Errorf("failed to unmarshal YAML: %w", err)
+	}
+
+	Register(&ypd)
+
+	return nil
+}
+
+// RegisterProvidersFromGlob loads and registers provider YAML files matching the glob pattern.
+func RegisterProvidersFromGlob(pattern string) error {
+	matches, err := filepath.Glob(pattern)
+	if err != nil {
+		return fmt.Errorf("failed to glob pattern %q: %w", pattern, err)
+	}
+
+	for _, file := range matches {
+		if err := RegisterFromYAML(file); err != nil {
+			return fmt.Errorf("provider %s: %w", filepath.Base(file), err)
+		}
+	}
+
+	return nil
+}