hyrax 3.0.0 → 3.0.1

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

@@ -13,15 +13,22 @@ data:
   {{- if .Values.memcached.enabled }}
   MEMCACHED_HOST: {{ template "hyrax.memcached.fullname" . }}
   {{- end }}
+  {{- if .Values.derivativesVolume.enabled }}
+  HYRAX_BRANDING_PATH: "/app/samvera/branding"
+  HYRAX_DERIVATIVES_PATH: "/app/samvera/derivatives"
+  HYRAX_CACHE_PATH: "/app/samvera/file_cache"
+  HYRAX_UPLOAD_PATH: "/app/samvera/uploads"
+  {{- end }}
   RACK_ENV: production
   RAILS_ENV: production
   {{- if .Values.redis.enabled }}
-  REDIS_HOST: {{ template "hyrax.redis.fullname" . }}-master
+  REDIS_HOST: {{ template "hyrax.redis.host" . }}
   {{- end }}
   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_REST_PATH: {{ .Values.fcrepo.restPath | default "rest" }}
+  REDIS_PROVIDER: SIDEKIQ_REDIS_URL
   SOLR_ADMIN_USER: {{ template "hyrax.solr.username" . }}
   SOLR_ADMIN_PASSWORD: {{ template "hyrax.solr.password" . }}
   SOLR_COLLECTION_NAME: {{ template "hyrax.solr.collectionName" . }}

data/chart/hyrax/templates/deployment-worker.yaml

@@ -0,0 +1,92 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "hyrax.fullname" . }}-worker
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.worker.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "hyrax.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+    {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      labels:
+        {{- include "hyrax.selectorLabels" . | nindent 8 }}
+    spec:
+      initContainers:
+        - name: db-wait
+          image: "{{ .Values.worker.image.repository }}:{{ .Values.worker.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.worker.image.pullPolicy }}
+          envFrom:
+            - configMapRef:
+                name: {{ include "hyrax.fullname" . }}-env
+            - secretRef:
+                name: {{ template "hyrax.fullname" . }}
+          command:
+            - sh
+            - -c
+            - db-wait.sh "$DB_HOST:$DB_PORT"
+            - db-wait.sh "$FCREPO_HOST:$FCREPO_PORT"
+            - db-wait.sh "$SOLR_HOST:$SOLR_PORT"
+      serviceAccountName: {{ include "hyrax.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}-worker
+          image: "{{ .Values.worker.image.repository }}:{{ .Values.worker.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.worker.image.pullPolicy }}
+          envFrom:
+            - configMapRef:
+                name: {{ include "hyrax.fullname" . }}-env
+            - secretRef:
+                name: {{ template "hyrax.fullname" . }}
+          volumeMounts:
+            - name: derivatives
+              mountPath: /app/samvera/derivatives
+            - name: uploads
+              subPath: file_cache
+              mountPath: /app/samvera/file_cache
+            - name: uploads
+              subPath: uploads
+              mountPath: /app/samvera/uploads
+          resources:
+            {{- toYaml .Values.worker.resources | nindent 12 }}
+      volumes:
+        - name: "derivatives"
+          {{- if and .Values.derivativesVolume.enabled .Values.derivativesVolume.existingClaim }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.derivativesVolume.existingClaim }}
+          {{- else if .Values.derivativesVolume.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ template "hyrax.fullname" . }}-derivatives
+          {{ else }}
+          emptyDir: {}
+          {{ end }}
+        - name: "uploads"
+          {{- if and .Values.uploadsVolume.enabled .Values.uploadsVolume.existingClaim }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.uploadsVolume.existingClaim }}
+          {{- else if .Values.uploadsVolume.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ template "hyrax.fullname" . }}-uploads
+          {{ else }}
+          emptyDir: {}
+          {{ end }}
+
+      {{- with .Values.worker.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.worker.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.worker.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

data/chart/hyrax/templates/deployment.yaml

@@ -95,8 +95,50 @@ spec:
               path: {{ .Values.readinessProbe.path | default "/" }}
               port: 3000
           {{- end }}
+          volumeMounts:
+            - name: branding
+              mountPath: /app/samvera/branding
+            - name: derivatives
+              mountPath: /app/samvera/derivatives
+            - name: uploads
+              subPath: file_cache
+              mountPath: /app/samvera/file_cache
+            - name: uploads
+              subPath: uploads
+              mountPath: /app/samvera/uploads
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
+      volumes:
+        - name: "branding"
+          {{- if and .Values.brandingVolume.enabled .Values.brandingVolume.existingClaim }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.brandingVolume.existingClaim }}
+          {{- else if .Values.brandingVolume.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ template "hyrax.fullname" . }}-branding
+          {{ else }}
+          emptyDir: {}
+          {{ end }}
+        - name: "derivatives"
+          {{- if and .Values.derivativesVolume.enabled .Values.derivativesVolume.existingClaim }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.derivativesVolume.existingClaim }}
+          {{- else if .Values.derivativesVolume.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ template "hyrax.fullname" . }}-derivatives
+          {{ else }}
+          emptyDir: {}
+          {{ end }}
+        - name: "uploads"
+          {{- if and .Values.uploadsVolume.enabled .Values.uploadsVolume.existingClaim }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.uploadsVolume.existingClaim }}
+          {{- else if .Values.uploadsVolume.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ template "hyrax.fullname" . }}-uploads
+          {{ else }}
+          emptyDir: {}
+          {{ end }}
       {{- with .Values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}

data/chart/hyrax/templates/derivatives-pvc.yaml

@@ -0,0 +1,14 @@
+{{- if and .Values.derivativesVolume.enabled (not .Values.derivativesVolume.existingClaim) }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ template "hyrax.fullname" . }}-derivatives
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  accessModes:
+    - ReadWriteMany
+  resources:
+    requests:
+      storage: {{ .Values.derivativesVolume.size }}
+{{- end }}

