Merge pull request #2162 from NCEAS/develop

chart2.1.1 release prep - merge to main

Author: artntek

RELEASE-NOTES.md

@@ -1,5 +1,23 @@
 # Metacat Release Notes
 
+## Release Notes for helm chart 2.1.1
+
+**Release date: 2025-05-20**
+
+This is a patch release to upgrade the indexer sub-chart from 1.3.0 to 1.3.1. It does not include
+any other changes to the metacat codebase or the metacat helm chart, beyond the documentation edits
+listed below.
+
+- Bump dataone-indexer sub-chart to version 1.3.1 ([see indexer release notes for
+  details](https://github.com/DataONEorg/dataone-indexer/blob/3.1.4/RELEASE-NOTES.md))
+- Documentation-only updates to `MetacatQuickRef.md` and `Installation-Upgrade-Tips.md`
+- Updates to the example values-override files in `helm/examples`
+
+> [!CAUTION]
+> If you are upgrading from a helm chart version earlier than 2.1.0, please see the [Upgrade
+> Notes](#chart-upgrade-notes) below. Failure to do so may result in loss of data!
+
+
 ## Release Notes for Metacat 3.2.1
 
 **Release date: 2024-05-01**

helm/Chart.yaml

@@ -21,7 +21,7 @@ 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: "2.1.0"
+version: "2.1.1"
 icon: https://camo.githubusercontent.com/a41e704e6cbd198afed0a892f2dccfc43aef29fb7631407048f531aa31956e72/68747470733a2f2f6b6e622e65636f696e666f726d61746963732e6f72672f6b6e622f646f63732f5f696d616765732f6d6574616361742d6c6f676f2d6461726b677261792e706e67
 
 # This is the version number of the application being deployed. This version number should be
@@ -49,7 +49,7 @@ dependencies:
 
   - name: dataone-indexer
     repository: oci://ghcr.io/dataoneorg/charts
-    version: 1.3.0
+    version: 1.3.1
     condition: global.dataone-indexer.enabled
     import-values:
       - child: solr

helm/README.md

@@ -80,7 +80,7 @@ Starting in the root directory of the `metacat` repo:
 
     ```shell
     $ ./helm-upstall.sh  myreleasename  mynamespace oci://ghcr.io/nceas/charts/metacat  \
-                                            --version 2.1.0  -f  /your/values-overrides.yaml
+                                          --version [version-here]  -f  /your/values-overrides.yaml
     ```
 
 To access Metacat, you'll need to create a mapping between your ingress IP address (found by:
@@ -108,7 +108,7 @@ using the [Helm](https://helm.sh) package manager.
 To install the chart with the release name `my-release`:
 
 ```shell
-helm install my-release oci://ghcr.io/nceas/charts/metacat --version 2.1.0
+helm install my-release oci://ghcr.io/nceas/charts/metacat --version [version-here]
 ```
 
 This command deploys Metacat on the Kubernetes cluster in the default configuration that is defined
@@ -120,15 +120,15 @@ by creating a YAML file that specifies only those values that need to be overrid
 that file as part of the helm install command. For example:
 
 ```shell
-helm install my-release  -f myValues.yaml  oci://ghcr.io/nceas/charts/metacat --version 2.1.0
+helm install my-release  -f myValues.yaml  oci://ghcr.io/nceas/charts/metacat --version [version-here]
 ```
 (where `myValues.yaml` contains only the values you wish to override.)
 
 Parameters may also be provided on the command line to override those in
 [values.yaml](./values.yaml); e.g.
 
 ```shell
-helm install my-release oci://ghcr.io/nceas/charts/metacat --version 2.1.0  \
+helm install my-release oci://ghcr.io/nceas/charts/metacat --version [version-here]  \
                         --set postgres.auth.existingSecret=my-release-secrets
 ```
 

helm/admin/Installation-Upgrade-Tips.md

@@ -37,7 +37,7 @@
 ### See how many "old" datasets exist in DB, before the upgrade:
 
 *   ```shell
-    kubectl exec metacatarctic-postgresql-0 -- bash -c "psql -U metacat << EOF
+    kubectl exec ${RELEASE_NAME}-postgresql-0 -- bash -c "psql -U metacat << EOF
       select count(*) as docs from xml_documents where docid not like 'autogen%';
       select count(*) as revs from xml_revisions where docid not like 'autogen%';
     EOF"

helm/admin/MetacatQuickRef.md

@@ -351,33 +351,28 @@ whether you are using the MetacatUI sub-chart or not:
      application.readOnlyMode=true
      ```
 
-- [ ] Stop tomcat (not postgres)
+- [ ] Restart tomcat (not postgres)
 
      ```shell
-     sudo systemctl stop tomcat9
+     sudo systemctl restart tomcat9
+     ```
+
+- [ ] Check it's in RO mode! `https://$HOSTNAME/CONTEXT/d1/mn/v2/node` - look for:
+
+     ```xml
+      <property key="read_only_mode">true</property>
      ```
 
 - [ ] `pg_dump` on legacy host
 
     ```shell
-    DUMP_DIR="/var/lib/postgresql/14-pg_dump"
+    JOBS=20 # adjust for available cpu cores
+    DEST="/var/lib/postgresql/14-pg_dump"
     PGDB=metacat
     POSTGRES_USER=metacat
-    sudo pg_dump -U $POSTGRES_USER -h localhost --format=directory --file=$DUMP_DIR --jobs=20 $PGDB
+    sudo pg_dump -U $POSTGRES_USER -h localhost --format=directory --file=$DEST --jobs=$JOBS $PGDB
     ```
 
-- [ ] Start tomcat
-
-     ```shell
-     sudo systemctl start tomcat9
-     ```
-
-- [ ] Check it's in RO mode! `https://$HOSTNAME/CONTEXT/d1/mn/v2/node` - look for:
-
-     ```xml
-      <property key="read_only_mode">true</property>
-     ```
-
 - [ ] "top-up" `rsync` from legacy to ceph:
 
      ```shell
@@ -389,9 +384,6 @@ whether you are using the MetacatUI sub-chart or not:
      sudo rsync -rltDHX -e "ssh -i $HOME/.ssh/id_ed25519" --stats --human-readable \
                /var/metacat/data/         $USER@$TARGET:/mnt/ceph/repos/$REPO/metacat/data/
 
-     sudo rsync -rltDHX -e "ssh -i $HOME/.ssh/id_ed25519" --stats --human-readable \
-               /var/metacat/dataone/      $USER@$TARGET:/mnt/ceph/repos/$REPO/metacat/dataone/
-
      sudo rsync -rltDHX -e "ssh -i $HOME/.ssh/id_ed25519" --stats --human-readable \
                /var/metacat/documents/    $USER@$TARGET:/mnt/ceph/repos/$REPO/metacat/documents/
 
@@ -411,7 +403,7 @@ whether you are using the MetacatUI sub-chart or not:
 
      cd /mnt/ceph/repos/$REPO/metacat
 
-     sudo chown -R 59997:59997 data dataone documents logs
+     sudo chown -R 59997:59997 data documents logs
 
      sudo chmod -R g+rw data documents dataone
      ```
@@ -428,10 +420,15 @@ whether you are using the MetacatUI sub-chart or not:
     ```
 
 - [ ] Delete the `storage.hashstore.disableConversion:` setting, so the hashstore converter will
-      run, and do a `helm upgrade`
+      run, and do a `helm upgrade`. Watch for completion:
+
+    ```shell
+    kubectl exec ${RELEASE_NAME}-postgresql-0 -- bash -c "psql -U metacat << EOF
+      select storage_upgrade_status from version_history where version='3.1.0';
+    EOF"
+    ```
 
-  > See [this tip](./Installation-Upgrade-Tips.md#monitor-hashstore-conversion-progress-and-completion)
-  > for how to detect when hashstore conversion finishes
+    ...or see [this tip](./Installation-Upgrade-Tips.md#monitor-hashstore-conversion-progress-and-completion) for other monitoring options
 
 **When hashstore conversion has finished successfully...**
 

helm/examples/values-dev-cluster-example-mcui.yaml

@@ -0,0 +1,26 @@
+## Values Overrides - see metacatui's values.yaml for full documentation on the following parameters
+##
+##  $  helm upgrade --install metacatuibrooke -n brooke \
+##          -f metacatui/values-prod-cluster-brooke-mcui.yaml \
+##          oci://ghcr.io/nceas/charts/metacatui --version [VERSION] --debug --render-subchart-notes
+##
+
+global:
+  metacatUiThemeName: "default"
+  metacatExternalBaseUrl: "https://metacat-dev.test.dataone.org/"
+  d1ClientCnUrl: "https://cn-sandbox.test.dataone.org/cn"
+#  metacatUiWebRoot: "/"          ## delete if default is ok
+#  metacatAppContext: "metacat"   ## delete if default is ok
+
+## example for a custom theme (also need to set global.metacatUiThemeName: "cerp", above)
+##
+# customTheme:
+#   enabled: true
+#   ## Use your own release name instead of metacatbrooke
+#   claimName: metacatbrooke-metacatui-customtheme
+#   subPath: metacatui-themes/src/cerp/js/themes/cerp
+#
+## disable appConfig because SFWMD uses cerp theme, overlaid with
+## SFWMD config.js at /config/config.js (created as configMap)
+# appConfig:
+#   enabled: false

helm/examples/values-dev-cluster-example.yaml

@@ -17,28 +17,20 @@
 debug: &debug true
 
 global:
-  metacatUiThemeName: "default"
-  metacatUiWebRoot: "/"
   metacatExternalBaseUrl: "https://metacat-dev.test.dataone.org/"
   d1ClientCnUrl: "https://cn-sandbox.test.dataone.org/cn"
   storageClass: &storageClassName csi-cephfs-sc
   ephemeralVolumeStorageClass: csi-cephfs-sc-ephemeral
   ## Use your own release name instead of metacatbrooke
   passwordsSecret: &passwordSecretName metacatbrooke-metacat-secrets
-
-
-## example for a custom theme (also need to set global.metacatUiThemeName: "cerp", above)
-##
-#metacatui:
-#  customTheme:
-#    enabled: true
-#    ## Use your own release name instead of metacatbrooke
-#    claimName: metacatbrooke-metacatui-customtheme
-#    subPath: metacatui-themes/src/cerp/js/themes/cerp
-#  appConfig:
-#    enabled: false
-    ## disabled because SFWMD uses cerp theme, overlaid with
-    ## SFWMD config.js at /config/config.js (created as configMap)
+  ## MetacatUI is deployed as a separate chart, to allow for a different upgrade cycle.
+  ## see separate values overrides in ./values-dev-cluster-example-mcui.yaml
+  ##
+  includeMetacatUi: false           # don't include the MetacatUI sub-chart
+  metacatUiIngressBackend:
+    enabled: true                   # configure the Ingress to point to the MetacatUI service
+    service:
+      name: mcuibrooke-metacatui    # Use your own service name
 
 metacat:
   server.name: metacat-dev.test.dataone.org
@@ -72,6 +64,19 @@ image:
   pullPolicy: Always
   debug: *debug
 
+resources:
+  requests:
+    cpu: 1
+    memory: 4Gi
+  limits:
+    cpu: 2
+    memory: 8Gi
+
+tomcat:
+  heapMemory:
+    min: 4G
+    max: 8G
+
 ingress:
   annotations:
     cert-manager.io/cluster-issuer: "letsencrypt-prod"
@@ -124,8 +129,16 @@ dataone-indexer:
   rabbitmq:
     auth:
       existingPasswordSecret: *passwordSecretName
+    resources:
+      requests:
+        cpu: 1.0
+        memory: 2048Mi
+      limits:
+        cpu: 3.0
+        memory: 3072Mi
 
   solr:
+    resourcesPreset: "large"
     extraVolumes:
       - name: solr-config
         configMap: