feat: helm chart directory can be configured

Per default, helm-charts will get generated under dist/ directory.
Via the newly introduced --directory flag it's now possible to define an
alternative directory (e.g.: chart)

fixes #4320

Signed-off-by: Mario Constanti <mario.constanti@mercedes-benz.com>

Author: bavarianbidi

.golangci.yml

@@ -13,6 +13,7 @@ linters:
     - goconst
     - gocyclo
     - govet
+    - importas
     - ineffassign
     - lll
     - misspell
@@ -27,6 +28,10 @@ linters:
     - wrapcheck
     - whitespace
   settings:
+    importas:
+      alias:
+      - pkg: sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha
+        alias: helmv1alpha
     ginkgolinter:
       forbid-focus-container: true
       forbid-spec-pollution: true

cmd/cmd.go

@@ -28,7 +28,7 @@ import (
 	deployimagev1alpha1 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/deploy-image/v1alpha1"
 	golangv4 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4"
 	grafanav1alpha1 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/grafana/v1alpha"
-	helmv1alpha1 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha"
+	helmv1alpha "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha"
 )
 
 func init() {
@@ -62,7 +62,7 @@ func Run() {
 			&kustomizecommonv2.Plugin{},
 			&deployimagev1alpha1.Plugin{},
 			&grafanav1alpha1.Plugin{},
-			&helmv1alpha1.Plugin{},
+			&helmv1alpha.Plugin{},
 		),
 		cli.WithPlugins(externalPlugins...),
 		cli.WithDefaultPlugins(cfgv3.Version, gov4Bundle),

pkg/cli/alpha/internal/generate.go

@@ -34,8 +34,8 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/deploy-image/v1alpha1"
-	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/grafana/v1alpha"
-	hemlv1alpha "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha"
+	grafanav1alpha "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/grafana/v1alpha"
+	helmv1alpha "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha"
 )
 
 // Generate store the required info for the command
