feat: template input

Author: robertgraeff

internal/common/constants.go

@@ -8,8 +8,16 @@ const (
 	// The secret is references in the GitRepository resource which establishes the synchronization with the deployment git repository.
 	GitSecretName = "git"
 
-	// Names of ocm resources of the root component
-	FluxcdHelmController      = "fluxcd-helm-controller"
-	FluxcdKustomizeController = "fluxcd-kustomize-controller"
-	FluxcdSourceController    = "fluxcd-source-controller"
+	// Directory names
+	EnvsDirectoryName      = "envs"
+	FluxCDDirectoryName    = "fluxcd"
+	OpenMCPDirectoryName   = "openmcp"
+	ResourcesDirectoryName = "resources"
+	TemplatesDirectoryName = "templates"
+	OverlaysDirectoryName  = "overlays"
+
+	// Resource names
+	FluxCDSourceControllerResourceName        = "fluxcd-source-controller"
+	FluxCDKustomizationControllerResourceName = "fluxcd-kustomize-controller"
+	FluxCDHelmControllerResourceName          = "fluxcd-helm-controller"
 )

internal/flux_deployer/constants.go

@@ -12,7 +12,6 @@ import (
 	"sigs.k8s.io/kustomize/api/krusty"
 	"sigs.k8s.io/kustomize/kyaml/filesys"
 
-	"github.com/openmcp-project/bootstrapper/internal/common"
 	cfg "github.com/openmcp-project/bootstrapper/internal/config"
 	ocmcli "github.com/openmcp-project/bootstrapper/internal/ocm-cli"
 	"github.com/openmcp-project/bootstrapper/internal/template"
@@ -104,7 +103,7 @@ func (d *FluxDeployer) Deploy(ctx context.Context) (err error) {
 		return err
 	}
 
-	d.fluxcdCV, err = componentGetter.GetComponentVersionForResourceRecursive(ctx, componentGetter.RootComponentVersion(), common.FluxCDSourceControllerResourceName)
+	d.fluxcdCV, err = componentGetter.GetComponentVersionForResourceRecursive(ctx, componentGetter.RootComponentVersion(), FluxCDSourceControllerResourceName)
 	if err != nil {
 		return fmt.Errorf("failed to get fluxcd source controller component version: %w", err)
 	}
@@ -126,7 +125,7 @@ func (d *FluxDeployer) Deploy(ctx context.Context) (err error) {
 	}
 
 	// Kustomize <workdir>/repo/envs/<envName>/fluxcd
-	fluxCDEnvDir := filepath.Join(d.repoDir, common.EnvsDirectoryName, d.Config.Environment, common.FluxCDDirectoryName)
+	fluxCDEnvDir := filepath.Join(d.repoDir, EnvsDirectoryName, d.Config.Environment, FluxCDDirectoryName)
 	manifests, err := d.Kustomize(fluxCDEnvDir)
 	if err != nil {
 		return fmt.Errorf("error kustomizing templated files: %w", err)
@@ -146,14 +145,14 @@ func (d *FluxDeployer) ArrangeTemplates() (err error) {
 	d.log.Info("Arranging template files")
 
 	// Create directory <templatesDir>/envs/<envName>/fluxcd
-	fluxCDEnvDir := filepath.Join(d.templatesDir, common.EnvsDirectoryName, d.Config.Environment, common.FluxCDDirectoryName)
+	fluxCDEnvDir := filepath.Join(d.templatesDir, EnvsDirectoryName, d.Config.Environment, FluxCDDirectoryName)
 	err = os.MkdirAll(fluxCDEnvDir, 0755)
 	if err != nil {
 		return fmt.Errorf("failed to create fluxcd environment directory: %w", err)
 	}
 
 	// Create directory <templatesDir>/resources/fluxcd
-	fluxCDResourcesDir := filepath.Join(d.templatesDir, common.ResourcesDirectoryName, common.FluxCDDirectoryName)
+	fluxCDResourcesDir := filepath.Join(d.templatesDir, ResourcesDirectoryName, FluxCDDirectoryName)
 	err = os.MkdirAll(fluxCDResourcesDir, 0755)
 	if err != nil {
 		return fmt.Errorf("failed to create fluxcd resources directory: %w", err)
@@ -162,13 +161,13 @@ func (d *FluxDeployer) ArrangeTemplates() (err error) {
 	d.log.Debug("Copying template files to target directories")
 
 	// copy all files from <downloadDir>/templates/overlays to <templatesDir>/envs/<envName>/fluxcd
-	err = util.CopyDir(filepath.Join(d.downloadDir, common.TemplatesDirectoryName, common.OverlaysDirectoryName), fluxCDEnvDir)
+	err = util.CopyDir(filepath.Join(d.downloadDir, TemplatesDirectoryName, OverlaysDirectoryName), fluxCDEnvDir)
 	if err != nil {
 		return fmt.Errorf("failed to copy fluxcd overlays: %w", err)
 	}
 
 	// copy all files from <downloadDir>/templates/resources to <templatesDir>/resources/fluxcd
-	err = util.CopyDir(filepath.Join(d.downloadDir, common.TemplatesDirectoryName, common.ResourcesDirectoryName), fluxCDResourcesDir)
+	err = util.CopyDir(filepath.Join(d.downloadDir, TemplatesDirectoryName, ResourcesDirectoryName), fluxCDResourcesDir)
 	if err != nil {
 		return fmt.Errorf("failed to copy fluxcd resources: %w", err)
 	}
@@ -181,15 +180,15 @@ func (d *FluxDeployer) ArrangeTemplates() (err error) {
 // The resulting files are written to the repo directory.
 func (d *FluxDeployer) Template() (err error) {
 	d.log.Infof("Applying templates from %s to deployment repository", d.Config.Component.FluxcdTemplateResourcePath)
-	templateInput := common.NewTemplateInputFromConfig(d.Config)
+	templateInput := NewTemplateInputFromConfig(d.Config)
 
-	if err = templateInput.AddImageResource(d.fluxcdCV, common.FluxCDSourceControllerResourceName, "sourceController"); err != nil {
+	if err = templateInput.AddImageResource(d.fluxcdCV, FluxCDSourceControllerResourceName, "sourceController"); err != nil {
 		return fmt.Errorf("failed to apply fluxcd source controller template input: %w", err)
 	}
-	if err = templateInput.AddImageResource(d.fluxcdCV, common.FluxCDKustomizationControllerResourceName, "kustomizeController"); err != nil {
+	if err = templateInput.AddImageResource(d.fluxcdCV, FluxCDKustomizationControllerResourceName, "kustomizeController"); err != nil {
 		return fmt.Errorf("failed to apply fluxcd kustomize controller template input: %w", err)
 	}
-	if err = templateInput.AddImageResource(d.fluxcdCV, common.FluxCDHelmControllerResourceName, "helmController"); err != nil {
+	if err = templateInput.AddImageResource(d.fluxcdCV, FluxCDHelmControllerResourceName, "helmController"); err != nil {
 		return fmt.Errorf("failed to apply fluxcd helm controller template input: %w", err)
 	}
 

internal/flux_deployer/deployer.go

@@ -8,7 +8,7 @@ import (
 
 // GetFluxCDImages retrieves the images of the FluxCD controllers from the root component version.
 func GetFluxCDImages(rootCV *ocmcli.ComponentVersion) (map[string]any, error) {
-	return GetImages(rootCV, FluxcdHelmController, FluxcdKustomizeController, FluxcdSourceController)
+	return GetImages(rootCV, FluxCDHelmControllerResourceName, FluxCDKustomizationControllerResourceName, FluxCDSourceControllerResourceName)
 }
 
 // GetImages retrieves the images references for a list of resources of a component version.

internal/flux_deployer/images.go

@@ -13,13 +13,13 @@ func TestGetFluxCDImages(t *testing.T) {
 
 	imageMap, err := flux_deployer.GetFluxCDImages(cv)
 	assert.NoError(t, err, "error getting images")
-	img, found := imageMap[flux_deployer.FluxcdSourceController]
+	img, found := imageMap[flux_deployer.FluxCDSourceControllerResourceName]
 	assert.True(t, found, "fluxcd source controller image should be found")
 	assert.Equal(t, "test-source-controller-image:v0.0.1", img, "fluxcd source controller image should match")
-	img, found = imageMap[flux_deployer.FluxcdHelmController]
+	img, found = imageMap[flux_deployer.FluxCDHelmControllerResourceName]
 	assert.True(t, found, "fluxcd helm controller image should be found")
 	assert.Equal(t, "test-helm-controller-image:v0.0.1", img, "fluxcd helm controller image should match")
-	img, found = imageMap[flux_deployer.FluxcdKustomizeController]
+	img, found = imageMap[flux_deployer.FluxCDKustomizationControllerResourceName]
 	assert.True(t, found, "fluxcd kustomize controller image should be found")
 	assert.Equal(t, "test-kustomize-controller-image:v0.0.1", img, "fluxcd kustomize controller image should match")
 }

internal/flux_deployer/images_test.go

@@ -7,14 +7,13 @@ import (
 
 	"github.com/sirupsen/logrus"
 
-	"github.com/openmcp-project/bootstrapper/internal/common"
 	"github.com/openmcp-project/bootstrapper/internal/template"
 )
 
 // TemplateDirectory processes the template files in the specified directory and writes
 // the rendered content to the corresponding files in the Git repository's worktree.
 // It uses the provided template directory and Git repository to perform the operations.
-func TemplateDirectory(templateDirectory string, templateInput common.TemplateInput, repo string, logger *logrus.Logger) error {
+func TemplateDirectory(templateDirectory string, templateInput TemplateInput, repo string, logger *logrus.Logger) error {
 
 	templateDir, err := os.Open(templateDirectory)
 	if err != nil {

internal/flux_deployer/templating.go renamed to internal/flux_deployer/template.go

@@ -1,4 +1,4 @@
-package common
+package flux_deployer
 
 import (
 	"fmt"
@@ -16,27 +16,17 @@ func NewTemplateInput() TemplateInput {
 
 func NewTemplateInputFromConfig(c *config.BootstrapperConfig) TemplateInput {
 	t := TemplateInput{
-		"fluxCDEnvPath":       "./" + EnvsDirectoryName + "/" + c.Environment + "/" + FluxCDDirectoryName,
-		"fluxCDResourcesPath": "../../../" + ResourcesDirectoryName + "/" + FluxCDDirectoryName,
+		"fluxCDEnvPath":        "./" + EnvsDirectoryName + "/" + c.Environment + "/" + FluxCDDirectoryName,
+		"fluxCDResourcesPath":  "../../../" + ResourcesDirectoryName + "/" + FluxCDDirectoryName,
+		"openMCPResourcesPath": "../../../" + ResourcesDirectoryName + "/" + OpenMCPDirectoryName,
 
 		"git": map[string]interface{}{
 			"repoUrl":    c.DeploymentRepository.RepoURL,
 			"mainBranch": c.DeploymentRepository.RepoBranch,
 		},
 		"gitRepoEnvBranch": c.DeploymentRepository.RepoBranch,
 
-		"imagePullSecrets": func() []map[string]string {
-			if len(c.ImagePullSecrets) == 0 {
-				return nil
-			}
-			secrets := make([]map[string]string, 0, len(c.ImagePullSecrets))
-			for _, secret := range c.ImagePullSecrets {
-				secrets = append(secrets, map[string]string{
-					"name": secret,
-				})
-			}
-			return secrets
-		}(),
+		"imagePullSecrets": wrapImagePullSecrets(c.ImagePullSecrets),
 	}
 
 	return t
@@ -69,3 +59,13 @@ func (t TemplateInput) ValuesWrapper() map[string]any {
 		"Values": t,
 	}
 }
+
+func wrapImagePullSecrets(secrets []string) []map[string]string {
+	wrappedSecrets := make([]map[string]string, len(secrets))
+	for i, secret := range secrets {
+		wrappedSecrets[i] = map[string]string{
+			"name": secret,
+		}
+	}
+	return wrappedSecrets
+}