Upgrade to helm 3.

Introduces go module and config schema version v2.
Adds --skip-crds option/excludeCRDs field.

Dockerfile

@@ -13,6 +13,7 @@ RUN go build -o khelm -ldflags "-X main.khelmVersion=$KHELM_VERSION -X main.helm
 
 FROM alpine:3.12
 RUN mkdir /helm && chown root:nobody /helm && chmod 775 /helm
-ENV HELM_HOME=/helm
+ENV HELM_REPOSITORY_CONFIG=/helm/repository/repositories.yaml
+ENV HELM_REPOSITORY_CACHE=/helm/cache
 COPY --from=build /usr/local/bin/khelm /usr/local/bin/khelmfn
 ENTRYPOINT ["/usr/local/bin/khelmfn"]

Makefile

@@ -13,7 +13,7 @@ KUSTOMIZE_VERSION ?= 3.8.7
 
 REV := $(shell git rev-parse --short HEAD 2> /dev/null || echo 'unknown')
 VERSION ?= $(shell echo "$$(git for-each-ref refs/tags/ --count=1 --sort=-version:refname --format='%(refname:short)' 2>/dev/null)-dev-$(REV)" | sed 's/^v//')
-HELM_VERSION := $(shell grep k8s\.io/helm go.mod | sed -E -e 's/k8s\.io\/helm|\s+|\+.*//g' -e 's/^v//')
+HELM_VERSION := $(shell grep helm\.sh/helm/ go.mod | sed -E -e 's/helm\.sh\/helm\/v3|\s+//g' -e 's/^v//')
 GO_LDFLAGS := -X main.khelmVersion=$(VERSION) -X main.helmVersion=$(HELM_VERSION)
 BUILDTAGS ?= 
 

README.md

