render-helm-chart: Kustomize Values Files #

Overview #

This example demonstrates how to declaratively invoke the render-helm-chart function with kustomize using multiple values files.

Function invocation #

To use the function with kustomize, you can specify the functionConfig in your kustomization’s generators field. This example specifies multiple values files to use instead of the default values accompanying the chart. These values files can either be remote or local.

Remote values files #

Here is an example kustomization file with remote values files:

kustomization.yaml:

generators:
- |-
  apiVersion: fn.kpt.dev/v1alpha1
  kind: RenderHelmChart
  metadata:
    name: demo
    annotations:
      config.kubernetes.io/function: |
        container:
          network: true
          image: ghcr.io/kptdev/krm-functions-catalog/render-helm-chart:latest
  helmCharts:
  - chartArgs:
      name: ocp-pipeline
      version: 0.1.16
      repo: https://bcgov.github.io/helm-charts
    templateOptions:
      namespace: mynamespace
      releaseName: moria
      values:
        valuesFiles:
          - https://raw.githubusercontent.com/natasha41575/krm-functions-catalog/a9c9cd765a05f7a7fb6923dbde4651b62c9c229c/examples/render-helm-chart-kustomize-values-files/file1.yaml
          - https://raw.githubusercontent.com/natasha41575/krm-functions-catalog/a9c9cd765a05f7a7fb6923dbde4651b62c9c229c/examples/render-helm-chart-kustomize-values-files/file2.yaml

Then, to build the kustomization with kustomize v4:

kustomize build --enable-alpha-plugins --network .

Local values files #

If your values files are local, you must mount them into the /tmp directory of your container. If you mount them into some place other than under /tmp, you may get some permission issues.

You can download the example remote files to your local directory like so:

curl https://raw.githubusercontent.com/natasha41575/krm-functions-catalog/a9c9cd765a05f7a7fb6923dbde4651b62c9c229c/examples/render-helm-chart-kustomize-values-files/file1.yaml > file1.yaml
curl https://raw.githubusercontent.com/natasha41575/krm-functions-catalog/a9c9cd765a05f7a7fb6923dbde4651b62c9c229c/examples/render-helm-chart-kustomize-values-files/file2.yaml > file2.yaml

Your kustomization file with the local values files should look like this:

kustomization.yaml:

generators:
- |-
  apiVersion: fn.kpt.dev/v1alpha1
  kind: RenderHelmChart
  metadata:
    name: demo
    annotations:
      config.kubernetes.io/function: |
        container:
          network: true
          image: ghcr.io/kptdev/krm-functions-catalog/render-helm-chart:latest
          mounts:
            - type: bind
              src: ./file1.yaml
              dst: /tmp/file1.yaml
            - type: bind
              src: ./file2.yaml
              dst: /tmp/file2.yaml
  helmCharts:
  - chartArgs:
      name: ocp-pipeline
      version: 0.1.16
      repo: https://bcgov.github.io/helm-charts
    templateOptions:
      namespace: mynamespace
      releaseName: moria
      values:
        valuesFiles:
          - tmp/file1.yaml
          - tmp/file2.yaml

Then, to build the kustomization with kustomize v4:

kustomize build --enable-alpha-plugins --network .

Expected result #

You should also be able to find the line def releaseNamespace = "" somewhere in your output, as well as the following:

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: moria-ocp-pipeline
  namespace: mynamespace
rules:
- apiGroups:
  - ""
  resources:
  - '*'
  verbs:
  - '*'
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: moria-ocp-pipeline
  namespace: mynamespace
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: moria-ocp-pipeline
subjects:
- kind: ServiceAccount
  name: jenkins
  namespace: mynamespace

which demonstrates that the correct values provided via valuesFiles were used.