hyrax 3.0.0.pre.rc4 → 3.0.0

data/bin/db-migrate-seed.sh

@@ -2,8 +2,10 @@
 set -e
 
 db-wait.sh "$DB_HOST:$DB_PORT"
+bundle exec rails db:create
+bundle exec rails db:migrate
+
 db-wait.sh "$FCREPO_HOST:$FCREPO_PORT"
 db-wait.sh "$SOLR_HOST:$SOLR_PORT"
 
-bundle exec rails db:migrate
 bundle exec rails db:seed

data/bin/solrcloud-assign-configset.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env sh
+COUNTER=0;
+
+if [ "$SOLR_ADMIN_USER" ]; then
+  solr_user_settings="--user $SOLR_ADMIN_USER:$SOLR_ADMIN_PASSWORD"
+fi
+
+# Solr Cloud Collection API URLs
+solr_collection_list_url="$SOLR_HOST:$SOLR_PORT/solr/admin/collections?action=LIST"
+solr_collection_modify_url="$SOLR_HOST:$SOLR_PORT/solr/admin/collections?action=MODIFYCOLLECTION&collection=$SOLR_COLLECTION_NAME&collection.configName=$SOLR_CONFIGSET_NAME"
+
+while [ $COUNTER -lt 30 ]; do
+  if nc -z "${SOLR_HOST}" "${SOLR_PORT}"; then
+    if curl --silent $solr_user_settings "$solr_collection_list_url" | grep -q "$SOLR_COLLECTION_NAME"; then
+      echo "-- Collection ${SOLR_COLLECTION_NAME} exists; setting ${SOLR_CONFIGSET_NAME} ConfigSet ..."
+      echo $solr_collection_modify_url
+      curl $solr_user_settings "$solr_collection_modify_url"
+      exit
+    fi
+  fi
+  echo "-- Looking for Solr (${SOLR_HOST}:${SOLR_PORT})..."
+  COUNTER=$(( COUNTER+1 ));
+  sleep 5s
+done
+
+echo "--- ERROR: failed to create/update Solr collection after 5 minutes";
+exit 1

data/bin/solrcloud-upload-configset.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env sh
+
+COUNTER=0;
+# /app/samvera/hyrax-webapp/solr/conf
+CONFDIR="${1}"
+
+if [ "$SOLR_ADMIN_USER" ]; then
+  solr_user_settings="--user $SOLR_ADMIN_USER:$SOLR_ADMIN_PASSWORD"
+fi
+
+# Solr Cloud ConfigSet API URLs
+solr_config_list_url="http://$SOLR_HOST:$SOLR_PORT/api/cluster/configs?omitHeader=true"
+solr_config_upload_url="http://$SOLR_HOST:$SOLR_PORT/solr/admin/configs?action=UPLOAD&name=$SOLR_CONFIGSET_NAME"
+
+while [ $COUNTER -lt 30 ]; do
+  echo "-- Looking for Solr (${SOLR_HOST}:${SOLR_PORT})..."
+  if nc -z "${SOLR_HOST}" "${SOLR_PORT}"; then
+    if curl --silent $solr_user_settings "$solr_config_list_url" | grep -q "$SOLR_CONFIGSET_NAME"; then
+      echo "-- ConfigSet already exists; skipping creation ...";
+    else
+      echo "-- ConfigSet for ${CONFDIR} does not exist; creating ..."
+      (cd "$CONFDIR" && zip -r - *) | curl -X POST $solr_user_settings --header "Content-Type:application/octet-stream" --data-binary @- "$solr_config_upload_url"
+    fi
+    exit
+  fi
+  COUNTER=$(( COUNTER+1 ));
+  sleep 5s
+done
+
+echo "--- ERROR: failed to create Solr ConfigSet after 5 minutes";
+exit 1

data/chart/hyrax/Chart.yaml

@@ -2,18 +2,19 @@ apiVersion: v2
 name: hyrax
 description: An open-source, Samvera-powered digital repository system
 type: application
-version: 0.5.0
-appVersion: 3.0.0-rc4
+version: 0.6.0
+appVersion: 3.0.0
 dependencies:
   - name: fcrepo
-    version: 0.4.1
-    repository: file://../fcrepo
+    version: 0.6.0
+    repository: https://samvera-labs.github.com/fcrepo-charts
+    condition: fcrepo.enabled
   - name: memcached
     version: 4.2.21
     repository: https://charts.bitnami.com/bitnami
     condition: memcached.enabled
   - name: postgresql
