Kap 09

.travis.yml

@@ -25,18 +25,17 @@ before_install:
   - sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157
   # Loop until update succeeds (timeouts can occur)
   - travis_retry $(! sudo apt-get -qq update 2>&1 | grep Failed)
-  - sudo apt-get install -y gnupg2 git
-  - sudo apt-get install -y golang-1.14
-  - export PATH="/usr/lib/go-1.14/bin:$PATH"
-  - export GOROOT=/usr/lib/go-1.14
-  - go version
+  - sudo apt-get install -y gnupg2 git curl
+  # Install Helm Binary
+  - curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
+  - chmod 700 get_helm.sh
+  - sudo ./get_helm.sh
 
 install:
   - pip3 install -r requirements.txt
   - pip3 install coverage black
 
 script:
-  - make build_helm_binding && make build_helm_fetch_binding
   - make test && make test_coverage
 
 after_success:

Dockerfile

@@ -1,28 +1,14 @@
-# First build the Helm binding
-FROM golang:1.14.4-stretch AS helm-builder
+# Build the virtualenv for Kapitan
+FROM python:3.7-slim-stretch AS python-builder
 
 RUN mkdir /kapitan
 WORKDIR /kapitan
 
-COPY ./kapitan/inputs/helm ./kapitan/inputs/helm
-RUN chmod +x ./kapitan/inputs/helm/build.sh \
-    && ./kapitan/inputs/helm/build.sh
-
-COPY ./kapitan/dependency_manager/helm ./kapitan/dependency_manager/helm
-RUN chmod +x ./kapitan/dependency_manager/helm/build.sh \
-    && ./kapitan/dependency_manager/helm/build.sh
-
 COPY ./kapitan ./kapitan
 COPY ./MANIFEST.in ./MANIFEST.in
 COPY ./requirements.txt ./requirements.txt
 COPY ./setup.py ./setup.py
 
-# Build the virtualenv for Kapitan
-FROM python:3.7-slim-stretch AS python-builder
-
-COPY --from=helm-builder /kapitan /kapitan
-WORKDIR /kapitan
-
 ENV PATH="/opt/venv/bin:${PATH}"
 
 RUN apt-get update \
@@ -31,10 +17,15 @@ RUN apt-get update \
     && python -m venv /opt/venv \
     && pip install --upgrade pip yq wheel \
     && pip install -r requirements.txt \
-    && ./kapitan/inputs/helm/build.sh \
-    && ./kapitan/dependency_manager/helm/build.sh \
     && pip install .
 
+# Install Helm
+RUN apt-get install --no-install-recommends -y curl \
+    && curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 \
+    && chmod 700 get_helm.sh \
+    && HELM_INSTALL_DIR=/opt/venv/bin ./get_helm.sh --no-sudo \
+    && rm get_helm.sh
+
 # Final image with virtualenv built in previous step
 FROM python:3.7-slim-stretch
 

Dockerfile.ci

@@ -7,25 +7,6 @@ FROM bitnami/jsonnet:0.14.0 as jsonnet-binary
 # /bin/promtool
 FROM quay.io/prometheus/prometheus:v2.15.2 AS prometheus-binary
 
-# Build the Helm binding
-FROM golang:1.14.4-stretch AS helm-builder
-
-RUN mkdir /kapitan
-WORKDIR /kapitan
-
-COPY ./kapitan/inputs/helm ./kapitan/inputs/helm
-RUN chmod +x ./kapitan/inputs/helm/build.sh \
-    && ./kapitan/inputs/helm/build.sh
-
-COPY ./kapitan/dependency_manager/helm ./kapitan/dependency_manager/helm
-RUN chmod +x ./kapitan/dependency_manager/helm/build.sh \
-    && ./kapitan/dependency_manager/helm/build.sh
-
-COPY ./kapitan ./kapitan
-COPY ./MANIFEST.in ./MANIFEST.in
-COPY ./requirements.txt ./requirements.txt
-COPY ./setup.py ./setup.py
-
 # Build final image
 FROM python:3.7-buster
 