data/chart/hyrax/templates/secrets.yaml

@@ -10,4 +10,5 @@ data:
   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}}
+  SIDEKIQ_REDIS_URL: {{ include "hyrax.redis.url" . | b64enc }}
   {{- end }}

data/chart/hyrax/templates/uploads-pvc.yaml

@@ -0,0 +1,14 @@
+{{- if and .Values.uploadsVolume.enabled (not .Values.uploadsVolume.existingClaim) }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ template "hyrax.fullname" . }}-uploads
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  accessModes:
+    - ReadWriteMany
+  resources:
+    requests:
+      storage: {{ .Values.uploadsVolume.size }}
+{{- end }}

data/chart/hyrax/values.yaml

@@ -19,6 +19,24 @@ externalSolrUser: ""
 externalSolrPassword: ""
 externalSolrCollection: "hyrax"
 
+brandingVolume:
+  enabled: true
+  existingClaim: ""
+  size: 2Gi
+  storageClass: ""
+
+derivativesVolume:
+  enabled: true
+  existingClaim: ""
+  size: 10Gi
+  storageClass: ""
+
+uploadsVolume:
+  enabled: true
+  existingClaim: ""
+  size: 20Gi
+  storageClass: ""
+
 # configuration for an external/existing fcrepo service;
 #   ignored if `fcrepo.enabled` is true
 externalFcrepoHost: ""
@@ -98,6 +116,19 @@ readinessProbe:
 
 resources: {}
 
+worker:
+  replicaCount: 3
+  image:
+    repository: samveralabs/dassie-worker
+    pullPolicy: IfNotPresent
+    tag: ""
+  imagePullSecrets: []
+  podSecurityContext: {}
+  nodeSelector: {}
+  tolerations: []
+  affinity: {}
+  resources: {}
+
 fcrepo:
   enabled: true
   externalDatabaseUsername: "hyrax"

