Feature 2368 helm k8s

helm/.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/

helm/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: metacatui
+description: MetacatUI, a web interface for DataONE repositories
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.5.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "2.29.1"

helm/README.md

@@ -0,0 +1,47 @@
+# MetacatUI Helm chart
+
+This is a simple helm chart for debugging a MetacatUI deployment. 
+
+## Steps to get started for deployment in a Kubernetes cluster:
+
+1. modify values.yaml as appropriate
+2. install the helm chart:
+
+```shell
+$ helm -n knb upgrade --install knbmcui ./helm
+```
+There's no need to set up any persistent storage - the chart will automatically check out the 
+metacatui static content from GitHub, and install it on an "emptyDir" that is automatically 
+created for you. 
+
+
+## Steps to get started for development on localhost (e.g. Rancher Desktop/Docker Desktop):
+
+0. Create a namespace `mcui` for the deployment (or pick another of your liking)
+1. Create a PV that is mapped to a local `hostPath` directory that contains the web files to deploy
+2. Create a PVC for the PV
+3. Create a nginx deployment behind an ingress that mounts the PVC where nginx expects its web files to live
+
+To deploy this, you need to 1) create the PV and PVC for your system layout, 2) modify the values.yaml to your hostname for the Ingress definition, and 3) install the helm chart:
+
+```shell
+$ helm -n mcui upgrade --install --debug mcui ./helm
+Release "mcui" has been upgraded. Happy Helming!
+NAME: mcui
+LAST DEPLOYED: Wed Apr 17 19:45:58 2024
+NAMESPACE: mcui
+STATUS: deployed
+REVISION: 11
+NOTES:
+1. Get the application URL by running these commands:
+  http://firn.local/
+```
+
+You can now edit the MetacatUI files and changes will be immediately visible in your chart. You will likely need to edit the `config.js` file to get a minimal setup working.  For example, I used the `config/config.js` with these contents:
+
+```javascript
+MetacatUI.AppConfig = {
+      root: "/",
+      baseUrl: "https://dev.nceas.ucsb.edu/knb/d1/mn"
+}
+```

helm/admin/metacatui-pv.yaml

@@ -0,0 +1,18 @@
+## EXAMPLE file for manually creating a Persistent Volume to store the metacatui source code,
+## typically for development purposes (so edits can be seen in realtime).
+## Needed only if 'source.from:' is set to 'pvc' in values.yaml.
+##
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: metacatui-pv
+spec:
+  accessModes:
+  - ReadWriteOnce
+  capacity:
+    storage: 10Gi
+  hostPath:
+    path: /your/host/path/here    # e.g. /Users/jones/development/metacatui/src
+    type: ""
+  persistentVolumeReclaimPolicy: Retain
+  volumeMode: Filesystem

helm/admin/metacatui-pvc.yaml

@@ -0,0 +1,18 @@
+## EXAMPLE file for manually creating a Persistent Volume Claim to access the PV containing the
+## metacatui source code (see metacatui-pv.yaml), typically for development purposes.
+## Needed only if 'source.from:' is set to 'pvc' in values.yaml.
+##
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: metacatui-pvc
+  namespace: mcui
+spec:
+  accessModes:
+  - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+  storageClassName: ""
+  volumeMode: Filesystem
+  volumeName: metacatui-pv

helm/config/config.js

@@ -0,0 +1,17 @@
+MetacatUI.AppConfig = {
+  {{- $ignoreList := list "enabled" "root" "baseUrl" "metacatContext" "d1CNBaseUrl" -}}
+  {{- range $key, $value := .Values.appConfig }}
+      {{- if not (has $key $ignoreList) }}
+          {{- if eq (typeOf $value) "string" }}
+              {{- $key | nindent 4 }}: {{ $value | quote }},
+          {{- else }}
+              {{- $key | nindent 4 }}: {{ $value }},
+          {{- end }}
+      {{- end }}
+  {{- end -}}
+  {{/* These go last, so we can handle the trailing comma */}}
+  {{- include "metacatui.cn.url" . | nindent 4 }}
+  root: {{ required "root_is_REQUIRED" .Values.appConfig.root | quote }},
+  metacatContext: {{ required "metacatAppContext_is_REQUIRED" .Values.global.metacatAppContext | quote }},
+  baseUrl: {{ required "metacatExternalBaseUrl_is_REQUIRED"  .Values.global.metacatExternalBaseUrl | quote }}
+}

helm/templates/NOTES.txt

