From afb6d4b490ea9361242f62f12813cb6782876aea Mon Sep 17 00:00:00 2001
From: Colin Johnson <1594843+colinbjohnson@users.noreply.github.com>
Date: Fri, 17 Jan 2025 02:11:57 -0800
Subject: [PATCH] add ability to support free entry of environment variables
 for nango-server (#10)

This PR addresses [Allow Arbitrary Environment Variables to be set for
nango-server](https://github.com/NangoHQ/nango-helm-charts/issues/9).
I've attached a screenshot of a basicauth login below:

<img width="1050" alt="nango-basicauth-login"
src="https://github.com/user-attachments/assets/be457c83-1f5e-4237-bc82-4fb51ecebb54"
/>

Note that there are a _number_ of ways to support environment variables
within helm charts - two options which I tested/considered are below:

1. Free-entry configuration - where a user would only provide an `env`
value that renders valid YAML. This is rendered utilizing the following:

```
{{- if .Values.server.env }}
{{- toYaml .Values.server.env | nindent 12 }}
{{- end }}
```

2. Iterative configuration (which is what I've seen used more
frequently) - where a user provides a list composed of `name` and
`value` or `valueFrom` fields which (I thought) offered a greater deal
of validation (see "A Note on Iterative Configuration" below).

# A Note on Iterative Configuration

I was open to utilizing this as it was/is common within the
kubernetes/helm community and a popular suggestion on AI sites. What I
discovered was this was _worse_ than simply accepting "free entry" as it
_modified_ the YAML but did not reject it - an example is below:

```
{{- range .Values.server.env }}
- name: {{ .name }}
  {{- if .value }}
  value: {{ .value | quote }}
  {{- else if .valueFrom }}
  valueFrom: {{ toYaml .valueFrom | nindent 16 }}
  {{- end }}
{{- end }}
```

When given:

```
env:
  - namea: FLAG_AUTH_ENABLED
    value: "false"
  - name: NANGO_DASHBOARD_USERNAME
    value: nango
  - name: NANGO_DASHBOARD_PASSWORD
    valueFroma:
      secretKeyRef:
        name: nango-secrets
        key: nango-dashboard-password
```

Would render:

```
- name:
  value: "false"
- name: NANGO_DASHBOARD_USERNAME
  value: "nango"
- name: NANGO_DASHBOARD_PASSWORD
```
---
 charts/nango/templates/server/server-deployment.yaml |  3 +++
 example-values.yaml                                  | 12 ++++++++++++
 2 files changed, 15 insertions(+)

diff --git a/charts/nango/templates/server/server-deployment.yaml b/charts/nango/templates/server/server-deployment.yaml
index 593a718..dd02880 100644
--- a/charts/nango/templates/server/server-deployment.yaml
+++ b/charts/nango/templates/server/server-deployment.yaml
@@ -72,6 +72,9 @@ spec:
                   key: mailgun-api-key
             - name: SERVER_PORT
               value: "{{ .Values.server.SERVER_PORT }}"
+            {{- if .Values.server.env }}
+            {{- toYaml .Values.server.env | nindent 12 }}
+            {{- end }}
           volumeMounts:
             {{- if .Values.shared.useVolumeForFlows }}
             - mountPath: {{ .Values.shared.flows_path }}
diff --git a/example-values.yaml b/example-values.yaml
index 0a1ba5c..c46c1a7 100644
--- a/example-values.yaml
+++ b/example-values.yaml
@@ -55,6 +55,18 @@ elasticsearch:
 server:
   name: nango-server
   replicas: 1
+  # you can set /any/ nango-server environment variable required utilizing the "env" key as follows:
+  # the example below shows a configuration to enable basic auth
+  # env:
+  #   - name: FLAG_AUTH_ENABLED
+  #     value: "false"
+  #   - name: NANGO_DASHBOARD_USERNAME
+  #     value: nango
+  #   - name: NANGO_DASHBOARD_PASSWORD
+  #     valueFrom:
+  #       secretKeyRef:
+  #         name: nango-secrets
+  #         key: nango-dashboard-password
 
 jobs:
   name: nango-jobs