@@ -37,7 +18,13 @@ COPY --from=terraform-binary /bin/terraform /usr/bin/terraform
 COPY --from=jsonnet-binary /opt/bitnami/jsonnet/bin/jsonnet /usr/bin/jsonnet
 COPY --from=jsonnet-binary /opt/bitnami/jsonnet/bin/jsonnetfmt /usr/bin/jsonnetfmt
 COPY --from=prometheus-binary /bin/promtool /usr/bin/promtool
-COPY --from=helm-builder /kapitan /kapitan
+
+RUN mkdir /kapitan
+
+COPY ./kapitan /kapitan/kapitan
+COPY ./MANIFEST.in /kapitan/MANIFEST.in
+COPY ./requirements.txt /kapitan/requirements.txt
+COPY ./setup.py /kapitan/setup.py
 
 RUN apt-get update \
     && apt-get install --no-install-recommends -y \
@@ -72,10 +59,12 @@ RUN apt-get update \
     && python -m venv /opt/venv \
     && pip install --upgrade pip yq wheel \
     && pip install -r ./kapitan/requirements.txt \
-    && ./kapitan/kapitan/inputs/helm/build.sh \
-    && ./kapitan/kapitan/dependency_manager/helm/build.sh \
     && pip install ./kapitan \
     && rm -rf ./kapitan \
+    && curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 \
+    && chmod 700 get_helm.sh \
+    && HELM_INSTALL_DIR=/opt/venv/bin ./get_helm.sh --no-sudo \
+    && rm get_helm.sh \
     && curl -L -o /usr/local/bin/kapp ${KAPP_URL} \
     && chmod +x /usr/local/bin/kapp \
     && curl -L -o /usr/local/bin/kbld ${KBLD_URL} \

MANIFEST.in