@@ -0,0 +1,22 @@
+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 }}://{{ $host.host }}{{ .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 "metacatui.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 "metacatui.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "metacatui.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 "metacatui.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 }}

helm/templates/_helpers.tpl

@@ -0,0 +1,80 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "metacatui.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 "metacatui.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 "metacatui.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "metacatui.labels" -}}
+helm.sh/chart: {{ include "metacatui.chart" . }}
+{{ include "metacatui.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "metacatui.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "metacatui.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "metacatui.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "metacatui.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Populate the dataone cn url
+*/}}
+{{- define "metacatui.cn.url" -}}
+{{- $d1ClientCnUrl := .Values.global.d1ClientCnUrl }}
+{{- if $d1ClientCnUrl }}
+{{- if not (hasSuffix "/" $d1ClientCnUrl) -}}
+  {{- $d1ClientCnUrl = print $d1ClientCnUrl "/" -}}
+{{- end -}}
+{{- $baseCnURL := regexFind "http.?://[^/]*/" $d1ClientCnUrl }}
+{{- if not $baseCnURL }}
+d1CNBaseUrl: "ERROR_IN_URL__{{ $d1ClientCnUrl }}",
+{{- else }}
+d1CNBaseUrl: "{{ $baseCnURL }}",
+{{- end }}
+{{- end }}
+{{- end }}

helm/templates/configmap.yaml

@@ -0,0 +1,9 @@
+# Load all files in the "config" directory into a ConfigMap
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ .Release.Name }}-metacatui-configjs
+  labels:
+    {{- include "metacatui.labels" . | nindent 4 }}
+data:
+{{ (tpl (.Files.Glob "config/*").AsConfig . ) | nindent 4 }}

helm/templates/deployment.yaml

@@ -0,0 +1,125 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "metacatui.fullname" . }}
+  labels:
+    {{- include "metacatui.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "metacatui.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "metacatui.labels" . | nindent 8 }}
+        {{- with .Values.podLabels }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "metacatui.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      {{- if not (eq .Values.source.from "pvc") }}
+      initContainers:
+        {{- if (eq .Values.source.from "git") }}
+        - name: git-clone
+          image: alpine/git:latest
+          command:
+            - sh
+            - -c
+            - >
+              start=$(date +%s);
+              git clone -b {{ .Values.source.git.revision }} --depth 1 {{ .Values.source.git.repoUrl }} /metacatui;
+              finish=$(date +%s);
+              echo "git clone -b {{ .Values.source.git.revision }} took $((finish - start)) sec";
+        {{- else }}
+        - name: get-source
+          image: busybox:latest
+          command:
+            - sh
+            - -c
+            - >
+              start=$(date +%s);
+              VERSION={{ .Values.source.package.version | default .Chart.AppVersion }}
+              FILENAME=$VERSION.zip;
+              wget -O ./$FILENAME {{ .Values.source.package.location }}/$FILENAME;
+              unzip $FILENAME -d /tmp/;
+              mv /tmp/metacatui-$VERSION/*  /metacatui/;
+              finish=$(date +%s);
+              echo "$FILENAME download and install took $((finish - start)) sec";
+        {{- end }}
+          volumeMounts:
+            - name: {{ .Release.Name }}-mcui-source-files
+              mountPath: /metacatui
+      {{- end }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository | default "nginx" }}:
+                        {{- .Values.image.tag | default "latest" }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy | default "IfNotPresent" }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.service.port }}
+              protocol: TCP
+          {{- with .Values.livenessProbe }}
+          livenessProbe:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+          {{- with .Values.readinessProbe }}
+          readinessProbe:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+          volumeMounts:
+            {{- if .Values.appConfig.enabled }}
+            - name: {{ .Release.Name }}-mcui-config-vol
+              mountPath: /usr/share/nginx/html/config/config.js
+              subPath: config.js
+            {{- end }}
+            - name: {{ .Release.Name }}-mcui-source-files
+              mountPath: "/usr/share/nginx/html"
+              subPath: "src"
+          {{- with .Values.volumeMounts }}
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+      volumes:
+        {{- if .Values.appConfig.enabled }}
+        - name: {{ .Release.Name }}-mcui-config-vol
+          configMap:
+            name: {{ .Release.Name }}-metacatui-configjs
+            defaultMode: 0644
+        {{- end }}
+        {{- if not .Values.source.pvc }}
+        - name: {{ .Release.Name }}-mcui-source-files
+          emptyDir: {}
+        {{- else }}
+        {{- with .Values.volumes }}
+          {{- toYaml . | nindent 8 }}
+        {{- end }}
+        {{- end }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}