From e17e4ce32d79bd6e31d7213b82864b620f7bb771 Mon Sep 17 00:00:00 2001
From: alec-brooks <alec.e.brooks@gmail.com>
Date: Wed, 6 Sep 2023 08:08:49 +0900
Subject: [PATCH] Helm deployment (#351)

This is a duplicate of the kustomize deployment, and should be
equivalent.

This will be a first step towards enabling Helm adoption for deployment
to non local k8s
---
 deployment/helm/Chart.yaml                   |  7 ++
 deployment/helm/README.md                    | 26 ++++++
 deployment/helm/schema                       |  1 +
 deployment/helm/templates/db-migrate.yml     | 38 +++++++++
 deployment/helm/templates/ftl-controller.yml | 87 ++++++++++++++++++++
 deployment/helm/templates/ftl-runner.yml     | 41 +++++++++
 deployment/helm/templates/pg-cluster.yaml    | 59 +++++++++++++
 deployment/helm/values.yaml                  |  6 ++
 8 files changed, 265 insertions(+)
 create mode 100644 deployment/helm/Chart.yaml
 create mode 100644 deployment/helm/README.md
 create mode 120000 deployment/helm/schema
 create mode 100644 deployment/helm/templates/db-migrate.yml
 create mode 100644 deployment/helm/templates/ftl-controller.yml
 create mode 100644 deployment/helm/templates/ftl-runner.yml
 create mode 100644 deployment/helm/templates/pg-cluster.yaml
 create mode 100644 deployment/helm/values.yaml

diff --git a/deployment/helm/Chart.yaml b/deployment/helm/Chart.yaml
new file mode 100644
index 0000000000..9f8b3ab39b
--- /dev/null
+++ b/deployment/helm/Chart.yaml
@@ -0,0 +1,7 @@
+apiVersion: v2
+name: ftl
+description: A Helm chart for FTL
+
+type: application
+
+version: 0.1.0
diff --git a/deployment/helm/README.md b/deployment/helm/README.md
new file mode 100644
index 0000000000..c8d0aa9283
--- /dev/null
+++ b/deployment/helm/README.md
@@ -0,0 +1,26 @@
+# Apply Helm to K3D
+
+Create a K3D cluster:
+```
+k3d registry create registry.localhost --port 5000
+k3d cluster create --api-port 6550 -p "8892:80@loadbalancer" --agents 2 \
+    --registry-use k3d-registry.localhost:5000 \
+    --registry-config <(cat <<EOF
+mirrors:
+  "localhost:5000":
+    endpoint:
+      - http://k3d-registry.localhost:5000
+EOF
+)
+```
+
+As kubegres does not have Helm Charts, for now the CRDs need to be added manually.
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/reactive-tech/kubegres/v1.16/kubegres.yaml
+```
+
+Once that is done the Helm Charts can be installed
+```bash
+helm install ftl .
+```
\ No newline at end of file
diff --git a/deployment/helm/schema b/deployment/helm/schema
new file mode 120000
index 0000000000..e8a08ff11a
--- /dev/null
+++ b/deployment/helm/schema
@@ -0,0 +1 @@
+../../backend/controller/internal/sql/schema
\ No newline at end of file
diff --git a/deployment/helm/templates/db-migrate.yml b/deployment/helm/templates/db-migrate.yml
new file mode 100644
index 0000000000..668ceea3cf
--- /dev/null
+++ b/deployment/helm/templates/db-migrate.yml
@@ -0,0 +1,38 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: ftl-db-migrate
+spec:
+  template:
+    spec:
+      containers:
+      - name: ftl-db-migrate
+        image: "ghcr.io/amacneil/dbmate:latest"
+        command: ["dbmate", "up"]
+        env:
+        - name: DATABASE_URL
+          value: "postgres://postgres:secret@ftl-pg-cluster/ftl?sslmode=disable"
+        - name: DBMATE_MIGRATIONS_DIR
+          value: /etc/ftl-migrations
+        volumeMounts:
+        - name: ftl-db-migrate-config
+          mountPath: /etc/ftl-migrations
+      restartPolicy: OnFailure
+      volumes:
+        - name: ftl-db-migrate-config
+          configMap:
+            name: ftl-db-migrate-config
+  parallelism: 1
+  backoffLimit: 1000
+  ttlSecondsAfterFinished: 300
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ftl-db-migrate-config
+data:
+  {{- $files := .Files }}
+  {{- range tuple "001_init.sql" }}
+  {{ . }}: |-
+{{ $files.Get (printf "schema/%s" .) | nindent 4 }}
+  {{- end }}
diff --git a/deployment/helm/templates/ftl-controller.yml b/deployment/helm/templates/ftl-controller.yml
new file mode 100644
index 0000000000..824bd5eae9
--- /dev/null
+++ b/deployment/helm/templates/ftl-controller.yml
@@ -0,0 +1,87 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ftl-controller
+  labels:
+    app: ftl-controller
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: ftl-controller
+  template:
+    metadata:
+      labels:
+        app: ftl-controller
+    spec:
+      containers:
+        - name: app
+          image: "{{ .Values.ftlController.image }}:{{ .Values.ftlController.tag }}"
+          env:
+            - name: MY_POD_IP
+              valueFrom:
+                fieldRef:
+                  fieldPath: status.podIP
+            - name: FTL_CONTROLLER_DSN
+              value: "postgres://ftl-pg-cluster/ftl?sslmode=disable&user=postgres&password=secret"
+            - name: FTL_CONTROLLER_BIND
+              value: "http://$(MY_POD_IP):8892"
+            - name: FTL_CONTROLLER_ADVERTISE
+              value: ""
+          ports:
+            - containerPort: 8892
+          readinessProbe:
+            httpGet:
+              path: /healthz
+              port: 8892
+            initialDelaySeconds: 1
+            periodSeconds: 2
+            timeoutSeconds: 2
+            successThreshold: 1
+            failureThreshold: 15
+---
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: ftl-controller
+  name: ftl-controller
+spec:
+  ports:
+    - name: 80-8892
+      port: 80
+      protocol: TCP
+      targetPort: 8892
+  selector:
+    app: ftl-controller
+  type: ClusterIP
+#---
+#apiVersion: autoscaling/v2
+#kind: HorizontalPodAutoscaler
+#metadata:
+#  name: ftl-controller
+#spec:
+#  scaleTargetRef:
+#    apiVersion: apps/v1
+#    kind: Deployment
+#    name: ftl-controller
+#  minReplicas: 1
+#  maxReplicas: 10
+---
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: ftl-controller
+  annotations:
+    ingress.kubernetes.io/ssl-redirect: "false"
+spec:
+  rules:
+    - http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: ftl-controller
+                port:
+                  number: 80
diff --git a/deployment/helm/templates/ftl-runner.yml b/deployment/helm/templates/ftl-runner.yml
new file mode 100644
index 0000000000..1bf9c05c63
--- /dev/null
+++ b/deployment/helm/templates/ftl-runner.yml
@@ -0,0 +1,41 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ftl-runner
+  labels:
+    app: ftl-runner
+spec:
+  replicas: 10
+  selector:
+    matchLabels:
+      app: ftl-runner
+  template:
+    metadata:
+      labels:
+        app: ftl-runner
+    spec:
+      containers:
+        - name: app
+          image: "{{ .Values.ftlRunner.image }}:{{ .Values.ftlRunner.tag }}"
+          env:
+            - name: MY_POD_IP
+              valueFrom:
+                fieldRef:
+                  fieldPath: status.podIP
+            - name: FTL_ENDPOINT
+              value: http://ftl-controller
+            - name: FTL_RUNNER_BIND
+              value: "http://$(MY_POD_IP):8893"
+            - name: FTL_RUNNER_ADVERTISE
+              value: ""
+          ports:
+            - containerPort: 8893
+          readinessProbe:
+            httpGet:
+              path: /healthz
+              port: 8893
+            initialDelaySeconds: 1
+            periodSeconds: 2
+            timeoutSeconds: 2
+            successThreshold: 1
+            failureThreshold: 15
diff --git a/deployment/helm/templates/pg-cluster.yaml b/deployment/helm/templates/pg-cluster.yaml
new file mode 100644
index 0000000000..af9ef4d3ec
--- /dev/null
+++ b/deployment/helm/templates/pg-cluster.yaml
@@ -0,0 +1,59 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: pg-secret
+  namespace: default
+type: Opaque
+stringData:
+  superUserPassword: "secret"
+  replicationUserPassword: "postgresReplicaPsw"
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ftl-pg-cluster-conf
+  namespace: default
+
+data:
+
+  primary_init_script.sh: |
+    #!/bin/bash
+    set -e
+
+    echo "Running init script the 1st time Primary PostgreSql container is created...";
+    echo "Running: psql -v ON_ERROR_STOP=1 --username $POSTGRES_USER --dbname $POSTGRES_DB ...";
+
+    psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
+    CREATE DATABASE ftl;
+    CREATE USER ftl WITH PASSWORD 'secret';
+    GRANT ALL PRIVILEGES ON DATABASE "ftl" to ftl;
+    EOSQL
+
+    echo "Init script is completed";
+---
+apiVersion: kubegres.reactive-tech.io/v1
+kind: Kubegres
+metadata:
+  name: ftl-pg-cluster
+  namespace: default
+spec:
+   replicas: 1
+   image: postgres:14.1
+
+   database:
+      size: 200Mi
+
+   customConfig: ftl-pg-cluster-conf
+
+   env:
+      - name: POSTGRES_PASSWORD
+        valueFrom:
+           secretKeyRef:
+              name: pg-secret
+              key: superUserPassword
+
+      - name: POSTGRES_REPLICATION_PASSWORD
+        valueFrom:
+           secretKeyRef:
+              name: pg-secret
+              key: replicationUserPassword
diff --git a/deployment/helm/values.yaml b/deployment/helm/values.yaml
new file mode 100644
index 0000000000..b9364bbade
--- /dev/null
+++ b/deployment/helm/values.yaml
@@ -0,0 +1,6 @@
+ftlController:
+  image: ghcr.io/tbd54566975/ftl-controller
+  tag: latest
+ftlRunner:
+  image: ghcr.io/tbd54566975/ftl-runner
+  tag: latest
\ No newline at end of file