Basic Helm Chart Support

.github/workflows/helm.yml

@@ -0,0 +1,41 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'v*.x'
+    tags:
+      - 'v*'
+  workflow_dispatch:
+  pull_request:
+    types: [assigned]
+jobs:
+  release:
+    # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
+    # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+
+      - name: Install Helm
+        uses: azure/setup-helm@v3
+      - name: Add repositories
+        run: |
+          for dir in $(ls -d charts/*/); do
+            helm dependency list $dir 2> /dev/null | tail +2 | head -n -1 | awk '{ print "helm repo add " $1 " " $3 }' | while read cmd; do $cmd; done
+          done
+      - name: Run chart-releaser
+        uses: helm/chart-releaser-action@v1.6.0
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/test-k8s.yaml

@@ -0,0 +1,90 @@
+name: K8S Integration test
+
+on:
+  push:
+    branches:
+    - master
+    - develop
+  pull_request:
+    types: [assigned]
+  workflow_dispatch:
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    permissions:
+      checks: write # for coverallsapp/github-action to create new checks
+      contents: read # for actions/checkout to fetch code
+    name: K8S Integration test
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Install kubectl
+      uses: azure/setup-kubectl@v3
+    - name: Install Helm
+      uses: azure/setup-helm@v3
+    - name: Create k3d cluster
+      uses: stevefan1999-personal/k3d-action@main
+      with:
+        cluster-name: "nodebb-test"
+        args: --agents 0 -i ghcr.io/jlian/k3d-nfs:v1.25.3-k3s1
+    - name: Install NFS Server Provisioner
+      run: |
+        kubectl patch storageclass local-path -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"false"}}}'
+        helm repo add nfs-ganesha-server-and-external-provisioner https://kubernetes-sigs.github.io/nfs-ganesha-server-and-external-provisioner/
+        helm install -n kube-system nfs-provisioner nfs-ganesha-server-and-external-provisioner/nfs-server-provisioner \
+          --set persistence.storageClass=local-path \
+          --set persistence.enabled=true \
+          --set persistence.size=20Gi \
+          --set storageClass.defaultClass=true
+    - name: Install Verdaccio
+      run: |
+        helm repo add verdaccio https://charts.verdaccio.org
+        helm install npm verdaccio/verdaccio \
+          --set persistence.storageClass=local-path \
+          --set persistence.enabled=true \
+          --set persistence.size=20Gi
+    - name: Add charts repositories
+      run: |
+        for dir in $(ls -d charts/*/); do
+          helm dependency list $dir 2> /dev/null | tail +2 | head -n -1 | awk '{ print "helm repo add " $1 " " $3 }' | while read cmd; do $cmd; done
+        done
+    - name: Build NodeBB chart dependencies
+      run: |
+        cd ./charts/nodebb
+        helm dependency build
+    - name: Install example NodeBB chart based on Redis
+      run: |
+        cd ./charts/nodebb
+        helm upgrade --create-namespace -n redis --install redis-test . -f ./values.yaml -f ./values.example.redis.yaml --set env[0].name=NPM_CONFIG_REGISTRY --set env[0].value=http://npm-verdaccio.default:4873/
+        kubectl wait pod -n redis --all --for=condition=Ready --timeout=30m
+        helm uninstall -n redis redis-test --wait
+    - name: Install example NodeBB chart based on Mongo
+      run: |
+        cd ./charts/nodebb
+        helm upgrade --create-namespace -n mongo --install mongo-test . -f ./values.yaml -f ./values.example.mongo.yaml --set env[0].name=NPM_CONFIG_REGISTRY --set env[0].value=http://npm-verdaccio.default:4873/
+        kubectl wait pod -n mongo --all --for=condition=Ready --timeout=30m
+        helm uninstall -n mongo mongo-test --wait
+    - name: Install example NodeBB chart based on Postgres
+      run: |
+        cd ./charts/nodebb
+        helm upgrade --create-namespace -n postgres --install postgres-test . -f ./values.yaml -f ./values.example.postgres.yaml --set env[0].name=NPM_CONFIG_REGISTRY --set env[0].value=http://npm-verdaccio.default:4873/
+        kubectl wait pod -n postgres --all --for=condition=Ready --timeout=30m
+        helm uninstall -n postgres postgres-test --wait
+    - name: Remove all PVC and pods
+      if: always()
+      run: |
+        helm uninstall npm --wait
+        kubectl delete pvc --all -n redis --wait
+        kubectl delete pvc --all -n mongo --wait
+        kubectl delete pvc --all -n postgres --wait
+        helm uninstall -n kube-system nfs-provisioner --wait