-    version: 9.3.3
+    version: 10.3.13
     repository: https://charts.bitnami.com/bitnami
     condition: postgresql.enabled
   - name: redis
@@ -21,7 +22,6 @@ dependencies:
     repository: https://charts.bitnami.com/bitnami
     condition: redis.enabled
   - name: solr
-    version: 1.5.2
-    repository: http://storage.googleapis.com/kubernetes-charts-incubator
+    version: 0.2.2
+    repository: https://charts.bitnami.com/bitnami
     condition: solr.enabled
-  # need something for fcrepo

data/chart/hyrax/README.md

@@ -39,14 +39,50 @@ The chart populates the following environment variables:
 | RACK_ENV          | app environment ('production') | n/a                    |
 | RAILS_ENV         | app environment ('production') | n/a                    |
 | REDIS_HOST        | Redis service host             | `redis.enabled`        |
-| FCREPO_HOST       | Fedora Commons host            | `fcrepo.enabled`       |
-| FCREPO_PORT       | Fedora Commons port            | `fcrepo.enabled`       |
-| FCREPO_REST_PATH  | Fedora Commons REST endpoint   | `fcrepo.enabled`       |
-| SOLR_HOST         | Solr service host              | `solr.enabled`         |
-| SOLR_PORT         | Solr service port              | `solr.enabled`         |
-| SOLR_URL          | Solr service full URL          | `solr.enabled`         |
+| FCREPO_BASE_PATH  | Fedora Commons root path       | n/a                    |
+| FCREPO_HOST       | Fedora Commons host            | n/a                    |
+| FCREPO_PORT       | Fedora Commons port            | n/a                    |
+| FCREPO_REST_PATH  | Fedora Commons REST endpoint   | n/a                    |
+| SOLR_ADMIN_USER   | Solr user for basic auth       | n/a                    |
+| SOLR_ADMIN_PASSWORD | Solr password for basic auth | n/a                    |
+| SOLR_COLLECTION_NAME | The name of the solr collection to use | n/a         |
+| SOLR_CONFIGSET_NAME | The name of the solr configset to use for config management tasks | n/a |
+| SOLR_HOST         | Solr service host              | n/a                    |
+| SOLR_PORT         | Solr service port              | n/a                    |
+| SOLR_URL          | Solr service full URL          | n/a                    |
 |----------------- -|--------------------------------|------------------------|
 
+## With an external SolrCloud
+
+By default, this chart deploys and manages an internal SolrCloud deployment,
+complete with its own ZooKeeper service.
+
+To use an existing or externally managed SolrCloud, use the chart values:
+
+  - `solr.enabled`: false
+  - `externalSolrHost`: "mySolr.hostname.example.com"
+  - `externalSolrUser`: "admin"
+  - `externalSolrPassword`: "the_admin_password"
+  - `externalSolrCollection`: "a_collection_name"
+
+The chart will attempt to upload a ConfigSet for Hyrax matching the deployment's
+"fullname" and assign it to the collection. This is achieved through the Solr
+Collections API, and authentication _must_ be enabled in the external Solr for
+this to work.
+
+If you want to manage your ConfigSet manually, disable this behavior with
+`--set loadSolrConfigSet=false`.
+
+## With an external Fedora Commons Repository
+
+By default, this chart deploys a local Fedora Repository, backed by the
+application's Postgresql system.
+
+To use an existing or external `fcrepo` instance, use the chart values:
+
+  - `fcrepo.enabled`: false
+  - `externalFcrepoHost`: "myfedora.hostname.example.com"
+
 ## For DevOps:
 
 For those interested in trying out or contributing to this Chart, it's helpful

data/chart/hyrax/templates/NOTES.txt

@@ -2,7 +2,7 @@
 {{- if .Values.ingress.enabled }}
 {{- range $host := .Values.ingress.hosts }}
   {{- range .paths }}
-  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}
   {{- end }}
 {{- end }}
 {{- else if contains "NodePort" .Values.service.type }}

data/chart/hyrax/templates/_helpers.tpl

