convert helm inflator to builtin plugin

api/builtins/HelmChartInflationGenerator.go

@@ -0,0 +1,180 @@
+// Code generated by pluginator on HelmChartInflationGenerator; DO NOT EDIT.
+// pluginator {unknown  1970-01-01T00:00:00Z  }
+
+
+
+package builtins
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"os/exec"
+	"path"
+	"regexp"
+	"strings"
+
+	"github.com/pkg/errors"
+	"sigs.k8s.io/kustomize/api/filesys"
+	"sigs.k8s.io/kustomize/api/resmap"
+	"sigs.k8s.io/kustomize/api/types"
+	"sigs.k8s.io/yaml"
+)
+
+// HelmChartInflationGeneratorPlugin is a plugin to generate resources
+// from a remote or local helm chart.
+type HelmChartInflationGeneratorPlugin struct {
+	h                *resmap.PluginHelpers
+	types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
+	runHelmCommand   func([]string) ([]byte, error)
+	types.HelmChartArgs
+	tmpDir string
+}
+
+var KustomizePlugin HelmChartInflationGeneratorPlugin
+
+// Config uses the input plugin configurations `config` to setup the generator
+// options
+func (p *HelmChartInflationGeneratorPlugin) Config(h *resmap.PluginHelpers, config []byte) error {
+	p.h = h
+	err := yaml.Unmarshal(config, p)
+	if err != nil {
+		return err
+	}
+	tmpDir, err := filesys.NewTmpConfirmedDir()
+	if err != nil {
+		return err
+	}
+	p.tmpDir = string(tmpDir)
+	if p.ChartName == "" {
+		return fmt.Errorf("chartName cannot be empty")
+	}
+	if p.ChartHome == "" {
+		p.ChartHome = path.Join(p.tmpDir, "chart")
+	}
+	if p.ChartRepoName == "" {
+		p.ChartRepoName = "stable"
+	}
+	if p.HelmBin == "" {
+		p.HelmBin = "helm"
+	}
+	if p.HelmHome == "" {
+		p.HelmHome = path.Join(p.tmpDir, ".helm")
+	}
+	if p.Values == "" {
+		p.Values = path.Join(p.ChartHome, p.ChartName, "values.yaml")
+	}
+	// runHelmCommand will run `helm` command with args provided. Return stdout
+	// and error if there is any.
+	p.runHelmCommand = func(args []string) ([]byte, error) {
+		stdout := new(bytes.Buffer)
+		stderr := new(bytes.Buffer)
+		cmd := exec.Command(p.HelmBin, args...)
+		cmd.Stdout = stdout
+		cmd.Stderr = stderr
+		cmd.Env = append(cmd.Env,
+			fmt.Sprintf("HELM_CONFIG_HOME=%s", p.HelmHome),
+			fmt.Sprintf("HELM_CACHE_HOME=%s/.cache", p.HelmHome),
+			fmt.Sprintf("HELM_DATA_HOME=%s/.data", p.HelmHome),
+		)
+		err := cmd.Run()
+		if err != nil {
+			return stdout.Bytes(),
+				errors.Wrap(
+					fmt.Errorf("failed to run command %s %s", p.HelmBin, strings.Join(args, " ")),
+					stderr.String(),
+				)
+		}
+		return stdout.Bytes(), nil
+	}
+	return nil
+}
+
+// Generate implements generator
+func (p *HelmChartInflationGeneratorPlugin) Generate() (resmap.ResMap, error) {
+	// cleanup
+	defer os.RemoveAll(p.tmpDir)
+	// check helm version. we only support V3
+	err := p.checkHelmVersion()
+	if err != nil {
+		return nil, err
+	}
+	// pull the chart
+	if !p.checkLocalChart() {
+		_, err := p.runHelmCommand(p.getPullCommandArgs())
+		if err != nil {
+			return nil, err
+		}
+	}
+	// render the charts
+	stdout, err := p.runHelmCommand(p.getTemplateCommandArgs())
+	if err != nil {
+		return nil, err
+	}
+
+	return p.h.ResmapFactory().NewResMapFromBytes(stdout)
+}
+
+func (p *HelmChartInflationGeneratorPlugin) getTemplateCommandArgs() []string {
+	args := []string{"template"}
+	if p.ReleaseName != "" {
+		args = append(args, p.ReleaseName)
+	}
+	args = append(args, path.Join(p.ChartHome, p.ChartName))
+	if p.ReleaseNamespace != "" {
+		args = append(args, "--namespace", p.ReleaseNamespace)
+	}
+	if p.Values != "" {
+		args = append(args, "--values", p.Values)
+	}
+	return args
+}
+
+func (p *HelmChartInflationGeneratorPlugin) getPullCommandArgs() []string {
+	args := []string{"pull", "--untar", "--untardir", p.ChartHome}
+	chartName := fmt.Sprintf("%s/%s", p.ChartRepoName, p.ChartName)
+	if p.ChartVersion != "" {
+		args = append(args, "--version", p.ChartVersion)
+	}
+	if p.ChartRepoURL != "" {
+		args = append(args, "--repo", p.ChartRepoURL)
+		chartName = p.ChartName
+	}
+
+	args = append(args, chartName)
+
+	return args
+}
+
+// checkLocalChart will return true if the chart does exist in
+// local chart home.
+func (p *HelmChartInflationGeneratorPlugin) checkLocalChart() bool {
+	path := path.Join(p.ChartHome, p.ChartName)
+	s, err := os.Stat(path)
+	if err != nil {
+		return false
+	}
+	return s.IsDir()
+}
+
+// checkHelmVersion will return an error if the helm version is not V3
+func (p *HelmChartInflationGeneratorPlugin) checkHelmVersion() error {
+	stdout, err := p.runHelmCommand([]string{"version", "-c", "--short"})
+	if err != nil {
+		return err
+	}
+	r, err := regexp.Compile(`v\d+(\.\d+)+`)
+	if err != nil {
+		return err
+	}
+	v := string(r.Find(stdout))[1:]
+	majorVersion := strings.Split(v, ".")[0]
+	if majorVersion != "3" {
+		return fmt.Errorf("this plugin requires helm V3 but got v%s", v)
+	}
+	return nil
+}
+
+func NewHelmChartInflationGeneratorPlugin() resmap.GeneratorPlugin {
+  return &HelmChartInflationGeneratorPlugin{}
+}