@@ -92,22 +92,22 @@ Though plugin support in kustomize is still an alpha feature and may be removed
 
 Install using curl (linux amd64):
 ```sh
-mkdir -p $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer
-curl -fsSL https://github.com/mgoltzsche/khelm/releases/latest/download/khelm-linux-amd64 > $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer/ChartRenderer
-chmod u+x $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer/ChartRenderer
+mkdir -p $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v2/chartrenderer
+curl -fsSL https://github.com/mgoltzsche/khelm/releases/latest/download/khelm-linux-amd64 > $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v2/chartrenderer/ChartRenderer
+chmod u+x $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v2/chartrenderer/ChartRenderer
 ```
 or using `go`:
 ```sh
-go get github.com/mgoltzsche/khelm/cmd/khelm
-mkdir -p $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer
-mv $GOPATH/bin/khelm $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer/ChartRenderer
+go get github.com/mgoltzsche/khelm/v2/cmd/khelm
+mkdir -p $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v2/chartrenderer
+mv $GOPATH/bin/khelm $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v2/chartrenderer/ChartRenderer
 ```
 
 #### Plugin usage example
 
 A _plugin descriptor_ specifies the helm repository, chart, version and values that should be used in a kubernetes-style resource can be referenced in the `generators` section of a `kustomization.yaml` and can look as follows:
 ```yaml
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: cert-manager # fallback for `name`
@@ -151,7 +151,7 @@ docker run mgoltzsche/khelm:latest template cert-manager --version=0.9.x --repo=
 
 ### Go API
 
-The khelm Go API `github.com/mgoltzsche/khelm/pkg/helm` provides a simple templating interface on top of the Helm Go API.
+The khelm Go API `github.com/mgoltzsche/khelm/v2/pkg/helm` provides a simple templating interface on top of the Helm Go API.
 It exposes a `Helm` struct that provides a `Render()` function that returns the rendered resources as `kyaml` objects.
 
 ## Configuration options
@@ -166,8 +166,9 @@ It exposes a `Helm` struct that provides a `Render()` function that returns the
 | `apiVersions` | `--api-versions` | Kubernetes api versions used for Capabilities.APIVersions. |
 | `kubeVersion` | `--kube-version` | Kubernetes version used for Capabilities.KubeVersion. |
 | `name` | `--name` | Release name used to render the chart. |
-| `verify` | `--verify` | If enabled verifies the signature of all charts using the `keyring` (see [Helm 2 provenance and integrity](https://v2.helm.sh/docs/provenance/)). |
+| `verify` | `--verify` | If enabled verifies the signature of all charts using the `keyring` (see [Helm 3 provenance and integrity](https://helm.sh/docs/topics/provenance/)). |
 | `keyring` | `--keyring` | GnuPG keyring file (default `~/.gnupg/pubring.gpg`). |
+| `excludeCRDs` | `--skip-crds` | If true Custom Resource Definitions are excluded from the output. |
 | `exclude` |  | List of resource selectors that exclude matching resources from the output. Fails if a selector doesn't match any resource. |
 | `exclude[].apiVersion` |  | Excludes resources by apiVersion. |
 | `exclude[].kind` |  | Excludes resources by kind. |

cmd/khelm/common.go

@@ -8,7 +8,7 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/mgoltzsche/khelm/pkg/helm"
+	"github.com/mgoltzsche/khelm/v2/pkg/helm"
 	"sigs.k8s.io/kustomize/kyaml/yaml"
 )
 

cmd/khelm/fn.go

@@ -5,8 +5,8 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/mgoltzsche/khelm/internal/output"
-	"github.com/mgoltzsche/khelm/pkg/helm"
+	"github.com/mgoltzsche/khelm/v2/internal/output"
+	"github.com/mgoltzsche/khelm/v2/pkg/helm"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/kustomize/kyaml/fn/framework"

cmd/khelm/fn_test.go

@@ -8,8 +8,8 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/mgoltzsche/khelm/internal/output"
-	"github.com/mgoltzsche/khelm/pkg/helm"
+	"github.com/mgoltzsche/khelm/v2/internal/output"
+	"github.com/mgoltzsche/khelm/v2/pkg/helm"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"sigs.k8s.io/kustomize/kyaml/yaml"

cmd/khelm/kustomize_plugin.go

@@ -4,8 +4,8 @@ import (
 	"io"
 	"strings"
 
-	"github.com/mgoltzsche/khelm/internal/output"
-	"github.com/mgoltzsche/khelm/pkg/helm"
+	"github.com/mgoltzsche/khelm/v2/internal/output"
+	"github.com/mgoltzsche/khelm/v2/pkg/helm"
 )
 
 func runAsKustomizePlugin(h *helm.Helm, generatorYAML string, writer io.Writer) error {

cmd/khelm/root.go

@@ -10,7 +10,7 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/mgoltzsche/khelm/pkg/helm"
+	"github.com/mgoltzsche/khelm/v2/pkg/helm"
 	"github.com/spf13/cobra"
 )
 

cmd/khelm/template.go

@@ -4,10 +4,10 @@ import (
 	"fmt"
 	"io"
 
-	"github.com/mgoltzsche/khelm/internal/output"
-	"github.com/mgoltzsche/khelm/pkg/helm"
+	"github.com/mgoltzsche/khelm/v2/internal/output"
+	"github.com/mgoltzsche/khelm/v2/pkg/helm"
 	"github.com/spf13/cobra"
-	"k8s.io/helm/pkg/strvals"
+	"helm.sh/helm/v3/pkg/strvals"
 )
 
 func templateCommand(h *helm.Helm, writer io.Writer) *cobra.Command {
@@ -66,6 +66,7 @@ func templateCommand(h *helm.Helm, writer io.Writer) *cobra.Command {
 	f.StringSliceVarP(&req.ValueFiles, "values", "f", nil, "Specify values in a YAML file or a URL (can specify multiple)")
 	f.StringSliceVar(&req.APIVersions, "api-versions", nil, "Kubernetes api versions used for Capabilities.APIVersions")
 	f.StringVar(&req.KubeVersion, "kube-version", req.KubeVersion, "Kubernetes version used as Capabilities.KubeVersion.Major/Minor")
+	f.BoolVar(&req.ExcludeCRDs, "skip-crds", false, "excludes CRDs from the chart output if enabled")
 	f.StringVarP(&outOpts.FileOrDir, "output", "o", "-", "Write rendered output to given file or directory (as kustomization)")
 	f.BoolVar(&outOpts.Replace, "output-replace", false, "Delete and recreate the whole output directory or file")
 	return cmd

cmd/khelm/template_test.go

@@ -8,7 +8,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
-	"k8s.io/helm/pkg/repo"
+	"helm.sh/helm/v3/pkg/repo"
 )
 
 func TestTemplateCommand(t *testing.T) {
@@ -105,7 +105,7 @@ func TestTemplateCommandError(t *testing.T) {
 	defer os.Unsetenv("HELM_HOME")
 	err = os.Mkdir(repoDir, 0755)
 	require.NoError(t, err)
-	err = repo.NewRepoFile().WriteFile(filepath.Join(repoDir, "repositories.yaml"), 0644)
+	err = repo.NewFile().WriteFile(filepath.Join(repoDir, "repositories.yaml"), 0644)
 	require.NoError(t, err)
 	for _, c := range []struct {
 		name string

e2e/kustomize-plugin-test.sh

@@ -9,7 +9,7 @@ echo
 TMP_DIR="$(mktemp -d)"
 STATUS=0
 (
-	PLUGIN_DIR=$TMP_DIR/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer
+	PLUGIN_DIR=$TMP_DIR/kustomize/plugin/khelm.mgoltzsche.github.com/v2/chartrenderer
 	set -ex
 	mkdir -p $PLUGIN_DIR
 	cp build/bin/khelm $PLUGIN_DIR/ChartRenderer

example/apiversions-condition/chart/Chart.yaml

@@ -1,4 +1,4 @@
-apiVersion: v1
+apiVersion: v2
 description: example chart using an apiversion condition
 name: apiversions-condition
 version: 0.1.0

example/apiversions-condition/generator.yaml

@@ -1,9 +1,8 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: apiversions-condition
   namespace: apiversions-condition-env
 chart: ./chart
 apiVersions:
 - myfancyapi/v1
-kubeVersion: 1.17

example/cert-manager/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: cert-manager

example/cluster-scoped-forbidden/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/cluster-scoped/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/exclude-nomatch/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/exclude/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/force-namespace/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: force-namespace

example/invalid-requirements-lock/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: invalid-requirements-example

example/jenkins/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: myjenkins

example/localref/elk/requirements.lock

@@ -2,5 +2,5 @@ dependencies:
 - name: elastic-stack
   repository: https://kubernetes-charts.storage.googleapis.com
   version: 1.6.0
-digest: sha256:4d8edf7b9e1f7f7fccfb58b62632ad500f790bf5be6d2a861fd7c9c7109c88e6
-generated: "2020-09-30T19:01:25.236657086Z"
+digest: sha256:f6c12b6ec018fdb17bb14d2ee8495e763fb386166fe6d23b0baa4ff86bc94071
+generated: "2020-10-18T16:27:26.090444945Z"

example/localref/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/localrefref/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: efk
+  repository: file://../localref/elk
+  version: 0.1.1
+digest: sha256:d92f768c1b07b1a3d9308e9fc2ea94a0523cf8e4f422661e59da4659ee307076
+generated: "2020-10-18T16:23:27.935558963Z"

example/localrefref/Chart.yaml

@@ -1,4 +1,9 @@
-apiVersion: v1
+apiVersion: v2
 descriptionx: Elasticsearch, Fluentd, Kibana (EFK)
 name: efk-wrapper
 version: 0.2.0
+dependencies:
+- name: efk
+  version: "~0.1.0"
+  repository: "file://../localref/elk"
+  alias: efk-custom

example/localrefref/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/namespace/Chart.yaml

@@ -1,4 +1,4 @@
-apiVersion: v1
+apiVersion: v2
 description: example chart with resources with and without namespace
 name: namespace
 version: 0.1.0

example/namespace/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: namespace-test

example/release-name/generator.yaml

@@ -1,5 +1,6 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: my-release-name
 chart: .
+kubeVersion: 1.17

example/rook-ceph/operator/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: rook-ceph

example/sonatype-nexus/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: sonatype-nexus

example/unsupported-field-fail/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: mychart

example/values-inheritance/chart/Chart.yaml

@@ -1,4 +1,4 @@
-apiVersion: v1
+apiVersion: v2
 description: example chart to test values inheritance
 name: values-inheritance-example
 version: 0.1.0

example/values-inheritance/generator.yaml

@@ -1,4 +1,4 @@
-apiVersion: khelm.mgoltzsche.github.com/v1
+apiVersion: khelm.mgoltzsche.github.com/v2
 kind: ChartRenderer
 metadata:
   name: values-inheritance-example

go.mod

@@ -1,24 +1,16 @@
-module github.com/mgoltzsche/khelm
+module github.com/mgoltzsche/khelm/v2
 
 go 1.14
 
 require (
-	github.com/Masterminds/goutils v1.1.0 // indirect
-	github.com/Masterminds/semver v1.5.0 // indirect
-	github.com/Masterminds/semver/v3 v3.1.1
-	github.com/Masterminds/sprig v2.22.0+incompatible // indirect
-	github.com/cyphar/filepath-securejoin v0.2.2 // indirect
+	github.com/Masterminds/semver/v3 v3.1.0
 	github.com/ghodss/yaml v1.0.0
-	github.com/gobwas/glob v0.2.3 // indirect
-	github.com/huandu/xstrings v1.3.2 // indirect
-	github.com/imdario/mergo v0.3.11 // indirect
-	github.com/mitchellh/copystructure v1.0.0 // indirect
 	github.com/pkg/errors v0.9.1
-	github.com/spf13/cobra v1.1.1
-	github.com/stretchr/testify v1.4.0
-	gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776
-	k8s.io/apimachinery v0.19.4 // indirect
-	k8s.io/client-go v11.0.0+incompatible
-	k8s.io/helm v2.17.0+incompatible
+	github.com/spf13/cobra v1.0.0
+	github.com/stretchr/testify v1.6.1
+	gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 // must include https://github.com/go-yaml/yaml/issues/578
+	helm.sh/helm/v3 v3.4.1
+	k8s.io/client-go v0.19.3
+	rsc.io/letsencrypt v0.0.3 // indirect
 	sigs.k8s.io/kustomize/kyaml v0.10.1
 )