@@ -70,6 +70,14 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 {{- printf "%s-%s" .Release.Name "fcrepo" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
+{{- define "hyrax.fcrepo.host" -}}
+{{- if .Values.fcrepo.enabled }}
+{{- include "hyrax.fcrepo.fullname" . }}
+{{- else }}
+{{- .Values.externalFcrepoHost }}
+{{- end }}
+{{- end -}}
+
 {{- define "hyrax.memcached.fullname" -}}
 {{- printf "%s-%s" .Release.Name "memcached" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
@@ -78,6 +86,37 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 {{- printf "%s-%s" .Release.Name "postgresql" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
+{{- define "hyrax.postgresql.host" -}}
+{{- if .Values.postgresql.enabled }}
+{{- include "hyrax.postgresql.fullname" . }}
+{{- else }}
+{{- .Values.externalPostgresql.host }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.postgresql.database" -}}
+{{- if .Values.postgresql.enabled }}
+{{- .Values.postgresql.postgresqlDatabase }}
+{{- else }}
+{{- .Values.externalPostgresql.database | default ( include "hyrax.fullname" . ) }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.postgresql.username" -}}
+{{- if .Values.postgresql.enabled }}
+{{- .Values.postgresql.postgresqlUsername }}
+{{- else }}
+{{- .Values.externalPostgresql.username | default "postgres" }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.postgresql.password" -}}
+{{- if .Values.postgresql.enabled }}
+{{- .Values.postgresql.postgresqlPassword }}
+{{- else }}
+{{- .Values.externalPostgresql.password }}
+{{- end }}
+{{- end -}}
 
 {{- define "hyrax.redis.fullname" -}}
 {{- printf "%s-%s" .Release.Name "redis" | trunc 63 | trimSuffix "-" -}}
@@ -87,6 +126,43 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 {{- define "hyrax.solr.fullname" -}}
 {{- printf "%s-%s" .Release.Name "solr" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
+
+{{- define "hyrax.solr.host" -}}
+{{- if .Values.solr.enabled }}
+{{- include "hyrax.solr.fullname" . }}
+{{- else }}
+{{- .Values.externalSolrHost }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.solr.collectionName" -}}
+{{- if .Values.solr.enabled }}
+{{- .Values.solr.collection | default "hyrax" }}
+{{- else }}
+{{- .Values.externalSolrCollection | default "hyrax" }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.solr.username" -}}
+{{- if .Values.solr.enabled }}
+{{- .Values.solr.authentication.adminUsername }}
+{{- else }}
+{{- .Values.externalSolrUser }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.solr.password" -}}
+{{- if .Values.solr.enabled }}
+{{- .Values.solr.authentication.adminPassword }}
+{{- else }}
+{{- .Values.externalSolrPassword }}
+{{- end }}
+{{- end -}}
+
+{{- define "hyrax.solr.url" -}}
+{{- printf "http://%s:%s@%s:%s/solr/%s" (include "hyrax.solr.username" .) (include "hyrax.solr.password" .) (include "hyrax.solr.host" .) "8983" (include "hyrax.solr.collectionName" .)  -}}
+{{- end -}}
+
 {{- define "hyrax.zk.fullname" -}}
 {{- printf "%s-%s" .Release.Name "zookeeper" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}

data/chart/hyrax/templates/configmap-env.yaml

@@ -8,10 +8,8 @@ metadata:
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/managed-by: {{ .Release.Service }}
 data:
-  {{- if .Values.postgresql.enabled }}
-  DB_HOST: {{ template "hyrax.postgresql.fullname" . }}
+  DB_HOST: {{ template "hyrax.postgresql.host" . }}
   DB_PORT: "5432"
-  {{- end }}
   {{- if .Values.memcached.enabled }}
   MEMCACHED_HOST: {{ template "hyrax.memcached.fullname" . }}
   {{- end }}
@@ -20,13 +18,14 @@ data:
   {{- if .Values.redis.enabled }}
   REDIS_HOST: {{ template "hyrax.redis.fullname" . }}-master
   {{- end }}
-  {{- if .Values.fcrepo.enabled }}
+  FCREPO_BASE_PATH: {{ .Values.fcrepoBasePathOverride | default (printf "/%s" (include "hyrax.fullname" .)) | quote }}
+  FCREPO_HOST: {{ template "hyrax.fcrepo.host" . }}
   FCREPO_PORT: {{ .Values.fcrepo.servicePort | default 8080 | quote }}
-  FCREPO_HOST: {{ template "hyrax.fcrepo.fullname" . }}
-  FCREPO_REST_PATH: {{ .Values.fcrepo.restPath | default "fcrepo/rest" }}
-  {{- end }}
-  {{- if .Values.solr.enabled }}
-  SOLR_HOST: {{ template "hyrax.solr.fullname" . }}-svc
+  FCREPO_REST_PATH: {{ .Values.fcrepo.restPath | default "rest" }}
+  SOLR_ADMIN_USER: {{ template "hyrax.solr.username" . }}
+  SOLR_ADMIN_PASSWORD: {{ template "hyrax.solr.password" . }}
+  SOLR_COLLECTION_NAME: {{ template "hyrax.solr.collectionName" . }}
+  SOLR_CONFIGSET_NAME: {{ template "hyrax.fullname" . }}
+  SOLR_HOST: {{ template "hyrax.solr.host" . }}
   SOLR_PORT: "8983"
-  SOLR_URL: http://{{ template "hyrax.solr.fullname" . }}-svc:8983/solr/hyrax
-  {{- end }}
+  SOLR_URL: {{ template "hyrax.solr.url" . }}

data/chart/hyrax/templates/cron-embargo.yaml

@@ -0,0 +1,24 @@
+{{- if .Values.embargoRelease.enabled }}
+apiVersion: batch/v1beta1
+kind: CronJob
+metadata:
+metadata:
+  name: {{ include "hyrax.fullname" . }}-embargo-task
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  schedule: {{ .Values.embargoRelease.schedule | default "*0 0 * * *" | quote }}
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          containers:
+          - name: embargo-release
+            image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+            imagePullPolicy: {{ .Values.image.pullPolicy }}
+            command:
+            - /bin/sh
+            - -c
+            - bundle exec rake hyrax:embargo:deactivate_expired
+          restartPolicy: OnFailure
+{{- end }}

data/chart/hyrax/templates/cron-lease.yaml

@@ -0,0 +1,24 @@
+{{- if .Values.leaseRelease.enabled }}
+apiVersion: batch/v1beta1
+kind: CronJob
+metadata:
+metadata:
+  name: {{ include "hyrax.fullname" . }}-lease-task
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  schedule: {{ .Values.leaseRelease.schedule | default "0 0 * * *" | quote }}
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          containers:
+          - name: lease-release
+            image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+            imagePullPolicy: {{ .Values.image.pullPolicy }}
+            command:
+            - /bin/sh
+            - -c
+            - bundle exec rake hyrax:lease:deactivate_expired
+          restartPolicy: OnFailure
+{{- end }}

data/chart/hyrax/templates/deployment.yaml

@@ -21,6 +21,22 @@ spec:
         {{- include "hyrax.selectorLabels" . | nindent 8 }}
     spec:
       initContainers:
+        {{- if .Values.loadSolrConfigSet }}
+        - name: load-solr-config
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          envFrom:
+            - configMapRef:
+                name: {{ include "hyrax.fullname" . }}-env
+            - secretRef:
+                name: {{ include "hyrax.fullname" . }}
+          command:
+            - sh
+            - -c
+            - >
+              solrcloud-upload-configset.sh /app/samvera/hyrax-webapp/solr/conf &&
+              solrcloud-assign-configset.sh
+        {{- end }}
         - name: db-setup
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
@@ -55,14 +71,30 @@ spec:
             - name: http
               containerPort: 3000
               protocol: TCP
+          {{- if .Values.livenessProbe.enabled }}
           livenessProbe:
+            initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds | default 5 }}
+            timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds | default 5 }}
+            failureThreshold: {{ .Values.livenessProbe.failureThreshold | default 3 }}
+            periodSeconds: {{ .Values.livenessProbe.periodSeconds | default 10}}
+            successThreshold: {{ .Values.livenessProbe.successThreshold | default 1 }}
             httpGet:
-              path: /
-              port: http
+              scheme: "HTTP"
+              path: {{ .Values.livenessProbe.path | default "/" }}
+              port: 3000
+          {{- end }}
+          {{- if .Values.readinessProbe.enabled }}
           readinessProbe:
+            initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds | default 5 }}
+            timeoutSeconds: {{ .Values.readinessProbe.timeoutSeconds | default 5 }}
+            failureThreshold: {{ .Values.readinessProbe.failureThreshold | default 3 }}
+            periodSeconds: {{ .Values.readinessProbe.periodSeconds | default 10 }}
+            successThreshold: {{ .Values.readinessProbe.successThreshold | default 1 }}
             httpGet:
-              path: /
-              port: http
+              scheme: "HTTP"
+              path: {{ .Values.readinessProbe.path | default "/" }}
+              port: 3000
+          {{- end }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
       {{- with .Values.nodeSelector }}

data/chart/hyrax/templates/secrets.yaml

@@ -7,6 +7,7 @@ metadata:
 type: Opaque
 data:
   SECRET_KEY_BASE: {{ randAlphaNum 20 | b64enc | quote }}
-  {{- if .Values.postgresql.enabled }}
-  DATABASE_URL: {{ printf "postgresql://%s:%s@%s/%s?pool=5" .Values.postgresql.postgresqlUsername .Values.postgresql.postgresqlPassword (include "hyrax.postgresql.fullname" .) .Values.postgresql.postgresqlDatabase | b64enc }}
+  DATABASE_URL: {{ printf "postgresql://%s:%s@%s/%s?pool=5" ( include "hyrax.postgresql.username" . ) ( include "hyrax.postgresql.password" . ) ( include "hyrax.postgresql.host" . ) ( include "hyrax.postgresql.database" . ) | b64enc }}
+  {{- if .Values.redis.enabled }}
+  REDIS_PASSWORD: {{ .Values.redis.password | b64enc}}
   {{- end }}

data/chart/hyrax/values.yaml

@@ -10,6 +10,34 @@ image:
   # Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
+# use false to skip the configset management init container
+loadSolrConfigSet: true
+# the host and auth details for an external solr service;
+#   ignored if `solr.enabled` is true
+externalSolrHost: ""
+externalSolrUser: ""
+externalSolrPassword: ""
+externalSolrCollection: "hyrax"
+
+# configuration for an external/existing fcrepo service;
+#   ignored if `fcrepo.enabled` is true
+externalFcrepoHost: ""
+fcrepoBasePathOverride: ""
+
+# database configuration for an external postgresql;
+#   ignored if `postgresql.enabled` is true
+externalPostgresql: {}
+#  username:
+#  password:
+#  database:
+
+embargoRelease:
+  enabled: true
+  schedule: "0 0 * * *"
+leaseRelease:
+  enabled: true
+  schedule: "0 0 * * *"
+
 imagePullSecrets: []
 nameOverride: ""
 fullnameOverride: ""
@@ -50,15 +78,35 @@ ingress:
       paths: []
   tls: []
 
+livenessProbe:
+  enabled: true
+  # path: "/healthz"
+  # initialDelaySeconds: 0
+  # periodSeconds: 10
+  # timeoutSeconds: 10
+  # failureThreshold: 3
+  # successThreshold: 1
+
+readinessProbe:
+  enabled: true
+  # path: "/healthz"
+  # initialDelaySeconds: 5
+  # periodSeconds: 10
+  # timeoutSeconds: 5
+  # failureThreshold: 6
+  # successThreshold: 1
+
 resources: {}
 
 fcrepo:
   enabled: true
-  fcrepoSecretName: "hyrax.fcrepo.fullname"
   externalDatabaseUsername: "hyrax"
   servicePort: 8080
   postgresql:
     enabled: false
+    image:
+      repository: bitnami/postgresql
+      tag: 12.3.0
 
 memcached:
   enabled: false
@@ -79,9 +127,27 @@ postgresql:
 
 redis:
   enabled: true
+  password: mysecret
 
 solr:
   enabled: true
+  image:
+    repository: bitnami/solr
+    tag: 8.8.1
+  authentication:
+    enabled: true
+    adminUsername: admin
+    adminPassword: admin
+  coreName: hyrax
+  collection: hyrax
+  cloudBootstrap: true
+  cloudEnabled: true
+  persistence:
+    enabled: true
+  zookeeper:
+    enabled: true
+    persistence:
+      enabled: true
 
 autoscaling:
   enabled: false
@@ -90,6 +156,11 @@ autoscaling:
   targetCPUUtilizationPercentage: 80
   # targetMemoryUtilizationPercentage: 80
 
+global:
+  postgresql:
+    postgresqlUsername: hyrax
+    postgresqlPassword: hyrax_pass
+
 nodeSelector: {}
 
 tolerations: []