api/internal/plugins/builtinhelpers/builtins.go

@@ -27,6 +27,7 @@ const (
 	ReplicaCountTransformer
 	SecretGenerator
 	ValueAddTransformer
+	HelmChartInflationGenerator
 )
 
 var stringToBuiltinPluginTypeMap map[string]BuiltinPluginType
@@ -55,8 +56,9 @@ func GetBuiltinPluginType(n string) BuiltinPluginType {
 }
 
 var GeneratorFactories = map[BuiltinPluginType]func() resmap.GeneratorPlugin{
-	ConfigMapGenerator: builtins.NewConfigMapGeneratorPlugin,
-	SecretGenerator:    builtins.NewSecretGeneratorPlugin,
+	ConfigMapGenerator:          builtins.NewConfigMapGeneratorPlugin,
+	SecretGenerator:             builtins.NewSecretGeneratorPlugin,
+	HelmChartInflationGenerator: builtins.NewHelmChartInflationGeneratorPlugin,
 }
 
 var TransformerFactories = map[BuiltinPluginType]func() resmap.TransformerPlugin{

api/internal/target/kusttarget_configplugin.go

@@ -32,6 +32,7 @@ func (kt *KustTarget) configureBuiltinGenerators() (
 	for _, bpt := range []builtinhelpers.BuiltinPluginType{
 		builtinhelpers.ConfigMapGenerator,
 		builtinhelpers.SecretGenerator,
+		builtinhelpers.HelmChartInflationGenerator,
 	} {
 		r, err := generatorConfigurators[bpt](
 			kt, bpt, builtinhelpers.GeneratorFactories[bpt])
@@ -110,6 +111,23 @@ var generatorConfigurators = map[builtinhelpers.BuiltinPluginType]func(
 		}
 		return
 	},
+
+	builtinhelpers.HelmChartInflationGenerator: func(kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f gFactory) (
+		result []resmap.Generator, err error) {
+		var c struct {
+			types.HelmChartArgs
+		}
+		for _, args := range kt.kustomization.HelmChartInflationGenerator {
+			c.HelmChartArgs = args
+			p := f()
+			err := kt.configureBuiltinPlugin(p, c, bpt)
+			if err != nil {
+				return nil, err
+			}
+			result = append(result, p)
+		}
+		return
+	},
 }
 
 type tFactory func() resmap.TransformerPlugin

api/krusty/helmchartinflationgenerator_test.go

@@ -0,0 +1,75 @@
+// Copyright 2020 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package krusty_test
+
+import (
+	"testing"
+
+	kusttest_test "sigs.k8s.io/kustomize/api/testutils/kusttest"
+)
+
+func TestHelmChartInflationGenerator(t *testing.T) {
+	th := kusttest_test.MakeHarness(t)
+	th.WriteK("/app", `
+helmChartInflationGenerator:
+- chartName: minecraft
+  chartRepoUrl: https://kubernetes-charts.storage.googleapis.com
+  chartVersion: v1.2.0
+  releaseName: test
+  releaseNamespace: testNamespace
+`)
+
+	m := th.Run("/app", th.MakeDefaultOptions())
+	th.AssertActualEqualsExpected(m, `
+apiVersion: v1
+data:
+  rcon-password: Q0hBTkdFTUUh
+kind: Secret
+metadata:
+  labels:
+    app: test-minecraft
+    chart: minecraft-1.2.0
+    heritage: Helm
+    release: test
+  name: test-minecraft
+type: Opaque
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  annotations:
+    volume.alpha.kubernetes.io/storage-class: default
+  labels:
+    app: test-minecraft
+    chart: minecraft-1.2.0
+    heritage: Helm
+    release: test
+  name: test-minecraft-datadir
+spec:
+  accessModes:
+  - ReadWriteOnce
+  resources:
+    requests:
+      storage: 1Gi
+---
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: test-minecraft
+    chart: minecraft-1.2.0
+    heritage: Helm
+    release: test
+  name: test-minecraft
+spec:
+  ports:
+  - name: minecraft
+    port: 25565
+    protocol: TCP
+    targetPort: minecraft
+  selector:
+    app: test-minecraft
+  type: LoadBalancer
+`)
+}

api/types/helmchartargs.go

@@ -0,0 +1,19 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package types
+
+// HelmChartArgs contains the metadata of how to generate a secret.
+type HelmChartArgs struct {
+	ChartName    string `json:"chartName,omitempty" yaml:"chartName,omitempty"`
+	ChartVersion string `json:"chartVersion,omitempty" yaml:"chartVersion,omitempty"`
+	ChartRepoURL string `json:"chartRepoUrl,omitempty" yaml:"chartRepoUrl,omitempty"`
+	ChartHome    string `json:"chartHome,omitempty" yaml:"chartHome,omitempty"`
+	// Use chartRelease to keep compatible with old exec plugin
+	ChartRepoName    string `json:"chartRelease,omitempty" yaml:"chartRelease,omitempty"`
+	HelmBin          string `json:"helmBin,omitempty" yaml:"helmBin,omitempty"`
+	HelmHome         string `json:"helmHome,omitempty" yaml:"helmHome,omitempty"`
+	Values           string `json:"values,omitempty" yaml:"values,omitempty"`
+	ReleaseName      string `json:"releaseName,omitempty" yaml:"releaseName,omitempty"`
+	ReleaseNamespace string `json:"releaseNamespace,omitempty" yaml:"releaseNamespace,omitempty"`
+}

api/types/kustomization.go

@@ -122,6 +122,11 @@ type Kustomization struct {
 	// the map will have a suffix hash generated from its contents.
 	SecretGenerator []SecretArgs `json:"secretGenerator,omitempty" yaml:"secretGenerator,omitempty"`
 
+	// HelmChartInflationGenerator is a list of helm chart configurations.
+	// The resulting resource is a normal operand rendered from
+	// a remote chart by `helm template`
+	HelmChartInflationGenerator []HelmChartArgs `json:"helmChartInflationGenerator,omitempty" yaml:"helmChartInflationGenerator,omitempty"`
+
 	// GeneratorOptions modify behavior of all ConfigMap and Secret generators.
 	GeneratorOptions *GeneratorOptions `json:"generatorOptions,omitempty" yaml:"generatorOptions,omitempty"`