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.6.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.30.0"

helm/README.md

@@ -0,0 +1,108 @@
+# MetacatUI Helm chart
+
+This is a helm chart for deploying MetacatUI.
+
+---
+
+## 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, unless you wish to add your own theme. The chart
+ships with [a few pre-defined themes](https://github.com/NCEAS/metacatui/tree/main/src/js/themes),
+which can be selected in values.yaml.
+
+---
+## MetacatUI Configuration Files ('config.js')
+
+The k8s version of Metacatui requires two 'config.js' configuration files:
+1. the "root config" at the path `{root}/config/config.js`, and
+2. the "theme config" in the theme directory itself (for example, see the knb `config.js` at:
+    https://github.com/NCEAS/metacatui/blob/main/src/js/themes/knb/config.js)
+
+The "root config" file must, at an absolute minimum, contain the name of the theme to be used; e.g:
+
+```javascript
+MetacatUI.AppConfig = {
+  theme: "knb",
+};
+```
+...and metacatui will then load that theme and the corresponding "theme config".
+
+If any additional settings are defined in the "root config", Metacatui will use them to override
+corresponding settings in the "theme config".
+
+By default, this chart creates a simple "root config", which will contain any values of the form:
+`key: stringValue,` or `key: intValue,` that are provided in the `appConfig:` section of
+[values.yaml](./values.yaml).
+
+If you need to provide more-complex overrides, set `appConfig.enabled: false`, and manually
+create your own configMap named `<YourReleaseName>-metacatui-config-js`, containing your custom
+config.js:
+```shell
+kubectl create configmap  <yourReleaseName>-metacatui-config-js \
+        --from-file=config.js=<yourCustomConfig.js>
+```
+---
+
+## Using a Custom Theme
+
+See [the MetacatUI
+documentation](https://nceas.github.io/metacatui/install/configuration/index.html) for help with
+creating custom themes.
+
+If you wish to deploy MetacatUI with your own custom theme, instead of using one of the themes that
+are bundled with metacatui, you will need to provide the files for that theme (including its
+"theme config" file) on shared filesystem, accessed via a manually-created Persistent Volume (PV)
+mount and a Persistent Volume Claim (PVC). Example files for creating PVs and PVCs are provided
+in the [admin](./admin) directory.
+
+Once you've got the chart deployed (see above), next steps are:
+
+1. Copy your theme files to a directory on a filesystem that is accessible from your Kubernetes
+   cluster
+2. Create a Persistent Volume (PV) pointing to the correct directory on the filesystem
+3. Create a PVC for the PV, and edit the `customTheme:` section in values.yaml
+4. upgrade the helm chart
+   ```shell
+   $ helm -n knb upgrade --install knbmcui ./helm
+
+---
+
+## Development on Localhost
+
+(e.g. Rancher Desktop/Docker Desktop)
+
+1. Create a namespace for the deployment (e.g. `mcui`)
+2. Create a PV that is mapped to a local `hostPath` directory containing the source code
+3. Create a PVC for the PV
+4. Modify values.yaml:
+   1. Add the name of the PVC, so MetacatUI can find the files
+   2. Set your hostname for the Ingress definition
+5. 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
+   ...etc
+
+You can now edit the MetacatUI source files, and changes will be immediately visible in your k8s
+deployment.
+
+You will likely need to edit the `config.js` file to get a minimal setup working. Example contents
+for `config/config.js`:
+
+```javascript
+MetacatUI.AppConfig = {
+  root: "/",
+  baseUrl: "https://dev.nceas.ucsb.edu/knb/d1/mn",
+};
+```

helm/admin/metacatui-customtheme-pv.yaml

@@ -0,0 +1,30 @@
+## EXAMPLE file for manually creating a Persistent Volume to store a metacatui custom theme.
+## Needed only if 'customTheme.enabled:' is set to 'true' in values.yaml.
+## EDIT this file to replace "$RELEASENAME", "$YOUR-CLUSTER-ID" and the "rootPath"
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+  # See https://github.com/DataONEorg/k8s-cluster/blob/main/storage/storage.md#dataone-volume-naming-conventions
+  # cephs-{release}-{function}-{instance}, where {release} usually = {namespace}
+  name: &pv-name cephfs-$RELEASENAME-metacatui-customtheme
+spec:
+  accessModes:
+    - ReadOnlyMany
+  capacity:
+    storage: 100Mi
+  csi:
+    driver: cephfs.csi.ceph.com
+    nodeStageSecretRef:
+      # node stage secret name
+      name: csi-cephfs-$RELEASENAME-secret
+      # node stage secret namespace where above secret is created
+      namespace: ceph-csi-cephfs
+    volumeAttributes:
+      clusterID: $YOUR-CLUSTER-ID
+      fsName: cephfs
+      rootPath: /volumes/YOUR-subvol-group/YOUR-subvol/YOUR-ID/repos/YOUR_REPO/metacatui
+      staticVolume: "true"
+    volumeHandle: *pv-name
+  persistentVolumeReclaimPolicy: Retain
+  storageClassName: csi-cephfs-sc
+  volumeMode: Filesystem

helm/admin/metacatui-customtheme-pvc.yaml

@@ -0,0 +1,20 @@
+## EXAMPLE file for manually creating a Persistent Volume Claim to access the PV containing a
+## metacatui custom theme.
+## Needed only if 'customTheme.enabled:' is set to 'true' in values.yaml.
+## EDIT this file to replace "$RELEASENAME" and "$NAMESPACE"
+##
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: $RELEASENAME-metacatui-customtheme
+  ## NOTE: namespace must match the deployment namespace
+  namespace: $NAMESPACE
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 100Mi
+  storageClassName: csi-cephfs-sc
+  volumeMode: Filesystem
+  volumeName: cephfs-RELEASENAME-metacatui-customtheme

helm/admin/metacatui-sourcecode-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-sourcecode-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" "theme" "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 -}}
+  {{- include "metacatui.cn.url" . | nindent 4 }}
+  theme: {{ required "metacatUiThemeName_is_REQUIRED" .Values.global.metacatUiThemeName | quote }},
+  root: {{ required "root_is_REQUIRED" .Values.global.metacatUiWebRoot | 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 }}