Merge pull request #2028 from NCEAS/feature-1984-3.1.0-release-prep

updated readme, checklist and examples for 3.1.0/chart-2.1 .0 release

helm/Chart.yaml

@@ -49,7 +49,7 @@ dependencies:
 
   - name: dataone-indexer
     repository: oci://ghcr.io/dataoneorg/charts
-    version: 1.1.0-SNAPSHOT
+    version: 1.1.0
     condition: global.dataone-indexer.enabled
     import-values:
       - child: solr

helm/admin/pv--releasename-metacat-cephfs.yaml

@@ -0,0 +1,35 @@
+# Creates a persistent volume for use by metacat
+#
+# This should be done only one time, separately from the helm install/upgrade cycle
+#
+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}
+  #
+  ## Use your own release name
+  name: &pv-name cephfs-releasename-metacat-varmetacat
+spec:
+  accessModes:
+  - ReadWriteMany
+  capacity:
+    storage: 100Gi
+  csi:
+    driver: cephfs.csi.ceph.com
+    nodeStageSecretRef:
+      # Use your own secret name
+      name: csi-cephfs-releasename-secret
+      # Use your own namespace where above secret is created
+      namespace: ceph-csi-cephfs
+    volumeAttributes:
+      # Use your own clusterID, fsName, rootPath etc. here
+      clusterID: 8aa4d4a0-a209-11ea-baf5-ffc787bfc812
+      fsName: cephfs
+      rootPath: /volumes/k8ssubvolgroup/k8ssubvol/58cda964-ce10-4ff9-8242-983da0fd0da3/repos/name/metacat
+      staticVolume: "true"
+    volumeHandle: *pv-name
+  persistentVolumeReclaimPolicy: Retain
+  ## Use your own storage class
+  storageClassName: csi-cephfs-sc
+  volumeMode: Filesystem

helm/admin/pv--releasename-metacatui.yaml

@@ -0,0 +1,35 @@
+# Creates a persistent volume for use by MetacatUI
+#
+# This should be done only one time, separately from the helm install/upgrade cycle
+#
+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}
+  #
+  ## Use your own release name
+  name: &pv-name cephfs-releasename-metacatui
+spec:
+  accessModes:
+  - ReadWriteMany
+  capacity:
+    storage: 1Gi
+  csi:
+    driver: cephfs.csi.ceph.com
+    nodeStageSecretRef:
+      # Use your own secret name
+      name: csi-cephfs-releasename-secret
+      # Use your own namespace where above secret is created
+      namespace: ceph-csi-cephfs
+    volumeAttributes:
+      # Use your own clusterID, fsName, rootPath etc. here
+      clusterID: 8aa4d4a0-a209-11ea-baf5-ffc787bfc812
+      fsName: cephfs
+      rootPath: /volumes/k8ssubvolgroup/k8ssubvol/58cda964-ce10-4ff9-8242-983da0fd0da3/repos/name/metacatui
+      staticVolume: "true"
+    volumeHandle: *pv-name
+  persistentVolumeReclaimPolicy: Retain
+  ## Use your own storage class
+  storageClassName: csi-cephfs-sc
+  volumeMode: Filesystem

helm/admin/pv--releasename-postgres-cephfs.yaml

@@ -0,0 +1,37 @@
+# Creates a persistent volume for use by postgresql
+#
+# This should be done only one time, separately from the helm install/upgrade cycle
+#
+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}
+  #
+  ## Use your own release name
+  name: &pv-name cephfs-releasename-metacat-postgresdata
+  labels:
+    metacatVolumeName: *pv-name
+spec:
+  accessModes:
+  - ReadWriteOnce
+  capacity:
+    storage: 10Gi
+  csi:
+    driver: cephfs.csi.ceph.com
+    nodeStageSecretRef:
+      # Use your own secret name
+      name: csi-cephfs-releasename-secret
+      # Use your own namespace where above secret is created
+      namespace: ceph-csi-cephfs
+    volumeAttributes:
+      # Use your own clusterID, fsName, rootPath etc. here
+      clusterID: 8aa4d4a0-a209-11ea-baf5-ffc787bfc812
+      fsName: cephfs
+      rootPath: /volumes/k8ssubvolgroup/k8ssubvol/58cda964-ce10-4ff9-8242-983da0fd0da3/repos/name/postgresql
+      staticVolume: "true"
+    volumeHandle: *pv-name
+  persistentVolumeReclaimPolicy: Retain
+  ## Use your own storage class
+  storageClassName: csi-cephfs-sc
+  volumeMode: Filesystem

