Skip to content

Commit

Permalink
Fix build instruction for helm binding
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-1224 committed Aug 2, 2019
1 parent 91772de commit 3711ad2
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ This input type is experimental. See <https://github.com/deepmind/kapitan/pull/1
#### helm
This is a Python binding to `helm template` command for users with helm charts. This input type can be made available by building the binding with `$ make build_helm_binding`. Unlike any other input types, Helm input types support the following additional parameters under `kapitan.compile`:
This is a Python binding to `helm template` command for users with helm charts. Unlike any other input types, Helm input types support the following additional parameters under `kapitan.compile`:
```yaml
parameters:
Expand Down Expand Up @@ -180,10 +180,17 @@ See the [helm doc](<https://helm.sh/docs/helm/#helm-template>) for further detai

##### Building the binding from source

Run `$ make build_helm_binding` from project root. This requires Go >= 1.12.
Run

```shell
cd kapitan/inputs/helm
./build.sh
```

. This requires Go >= 1.12.

##### Helm subcharts

This binding supports helm subcharts. However, since the [external dependency manager](external_dependencies.md) does not parse `requirements.yaml` in order to detect chart dependencies, you are required to manually download the entire chart including the parent charts.

*Supported output types:* N/A (no need to specify this parameter)
*Supported output types:* N/A (no need to specify this parameter)

0 comments on commit 3711ad2

Please sign in to comment.