Dockerfile

@@ -29,6 +29,11 @@ RUN if [ $BUILDPLATFORM != $TARGETPLATFORM ]; then \
 
 FROM node:lts-slim as run
 
+RUN apt update && apt install -y --no-install-recommends \
+    jq && \
+    apt clean && \
+    rm -rf /var/lib/apt/lists/*
+
 ARG NODE_ENV
 ENV NODE_ENV=$NODE_ENV \
     daemon=false \

charts/nodebb/.gitignore

@@ -0,0 +1,2 @@
+charts/
+.template

charts/nodebb/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/nodebb/Chart.lock

@@ -0,0 +1,12 @@
+dependencies:
+- name: redis
+  repository: https://charts.bitnami.com/bitnami
+  version: 18.4.0
+- name: mongodb
+  repository: https://charts.bitnami.com/bitnami
+  version: 14.3.1
+- name: postgresql
+  repository: https://charts.bitnami.com/bitnami
+  version: 13.2.18
+digest: sha256:f40e655ad5f8de0fa41e192bf64fecfdf157e4310fb3e62b6eea1e9cac3dfe2f
+generated: "2023-12-04T10:58:35.1043994+08:00"

charts/nodebb/Chart.yaml

@@ -0,0 +1,19 @@
+apiVersion: v2
+name: nodebb
+description: A Helm chart for NodeBB
+type: application
+version: 0.1.0
+appVersion: "3.6.0"
+dependencies:
+- name: redis
+  version: 18.4.0
+  repository: https://charts.bitnami.com/bitnami
+  condition: global.redis.managed
+- name: mongodb
+  version: 14.3.1
+  repository: https://charts.bitnami.com/bitnami
+  condition: global.mongodb.managed
+- name: postgresql
+  version: 13.2.18
+  repository: https://charts.bitnami.com/bitnami
+  condition: global.postgresql.managed

charts/nodebb/Justfile

@@ -0,0 +1,20 @@
+set shell := ["pwsh", "-c"]
+
+name := "nodebb"
+chart := "."
+namespace := "nodebb"
+config := "values.yaml"
+
+init:
+    @helm repo add nodebb https://nodebb.github.io/helm-charts
+    @helm repo update
+
+install:
+    @helm upgrade --install --create-namespace -n {{namespace}} {{name}} {{chart}} -f {{config}}
+
+template:
+    @rm -Re -Fo -ErrorAction SilentlyContinue .template; exit 0
+    @helm template -n {{namespace}} {{name}} {{chart}} -f {{config}} --output-dir .template --debug
+
+uninstall:
+    @helm uninstall -n {{namespace}} {{name}}

charts/nodebb/templates/NOTES.txt

@@ -0,0 +1,23 @@
+{{- $domain := .Values.nodebb.domain -}}
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $domain }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "nodebb.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "nodebb.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "nodebb.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "nodebb.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

charts/nodebb/templates/_helpers.tpl

@@ -0,0 +1,82 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "nodebb.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "nodebb.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "nodebb.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "nodebb.labels" -}}
+helm.sh/chart: {{ include "nodebb.chart" . }}
+{{ include "nodebb.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "nodebb.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "nodebb.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "nodebb.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (printf "%s-sa" (include "nodebb.fullname" .)) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{- define "nodebb.basePvcConfig" -}}
+{{- if .args.enabled -}}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ printf "%s-%s" (include "nodebb.fullname" .global) .suffix }}
+  labels:
+    {{- toYaml .args.labels | nindent 4 }}
+  annotations:
+    {{- toYaml .args.annotations | nindent 4 }}
+spec:
+  storageClassName: {{ .args.storageClass }}
+  resources:
+    requests:
+      storage: {{ .args.size }}
+  accessModes: {{ .args.accessModes }}
+---
+{{- end -}}
+{{- end }}