data/config/features.rb

@@ -1,46 +1,50 @@
 # frozen_string_literal: true
 Flipflop.configure do
-  # Strategies will be used in the order listed here.
-  strategy :cookie
-  strategy :active_record, class: Hyrax::Feature
-  strategy Hyrax::Strategies::YamlStrategy, config: Hyrax.config.feature_config_path
-  strategy :default
-
-  feature :proxy_deposit,
-          default: true,
-          description: "Depositors may designate proxies to deposit works on their behalf"
-
-  feature :transfer_works,
-          default: true,
-          description: "Depositors may transfer their works to another user"
-
-  # Note, if this is deactivated, a default admin set will be created and all
-  # works will be assigned to it when they are created.
-  feature :assign_admin_set,
-          default: true,
-          description: "Ability to assign uploaded items to an admin set"
-
-  feature :show_deposit_agreement,
-          default: true,
-          description: "Show a deposit agreement to users creating works"
-
-  feature :active_deposit_agreement_acceptance,
-          default: Hyrax.config.active_deposit_agreement_acceptance?,
-          description: "Require an active acceptance of the deposit agreement by checking a checkbox"
-
-  feature :batch_upload,
-          default: false,
-          description: "Enable uploading batches of works"
-
-  feature :hide_private_items,
-          default: false,
-          description: "Do not show the private items."
-
-  feature :hide_users_list,
-          default: true,
-          description: "Do not show users list unless user has authenticated."
-
-  feature :cache_work_iiif_manifest,
-          default: false,
-          description: "Use Rails.cache to cache the JSON document for IIIF manifests"
+  begin
+    # Strategies will be used in the order listed here.
+    strategy :cookie
+    strategy :active_record, class: Hyrax::Feature
+    strategy Hyrax::Strategies::YamlStrategy, config: Hyrax.config.feature_config_path
+    strategy :default
+
+    feature :proxy_deposit,
+            default: true,
+            description: "Depositors may designate proxies to deposit works on their behalf"
+
+    feature :transfer_works,
+            default: true,
+            description: "Depositors may transfer their works to another user"
+
+    # Note, if this is deactivated, a default admin set will be created and all
+    # works will be assigned to it when they are created.
+    feature :assign_admin_set,
+            default: true,
+            description: "Ability to assign uploaded items to an admin set"
+
+    feature :show_deposit_agreement,
+            default: true,
+            description: "Show a deposit agreement to users creating works"
+
+    feature :active_deposit_agreement_acceptance,
+            default: Hyrax.config.active_deposit_agreement_acceptance?,
+            description: "Require an active acceptance of the deposit agreement by checking a checkbox"
+
+    feature :batch_upload,
+            default: false,
+            description: "Enable uploading batches of works"
+
+    feature :hide_private_items,
+            default: false,
+            description: "Do not show the private items."
+
+    feature :hide_users_list,
+            default: true,
+            description: "Do not show users list unless user has authenticated."
+
+    feature :cache_work_iiif_manifest,
+            default: false,
+            description: "Use Rails.cache to cache the JSON document for IIIF manifests"
+  rescue Flipflop::StrategyError, Flipflop::FeatureError => err
+    Rails.logger.warn "Ignoring #{err}: #{err.message}"
+  end
 end

data/config/initializers/listeners.rb

@@ -2,12 +2,14 @@
 
 Hyrax.publisher.subscribe(Hyrax::Listeners::AclIndexListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::ActiveFedoraAclIndexListener.new)
+Hyrax.publisher.subscribe(Hyrax::Listeners::MemberCleanupListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::MetadataIndexListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::BatchNotificationListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::ObjectLifecycleListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::FileSetLifecycleListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::FileSetLifecycleNotificationListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::ProxyDepositListener.new)
+Hyrax.publisher.subscribe(Hyrax::Listeners::TrophyCleanupListener.new)
 Hyrax.publisher.subscribe(Hyrax::Listeners::WorkflowListener.new)
 
 # Publish events from old style Hyrax::Callbacks to trigger the listeners

