Skip to content

Commit

Permalink
Update readme, remove generated file
Browse files Browse the repository at this point in the history
  • Loading branch information
mgoltzsche committed Dec 10, 2020
1 parent 575309b commit fb007d7
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 1,069 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
/example/kpt/output-*
!/example/kpt/output-helm-kustomize
/example/kpt/output-helm-kustomize/output-kustomization
/example/kpt/output-helm-kustomize/output-kustomization/static/manifest.yaml
/example/kpt/output-helm-kustomize/static/manifest.yaml

8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 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)
# 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)

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.

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

### kustomize exec plugin

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

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

The general [kustomize plugin guide](https://kubectl.docs.kubernetes.io/guides/extending_kustomize/execpluginguidedexample/) provides more information.

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

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

Expand Down
Loading

0 comments on commit fb007d7

Please sign in to comment.