helm/admin/pvc--releasename-postgres.yaml

@@ -0,0 +1,24 @@
+# Creates a persistent volume claim for use by postgresql
+#
+# This should be done only one time, separately from the helm install/upgrade cycle
+#
+# NOTE: ensure that a PersistentVolume has already been created before creating
+#       the PersistentVolumeClaim!
+#
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  ## Use your own release name
+  name: releasename-metacat-postgresql-0
+  ## Use your own namespace
+  namespace: mynamespace
+spec:
+  accessModes:
+    - ReadWriteOnce
+  ## Use your own release name. Note must match the name of the PersistentVolume
+  volumeName: cephfs-releasename-metacat-postgresdata
+  resources:
+    requests:
+      storage: 1000Gi
+  ## Use your own storage class
+  storageClassName: csi-cephfs-sc

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

@@ -5,14 +5,15 @@
 ##  helm install myrelease -n mynamespace ./helm -f ./helm/examples/values-dev-cluster-example.yaml
 ##
 ## or from pre-packaged chart:
-##  helm install myrelease -n mynamespace oci://ghcr.io/nceas/charts/metacat --version 1.1.1 \
+##  helm install myrelease -n mynamespace oci://ghcr.io/nceas/charts/metacat --version 1.2.0 \
 ##       -f ./helm/examples/values-dev-cluster-example.yaml \
 ##       --debug --render-subchart-notes
 ##
 ## see values.yaml for full documentation on the following parameters
 ##
 
-# set once here, for both metacat and indexer:
+## set once here, for both metacat and indexer:
+## Omit for production - otherwise logging is too verbose
 debug: &debug true
 
 global:
@@ -22,6 +23,7 @@ global:
   d1ClientCnUrl: "https://cn-stage.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
 
 
@@ -30,6 +32,7 @@ global:
 #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:
@@ -39,8 +42,7 @@ global:
 
 metacat:
   server.name: metacat-dev.test.dataone.org
-  ## Matthew Brooke; Jing Tao; Matt Jones; Jeanette Clark
-  auth.administrators: http://orcid.org/0000-0002-1472-913X;http://orcid.org/0000-0002-1209-5268;https://orcid.org/0000-0003-0077-4738;http://orcid.org/0000-0003-4703-1974
+  auth.administrators: http://orcid.org/0000-0002-1472-913X;http://orcid.org/0000-0002-1209-5268
 
   cn.server.publiccert.filename: /var/metacat/pubcerts/DataONETestIntCA.pem
 
@@ -63,6 +65,7 @@ persistence:
   size: 100Gi
   accessModes:
     - ReadWriteMany
+  ## Use your own release name instead of metacatbrooke
   volumeName: cephfs-metacatbrooke-metacat
 
 image:
@@ -96,6 +99,7 @@ postgresql:
       size: 10Gi
       selector:
         matchLabels:
+          ## Use your own release name instead of metacatbrooke
           metacatVolumeName: cephfs-metacatbrooke-metacat-postgresdata
 
   auth:
@@ -131,6 +135,7 @@ dataone-indexer:
     extraVolumes:
       - name: solr-config
         configMap:
+          ## Use your own release name instead of metacatbrooke
           name: metacatbrooke-indexer-configfiles
           defaultMode: 0777