data/documentation/developing-your-hyrax-based-app.md

@@ -30,7 +30,7 @@ A Hyrax-based application includes lots of dependencies. We provide a [Docker im
 You can also try [Running Hyrax-based application in local VM](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide#running-hyrax-based-application-in-local-vm) which uses Ubuntu.
 
 This document contains instructions specific to setting up an app with __Hyrax
-v3.0.0__. If you are looking for instructions on installing a different
+v3.0.1__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -105,11 +105,11 @@ Starting up Redis will depend on your operating system, and may in fact already
 
 ## Rails
 
-Hyrax requires Rails 5. We recommend the latest Rails 5.2 release.
+Hyrax requires Rails 5. We recommend the latest Rails 5.2.5 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.2.4.4
+gem install rails -v 5.2.5
 ```
 
 ### JavaScript runtime
@@ -125,7 +125,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.4.4_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.0/template.rb
+rails _5.2.5_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.1/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/documentation/legacyREADME.md

@@ -50,7 +50,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v3.0.0-rc3__. If you are looking for instructions on installing a different
+v3.0.1__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -139,11 +139,11 @@ Starting up Redis will depend on your operating system, and may in fact already
 
 ## Rails
 
-Hyrax requires Rails 5. We recommend the latest Rails 5.2 release.
+Hyrax requires Rails 5. We recommend the latest Rails 5.2.5 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.2.4.4
+gem install rails -v 5.2.5
 ```
 
 ### JavaScript runtime
@@ -159,7 +159,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.4.4_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.0-rc3/template.rb
+rails _5.2.5_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.1/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/lib/generators/hyrax/templates/config/initializers/riiif.rb

@@ -1,27 +1,29 @@
 # frozen_string_literal: true
-Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
-Riiif::Image.info_service = lambda do |id, _file|
-  # id will look like a path to a pcdm:file
-  # (e.g. rv042t299%2Ffiles%2F6d71677a-4f80-42f1-ae58-ed1063fd79c7)
-  # but we just want the id for the FileSet it's attached to.
+ActiveSupport::Reloader.to_prepare do
+  Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
+  Riiif::Image.info_service = lambda do |id, _file|
+    # id will look like a path to a pcdm:file
+    # (e.g. rv042t299%2Ffiles%2F6d71677a-4f80-42f1-ae58-ed1063fd79c7)
+    # but we just want the id for the FileSet it's attached to.
 
-  # Capture everything before the first slash
-  fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
-  resp = Hyrax::SolrService.get("id:#{fs_id}")
-  doc = resp['response']['docs'].first
-  raise "Unable to find solr document with id:#{fs_id}" unless doc
-  { height: doc['height_is'], width: doc['width_is'], format: doc['mime_type_ssi'], channels: doc['alpha_channels_ssi'] }
-end
+    # Capture everything before the first slash
+    fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
+    resp = Hyrax::SolrService.get("id:#{fs_id}")
+    doc = resp['response']['docs'].first
+    raise "Unable to find solr document with id:#{fs_id}" unless doc
+    { height: doc['height_is'], width: doc['width_is'], format: doc['mime_type_ssi'], channels: doc['alpha_channels_ssi'] }
+  end
 
-Riiif::Image.file_resolver.id_to_uri = lambda do |id|
-  Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
-    Rails.logger.info "Riiif resolved #{id} to #{url}"
+  Riiif::Image.file_resolver.id_to_uri = lambda do |id|
+    Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
+      Rails.logger.info "Riiif resolved #{id} to #{url}"
+    end
   end
-end
 
-Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
+  Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
 
-Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
-Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
+  Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
+  Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
 
-Riiif::Engine.config.cache_duration = 365.days
+  Riiif::Engine.config.cache_duration = 365.days
+end