Skip to content

Commit fb007d7

Browse files
committed
Update readme, remove generated file
1 parent 575309b commit fb007d7

File tree

4 files changed

+14
-1069
lines changed

4 files changed

+14
-1069
lines changed

Diff for: .gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
/example/kpt/output-*
99
!/example/kpt/output-helm-kustomize
1010
/example/kpt/output-helm-kustomize/output-kustomization
11-
/example/kpt/output-helm-kustomize/output-kustomization/static/manifest.yaml
11+
/example/kpt/output-helm-kustomize/static/manifest.yaml
1212

Diff for: README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# khelm ![GitHub workflow badge](https://github.com/mgoltzsche/khelm/workflows/Release/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/mgoltzsche/helm-kustomize-plugin)](https://goreportcard.com/report/github.com/mgoltzsche/helm-kustomize-plugin)
1+
# khelm ![GitHub workflow badge](https://github.com/mgoltzsche/khelm/workflows/Release/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/mgoltzsche/khelm)](https://goreportcard.com/report/github.com/mgoltzsche/khelm)
22

33
A [Helm](https://github.com/helm/helm) chart templating CLI, helm to kustomize converter, [kpt](https://github.com/GoogleContainerTools/kpt) function and [kustomize](https://github.com/kubernetes-sigs/kustomize/) plugin.
44

@@ -85,7 +85,7 @@ This can be done by declaring the khelm and a kustomize function orderly within
8585

8686
### kustomize exec plugin
8787

88-
khelm can be used as [kustomize](https://github.com/kubernetes-sigs/kustomize) 3 exec plugin.
88+
khelm can be used as [kustomize](https://github.com/kubernetes-sigs/kustomize) 3 [exec plugin](https://kubectl.docs.kubernetes.io/guides/extending_kustomize/execpluginguidedexample/).
8989
Though plugin support in kustomize is still an alpha feature and may be removed in a future version.
9090

9191
#### Plugin installation
@@ -103,8 +103,6 @@ mkdir -p $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrend
103103
mv $GOPATH/bin/khelm $HOME/.config/kustomize/plugin/khelm.mgoltzsche.github.com/v1/chartrenderer/ChartRenderer
104104
```
105105

106-
The general [kustomize plugin guide](https://kubectl.docs.kubernetes.io/guides/extending_kustomize/execpluginguidedexample/) provides more information.
107-
108106
#### Plugin usage example
109107

110108
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:
@@ -196,7 +194,7 @@ Unlike Helm khelm allows usage of any repository when `repositories.yaml` is not
196194

197195
Build and test the khelm binary (requires Go 1.13) as well as the container image:
198196
```sh
199-
make khelm test check image e2e-test
197+
make clean khelm test check image e2e-test
200198
```
201199
_The dynamic binary is written to `build/bin/khelm` and the static binary to `build/bin/khelm-static`_.
202200

0 commit comments

Comments
 (0)