@@ -110,8 +110,8 @@ func (opts *Generate) Generate() error {
 	}
 
 	if hasHelmPlugin(projectConfig) {
-		if err = kubebuilderHelmEdit(); err != nil {
-			return fmt.Errorf("error editing Helm plugin: %w", err)
+		if err = migrateHelmPlugin(projectConfig); err != nil {
+			return fmt.Errorf("error migrating Helm plugin: %w", err)
 		}
 	}
 
@@ -226,7 +226,7 @@ func kubebuilderCreate(s store.Store) error {
 // Migrates the Grafana plugin.
 func migrateGrafanaPlugin(s store.Store, src, des string) error {
 	var grafanaPlugin struct{}
-	err := s.Config().DecodePluginConfig(plugin.KeyFor(v1alpha.Plugin{}), grafanaPlugin)
+	err := s.Config().DecodePluginConfig(plugin.KeyFor(grafanav1alpha.Plugin{}), grafanaPlugin)
 	if errors.As(err, &config.PluginKeyNotFoundError{}) {
 		log.Info("Grafana plugin not found, skipping migration")
 		return nil
@@ -481,28 +481,58 @@ func grafanaConfigMigrate(src, des string) error {
 
 // Edits the project to include the Grafana plugin.
 func kubebuilderGrafanaEdit() error {
-	args := []string{"edit", "--plugins", plugin.KeyFor(v1alpha.Plugin{})}
+	args := []string{"edit", "--plugins", plugin.KeyFor(grafanav1alpha.Plugin{})}
 	if err := util.RunCmd("kubebuilder edit", "kubebuilder", args...); err != nil {
 		return fmt.Errorf("failed to run edit subcommand for Grafana plugin: %w", err)
 	}
 	return nil
 }
 
+// Migrates the Helm plugin.
+func migrateHelmPlugin(s store.Store) error {
+	var helmPlugin helmv1alpha.PluginConfig
+
+	err := s.Config().DecodePluginConfig(plugin.KeyFor(helmv1alpha.Plugin{}), &helmPlugin)
+	if errors.As(err, &config.PluginKeyNotFoundError{}) {
+		log.Info("Helm plugin not found, skipping migration")
+		return nil
+	} else if err != nil {
+		return fmt.Errorf("failed to decode Helm plugin config: %w", err)
+	}
+
+	return kubebuilderHelmEdit(helmPlugin)
+}
+
 // Edits the project to include the Helm plugin.
-func kubebuilderHelmEdit() error {
-	args := []string{"edit", "--plugins", plugin.KeyFor(hemlv1alpha.Plugin{})}
+func kubebuilderHelmEdit(resourceData helmv1alpha.PluginConfig) error {
+	args := []string{"edit", "--plugins", plugin.KeyFor(helmv1alpha.Plugin{})}
+	args = append(args, getHelmOptions(resourceData)...)
 	if err := util.RunCmd("kubebuilder edit", "kubebuilder", args...); err != nil {
 		return fmt.Errorf("failed to run edit subcommand for Helm plugin: %w", err)
 	}
 	return nil
 }
 
+// Gets the options for Helm resource.
+// If the directory is not the default, it sets the directory option.
+// otherwise, it returns an empty slice which then use the default value from the edit/init subcommand.
+func getHelmOptions(resourceData helmv1alpha.PluginConfig) []string {
+	var args []string
+
+	if resourceData.Options.Directory != helmv1alpha.HelmDefaultTargetDirectory {
+		log.Info("setting directory for Helm chart")
+		args = append(args, fmt.Sprintf("--directory=%s", resourceData.Options.Directory))
+	}
+
+	return args
+}
+
 // hasHelmPlugin checks if the Helm plugin is present by inspecting the plugin chain or configuration.
 func hasHelmPlugin(cfg store.Store) bool {
 	var pluginConfig map[string]interface{}
 
 	// Decode the Helm plugin configuration to check if it's present
-	err := cfg.Config().DecodePluginConfig(plugin.KeyFor(hemlv1alpha.Plugin{}), &pluginConfig)
+	err := cfg.Config().DecodePluginConfig(plugin.KeyFor(helmv1alpha.Plugin{}), &pluginConfig)
 	if err != nil {
 		// If the Helm plugin is not found, return false
 		if errors.As(err, &config.PluginKeyNotFoundError{}) {

pkg/plugins/optional/helm/v1alpha/commons.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha
 
 import (
+	"errors"
 	"fmt"
 
 	"github.com/spf13/pflag"
@@ -29,8 +30,9 @@ import (
 var _ plugin.EditSubcommand = &editSubcommand{}
 
 type editSubcommand struct {
-	config config.Config
-	force  bool
+	config    config.Config
+	force     bool
+	directory string
 }
 
 //nolint:lll
@@ -66,6 +68,7 @@ manifests in the chart align with the latest changes.
 
 func (p *editSubcommand) BindFlags(fs *pflag.FlagSet) {
 	fs.BoolVar(&p.force, "force", false, "if true, regenerates all the files")
+	fs.StringVar(&p.directory, "directory", HelmDefaultTargetDirectory, "domain for groups")
 }
 
 func (p *editSubcommand) InjectConfig(c config.Config) error {
@@ -74,13 +77,30 @@ func (p *editSubcommand) InjectConfig(c config.Config) error {
 }
 
 func (p *editSubcommand) Scaffold(fs machinery.Filesystem) error {
-	scaffolder := scaffolds.NewHelmScaffolder(p.config, p.force)
+	scaffolder := scaffolds.NewHelmScaffolder(p.config, p.force, p.directory)
 	scaffolder.InjectFS(fs)
 	err := scaffolder.Scaffold()
 	if err != nil {
 		return fmt.Errorf("error scaffolding Helm chart: %w", err)
 	}
 
 	// Track the resources following a declarative approach
-	return insertPluginMetaToConfig(p.config, pluginConfig{})
+	cfg := PluginConfig{}
+	if err = p.config.DecodePluginConfig(pluginKey, &cfg); errors.As(err, &config.UnsupportedFieldError{}) {
+		// Skip tracking as the config doesn't support per-plugin configuration
+		return nil
+	} else if err != nil && !errors.As(err, &config.PluginKeyNotFoundError{}) {
+		// Fail unless the key wasn't found, which just means it is the first resource tracked
+		return fmt.Errorf("error decoding plugin configuration: %w", err)
+	}
+
+	cfg.Options = options{
+		Directory: p.directory,
+	}
+
+	if err = p.config.EncodePluginConfig(pluginKey, cfg); err != nil {
+		return fmt.Errorf("error encoding plugin configuration: %w", err)
+	}
+
+	return nil
 }

pkg/plugins/optional/helm/v1alpha/edit.go

@@ -24,7 +24,15 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugins"
 )
 
-const pluginName = "helm." + plugins.DefaultNameQualifier
+const (
+	pluginName = "helm." + plugins.DefaultNameQualifier
+
+	// HelmDefaultTargetDirectory is the default directory where the Helm chart will be scaffolded
+	// This is used in the init subcommand to scaffold the Helm chart.
+	// It is also used in the edit subcommand to add or edit a Helm chart.
+	// It is set to "dist" to match the default target directory for other plugins.
+	HelmDefaultTargetDirectory = "dist"
+)
 
 var (
 	pluginVersion            = plugin.Version{Number: 1, Stage: stage.Alpha}
@@ -39,7 +47,15 @@ type Plugin struct {
 
 var _ plugin.Edit = Plugin{}
 
-type pluginConfig struct{}
+type PluginConfig struct {
+	// Options contains the options for the Helm plugin
+	Options options `json:"options,omitempty"`
+}
+
+type options struct {
+	// Directory is the directory where the Helm chart will be scaffolded
+	Directory string `json:"directory,omitempty"`
+}
 
 // Name returns the name of the plugin
 func (Plugin) Name() string { return pluginName }

pkg/plugins/optional/helm/v1alpha/plugin.go

@@ -50,13 +50,16 @@ type editScaffolder struct {
 	fs machinery.Filesystem
 
 	force bool
+
+	directory string
 }
 
 // NewHelmScaffolder returns a new Scaffolder for HelmPlugin
-func NewHelmScaffolder(cfg config.Config, force bool) plugins.Scaffolder {
+func NewHelmScaffolder(cfg config.Config, force bool, dir string) plugins.Scaffolder {
 	return &editScaffolder{
-		config: cfg,
-		force:  force,
+		config:    cfg,
+		force:     force,
+		directory: dir,
 	}
 }
 
@@ -83,37 +86,57 @@ func (s *editScaffolder) Scaffold() error {
 	hasWebhooks := hasWebhooksWith(s.config) || (len(mutatingWebhooks) > 0 && len(validatingWebhooks) > 0)
 
 	buildScaffold := []machinery.Builder{
-		&github.HelmChartCI{},
-		&templates.HelmChart{},
+		&github.HelmChartCI{
+			Directory: s.directory,
+		},
+		&templates.HelmChart{
+			Directory: s.directory,
+		},
 		&templates.HelmValues{
 			HasWebhooks:  hasWebhooks,
 			DeployImages: imagesEnvVars,
 			Force:        s.force,
+			Directory:    s.directory,
+		},
+		&templates.HelmIgnore{
+			Directory: s.directory,
+		},
+		&charttemplates.HelmHelpers{
+			Directory: s.directory,
 		},
-		&templates.HelmIgnore{},
-		&charttemplates.HelmHelpers{},
 		&manager.Deployment{
 			Force:        s.force,
 			DeployImages: len(imagesEnvVars) > 0,
 			HasWebhooks:  hasWebhooks,
+			Directory:    s.directory,
+		},
+		&templatescertmanager.Certificate{
+			HasWebhooks: hasWebhooks,
+			Directory:   s.directory,
+		},
+		&templatesmetrics.Service{
+			Directory: s.directory,
+		},
+		&prometheus.Monitor{
+			Directory: s.directory,
 		},
-		&templatescertmanager.Certificate{HasWebhooks: hasWebhooks},
-		&templatesmetrics.Service{},
-		&prometheus.Monitor{},
 	}
 
 	if len(mutatingWebhooks) > 0 || len(validatingWebhooks) > 0 {
 		buildScaffold = append(buildScaffold,
 			&templateswebhooks.Template{
 				MutatingWebhooks:   mutatingWebhooks,
 				ValidatingWebhooks: validatingWebhooks,
+				Directory:          s.directory,
 			},
 		)
 	}
 
 	if hasWebhooks {
 		buildScaffold = append(buildScaffold,
-			&templateswebhooks.Service{},
+			&templateswebhooks.Service{
+				Directory: s.directory,
+			},
 		)
 	}
 
@@ -122,9 +145,9 @@ func (s *editScaffolder) Scaffold() error {
 	}
 
 	// Copy relevant files from config/ to dist/chart/templates/
-	err = s.copyConfigFiles()
+	err = s.copyConfigFiles(s.directory)
 	if err != nil {
-		return fmt.Errorf("failed to copy manifests from config to dist/chart/templates/: %w", err)
+		return fmt.Errorf("failed to copy manifests from config %s/chart/templates/: %w", s.directory, err)
 	}
 
 	return nil
@@ -227,15 +250,15 @@ func (s *editScaffolder) extractWebhooksFromGeneratedFiles() (mutatingWebhooks [
 }
 
 // Helper function to copy files from config/ to dist/chart/templates/
-func (s *editScaffolder) copyConfigFiles() error {
+func (s *editScaffolder) copyConfigFiles(targetDirectory string) error {
 	configDirs := []struct {
 		SrcDir  string
 		DestDir string
 		SubDir  string
 	}{
-		{"config/rbac", "dist/chart/templates/rbac", "rbac"},
-		{"config/crd/bases", "dist/chart/templates/crd", "crd"},
-		{"config/network-policy", "dist/chart/templates/network-policy", "networkPolicy"},
+		{"config/rbac", targetDirectory + "/chart/templates/rbac", "rbac"},
+		{"config/crd/bases", targetDirectory + "/chart/templates/crd", "crd"},
+		{"config/network-policy", targetDirectory + "/chart/templates/network-policy", "networkPolicy"},
 	}
 
 	for _, dir := range configDirs {

pkg/plugins/optional/helm/v1alpha/scaffolds/edit.go

@@ -30,12 +30,14 @@ type Certificate struct {
 
 	// HasWebhooks is true when webhooks were found in the config
 	HasWebhooks bool
+	// Directory is the directory where the Helm chart will be scaffolded
+	Directory string
 }
 
 // SetTemplateDefaults sets the default template configuration
 func (f *Certificate) SetTemplateDefaults() error {
 	if f.Path == "" {
-		f.Path = filepath.Join("dist", "chart", "templates", "certmanager", "certificate.yaml")
+		f.Path = filepath.Join(f.Directory, "chart", "templates", "certmanager", "certificate.yaml")
 	}
 
 	f.TemplateBody = certificateTemplate