Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
artntek committed Jun 3, 2024
1 parent edda894 commit 3756462
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
21 changes: 17 additions & 4 deletions helm/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# MetacatUI Helm chart

This is a simple helm chart for debugging a MetacatUI deployment. It works by:
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
Expand All @@ -9,8 +23,8 @@ This is a simple helm chart for debugging a MetacatUI deployment. It works by:

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:

```bash
helm -n mcui upgrade --install mcui ./helm
```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
Expand All @@ -30,4 +44,3 @@ MetacatUI.AppConfig = {
baseUrl: "https://dev.nceas.ucsb.edu/knb/d1/mn"
}
```

1 change: 1 addition & 0 deletions helm/config/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ MetacatUI.AppConfig = {
root: {{ .Values.appConfig.root | quote }},
theme: {{ .Values.appConfig.theme | quote }},
baseUrl: {{ .Values.appConfig.baseUrl | quote }}
{{/* Add any new keys to these lists, and they will be populated automatically if set */}}
{{- $optionalStringValues := list
"d1CNBaseUrl"
"mapKey"
Expand Down

0 comments on commit 3756462

Please sign in to comment.