@@ -2,5 +2,3 @@ recursive-include kapitan/reclass/reclass/ *.py
 include kapitan/lib/*.libjsonnet
 include requirements.txt
 recursive-include kapitan/inputs/templates *
-recursive-include kapitan/inputs/helm *
-recursive-include kapitan/dependency_manager/helm *

Makefile

@@ -54,10 +54,6 @@ format_codestyle:
 	black .
 	@echo
 
-.PHONY: build_helm_fetch_binding
-build_helm_fetch_binding:
-	bash kapitan/dependency_manager/helm/build.sh
-
 .PHONY: local_serve_documentation
 local_serve_documentation:
 	docker build -f Dockerfile.docs --no-cache -t kapitan-docs .
@@ -66,4 +62,4 @@ local_serve_documentation:
 .PHONY: mkdocs_gh_deploy
 mkdocs_gh_deploy: # to run locally assuming git ssh access
 	docker build -f Dockerfile.docs --no-cache -t kapitan-docs .
-	docker run --rm -it -v $(PWD):/src -v ~/.ssh:/root/.ssh -w /src kapitan-docs gh-deploy -f ./mkdocs.yml
+	docker run --rm -it -v $(PWD):/src -v ~/.ssh:/root/.ssh -w /src kapitan-docs gh-deploy -f ./mkdocs.yml

Pipfile

@@ -16,7 +16,6 @@ boto3 = ">=1.17.101"
 requests = "==2.25.0"
 addict = "==2.2.1"
 yamllint = ">=1.23.0"
-cffi = "*"
 rfc3987 = "==1.3.8"
 hvac = "==0.10.5"
 docker = "==4.3.1"

docs/compile.md

@@ -305,9 +305,8 @@ parameters:
       helm_values_files:
         - <values_file_path>
       helm_params:
+	name: <chart_release_name>
       	namespace: <substitutes_.Release.Namespace>
-      	name_template: <namespace_template>
-      	release_name: <chart_release_name>
     - name: add-metadata-test-1
       input_type: kadet
       output_path: ${test_1:output_path}
@@ -358,11 +357,13 @@ parameters:
         <object_with_values_to_override>
       helm_values_files:
         - <values_file_path>
+      helm_path: <helm binary>
       helm_params:
+        name: <chart_release_name>
         namespace: <substitutes_.Release.Namespace>
-        name_template: <namespace_template>
-        release_name: <chart_release_name>
-      kube_version: <target_kubernetes_version_string>
+        output_file: <string>
+        validate: true
+        …
 ```
 
 `helm_values` is an object containing values specified that will override the default values in the input chart. This has exactly the same effect as specifying `--values custom_values.yml` for `helm template` command where `custom_values.yml` structure mirrors that of `helm_values`.
@@ -372,21 +373,30 @@ If the same keys exist in `helm_values` and in multiple specified `helm_values_f
 There is an example in the tests. The `monitoring-dev`(kapitan/tests/test_resources/inventory/targets/monitoring-dev.yml) and `monitoring-prd`(kapitan/tests/test_resources/inventory/targets/monitoring-prd.yml) targets  both use the `monitoring`(tests/test_resources/inventory/classes/component/monitoring.yml) component.
 This component has helm chart input and takes a `common.yml` helm_values file which is "shared" by any target that uses the component and it also takes a dynamically defined file based on a kapitan variable defined in the target.
 
-`helm_params` correspond to the options for `helm template` as follows:
+`helm_path` can be use to provide the helm binary name or path.
+`helm_path` defaults to the value of `KAPITAN_HELM_PATH` env var if it is set, else it defaults to `helm`
 
-- namespace: equivalent of `--namespace` option: note that due to the restriction on `helm template` command, specifying the namespace does not automatically add `metadata.namespace` property to the resources. Therefore, users are encourage to explicitly specify in all resources:
+`helm_params` correspond to the flags for `helm template`. Most flags that helm supports can be used here by replacing '-' by '_' in the flag name.
+
+Flags without argument must have a boolean value, all other flags require a string value.
+
+Special flags:
+
+- `name`: equivalent of helm template `[NAME]` parameter. Ignored if `name_template` is also specified. If neither `name_template` nor `name` are specified, the `--generate-name` flag is used to generate a name.
+- `output_file`: name of the single file used to output all the generated resources. This is equivalent to call `helm template` without specifing output dir. If not specified, each resource is generated into a distinct file.
+
+- `include_crds` and `skip_tests`: These flags are enabled by default and should be set to `false` to be removed.
+- `debug`: prints the helm debug output in kapitan debug log.
+- `namespace`: note that due to the restriction on `helm template` command, specifying the namespace does not automatically add `metadata.namespace` property to the resources. Therefore, users are encouraged to explicitly specify it in all resources:
 
     ```yaml
     metadata:
       namespace: {{ .Release.Namespace }} # or any other custom values
     ```
 
-- name_template: equivalent of `--name-template` option
-- release_name: equivalent of `--name` option
 
-See the [helm doc](https://helm.sh/docs/helm/#helm-template) for further detail.
+See the [helm doc](https://helm.sh/docs/helm/helm_template/) for further detail.
 
-`kube_version` optionally specifies the Kubernetes version to target when rendering the manifests from the chart, for example "1.16". As some charts generate manifests slightly differently depending on the target Kubernetes version (e.g. targeting different APIs), it may be useful to target a specific version. When not specified, the default version used is "1.12".
 
 #### Example
 
@@ -417,7 +427,7 @@ parameters:
             image:
               repository: custom_repo
         helm_params:
-          release_name: my-first-release-name
+          name: my-first-release-name
           namespace: my-first-namespace
 ```
 

docs/external_dependencies.md

@@ -171,7 +171,10 @@ Setting `unpack: True` will unpack zip or tar files onto the `output_path`. In s
 ## Helm type
 
 Fetches helm charts and any specific subcharts in the `requirements.yaml` file.
-Currently only works on linux with the `helm_fetch_binding`.
+
+`helm_path` can be used to specify where the `helm` binary name or path.
+It defaults to the value of the `KAPITAN_HELM_PATH` environment var or simply to `helm` if neither is set.
+You should specify only if you don't want the default behavior.
 
 ### Usage
 
@@ -184,6 +187,7 @@ parameters:
       source: http[s]://<helm_chart_repository_url>
       version: <specific chart version>
       chart_name: <name of chart>
+      helm_path: <helm binary>
 ```
 
 
@@ -213,8 +217,7 @@ parameters:
             enabled: false
         helm_params:
           namespace: monitoring
-          name_template: prometheus
-          release_name: prometheus
+          name: prometheus
 ```
 
 Then run:
@@ -266,8 +269,7 @@ parameters:
             enabled: false
         helm_params:
           namespace: monitoring
-          name_template: prometheus
-          release_name: prometheus
+          name: prometheus
 ```
 
 Then run: