hyrax 3.0.1 → 3.0.2

data/chart/hyrax/templates/ingress.yaml

@@ -1,10 +1,11 @@
 {{- if .Values.ingress.enabled -}}
 {{- $fullName := include "hyrax.fullname" . -}}
 {{- $svcPort := .Values.service.port -}}
-{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+{{- $beta := semverCompare "<1.19-0" (default .Capabilities.KubeVersion.Version .Values.kubeVersion) -}}
+{{- if $beta }}
 apiVersion: networking.k8s.io/v1beta1
-{{- else -}}
-apiVersion: extensions/v1beta1
+{{- else }}
+apiVersion: networking.k8s.io/v1
 {{- end }}
 kind: Ingress
 metadata:
@@ -32,10 +33,18 @@ spec:
       http:
         paths:
           {{- range .paths }}
-          - path: {{ . }}
+          - path: {{ .path  }}
+            pathType: {{ .pathType | default "ImplementationSpecific" }}
             backend:
+              {{- if $beta }}
               serviceName: {{ $fullName }}
               servicePort: {{ $svcPort }}
+              {{- else }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- end }}
           {{- end }}
     {{- end }}
   {{- end }}

data/chart/hyrax/templates/secrets.yaml

@@ -7,7 +7,15 @@ metadata:
 type: Opaque
 data:
   SECRET_KEY_BASE: {{ randAlphaNum 20 | b64enc | quote }}
+  DB_PASSWORD: {{ include "hyrax.postgresql.password" . | 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.minio.enabled }}
+  MINIO_ACCESS_KEY: {{ .Values.minio.accessKey.password | b64enc}}
+  MINIO_SECRET_KEY: {{ .Values.minio.secretKey.password | b64enc}}
+  {{- end }}
+  {{- if not .Values.solrExistingSecret }}
+  SOLR_ADMIN_PASSWORD: {{ include "hyrax.solr.password" . | b64enc }}
+  {{- end }}
   {{- if .Values.redis.enabled }}
   REDIS_PASSWORD: {{ .Values.redis.password | b64enc}}
   SIDEKIQ_REDIS_URL: {{ include "hyrax.redis.url" . | b64enc }}

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

@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "hyrax.labels" . | nindent 4 }}
 spec:
-  accessModes:
-    - ReadWriteMany
+  {{ include "hyrax.sharedPvcAccessModes" . | nindent 2 }}
   resources:
     requests:
       storage: {{ .Values.uploadsVolume.size }}
+  storageClassName: {{ .Values.uploadsVolume.storageClass }}
 {{- end }}

data/chart/hyrax/values.yaml

@@ -10,33 +10,87 @@ image:
   # Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
+# use true to skip loading Hyrax engine database seed file
+skipHyraxEngineSeed: false
+
 # 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
+solrExistingSecret: ""
 externalSolrHost: ""
 externalSolrUser: ""
 externalSolrPassword: ""
 externalSolrCollection: "hyrax"
 
+# additional environment variables, evaluated as a template. e.g.
+#
+#  extraEnvVars:
+#    - name: RAILS_SERVE_STATIC_FILES
+#      value: "1"
+#    - name: GOOGLE_OAUTH_APP_NAME
+#      value: "my_hyrax_app"
+extraEnvVars: []
+
+## Extra init containers
+## Example
+##
+## extraInitContainers:
+##   - name: do-something
+##     image: busybox
+##     command: ['echo', 'Hello, Hyrax.']
+##
+extraInitContainers: []
+
+# Extra envFrom (secrets/configmaps)
+# Example
+#
+# extraEnvFrom:
+#   - configMapRef:
+#       name: existingConfigMap
+#   - secretRef:
+#       name: existingSecret
+#
+extraEnvFrom: []
+
+# an existing volume containing a Hyrax-based application
+# must be a ReadWriteMany volume if worker is enabled
+applicationExistingClaim: ""
+
 brandingVolume:
   enabled: true
+  # the name of an existing volume claim; must be an ReadWriteMany volume
   existingClaim: ""
   size: 2Gi
   storageClass: ""
 
 derivativesVolume:
   enabled: true
+  # the name of an existing volume claim; must be an ReadWriteMany volume
   existingClaim: ""
   size: 10Gi
   storageClass: ""
 
 uploadsVolume:
   enabled: true
+  # the name of an existing volume claim; must be an ReadWriteMany volume
   existingClaim: ""
   size: 20Gi
   storageClass: ""
 
+# additional volumes and volume mounts, evaluated as a template, e.g.
+#
+#  extraVolumeMounts
+#    - name: local-app
+#      mountPath: /app/samvera/hyrax-webapp
+#  extraVolumes:
+#    - name: local-app
+#      hostPath:
+#        path: /src
+#        type: DirectoryOrCreate
+extraVolumeMounts: []
+extraVolumes: []
+
 # configuration for an external/existing fcrepo service;
 #   ignored if `fcrepo.enabled` is true
 externalFcrepoHost: ""
@@ -93,7 +147,9 @@ ingress:
     # kubernetes.io/tls-acme: "true"
   hosts:
     - host: hyrax.local
-      paths: []
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
   tls: []
 
 livenessProbe:
@@ -117,11 +173,15 @@ readinessProbe:
 resources: {}
 
 worker:
+  enabled: true
   replicaCount: 3
   image:
     repository: samveralabs/dassie-worker
     pullPolicy: IfNotPresent
     tag: ""
+  extraInitContainers: []
+  extraVolumeMounts: []
+  extraVolumes: []
   imagePullSecrets: []
   podSecurityContext: {}
   nodeSelector: {}
@@ -142,6 +202,16 @@ fcrepo:
 memcached:
   enabled: false
 
+minio:
+  enabled: false
+  accessKey:
+    password: hyrax-access-key
+  secretKey:
+    password: hyrax-secret-key
+  persistence:
+    enabled: false
+  # defaultBuckets: bucketOne;bucketTwo
+
 postgresql:
   enabled: true
   image:

data/config/initializers/valkryrie_storage.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Valkyrie::StorageAdapter.register(
+  Valkyrie::Storage::Disk.new(base_path: Hyrax.config.branding_path,
+                              path_generator: Hyrax::ValkyrieSimplePathGenerator),
+  :branding_disk
+)

data/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       target: hyrax-engine-dev
       args:
         - EXTRA_APK_PACKAGES=git less
-    image: hyrax-engine-dev
+    image: ghcr.io/samvera/dassie
     stdin_open: true
     tty: true
     user: root
@@ -33,6 +33,8 @@ services:
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
       - rails-public:/app/samvera/hyrax-webapp/public
       - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - hyrax
 
   chrome:
     image: selenium/standalone-chrome:3.141
@@ -44,9 +46,11 @@ services:
     ports:
       - "4444:4444"
       - "5959:5900"
+    networks:
+      - hyrax
 
   db_migrate:
-    image: hyrax-engine-dev
+    image: ghcr.io/samvera/dassie
     user: root
     env_file:
       - .env
@@ -59,6 +63,8 @@ services:
       - .:/app/samvera/hyrax-engine:cached
       - rails-public:/app/samvera/hyrax-webapp/public
       - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - hyrax
 
   postgres:
     image: postgres:latest
@@ -72,33 +78,47 @@ services:
       - "5432:5432"
     volumes:
       - db:/var/lib/postgresql/data
+    networks:
+      - hyrax
 
   fcrepo:
-    image: cbeer/fcrepo4:4.7
+    image: ghcr.io/samvera/fcrepo4:4.7.5
     volumes:
-      - fcrepo:/data
+      - fcrepo:/data:cached
     ports:
       - 8080:8080
-    environment:
-      - JAVA_OPTS=${JAVA_OPTS} -Dfcrepo.modeshape.configuration="classpath:/config/file-simple/repository.json" -Dfcrepo.object.directory="/data/objects" -Dfcrepo.binary.directory="/data/binaries"
+    networks:
+      - hyrax
 
   memcached:
     image: bitnami/memcached
     ports:
       - '11211:11211'
+    networks:
+      - hyrax
 
   redis:
     image: redis:5-alpine
     volumes:
       - redis:/data
+    networks:
+      - hyrax
 
   sidekiq:
     build:
       context: .
       target: hyrax-engine-dev-worker
+    image: ghcr.io/samvera/dassie-worker
     env_file:
       - .env
       - .dassie/.env
+    depends_on:
+      - db_migrate
+      - fcrepo
+      - memcached
+      - postgres
+      - redis
+      - solr
     volumes:
       - .dassie:/app/samvera/hyrax-webapp:cached
       - .:/app/samvera/hyrax-engine:cached
@@ -106,6 +126,8 @@ services:
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
       - sidekiq-public:/app/samvera/hyrax-webapp/public
       - sidekiq-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - hyrax
 
   solr:
     image: solr:8.7
@@ -114,10 +136,12 @@ services:
     command:
       - sh
       - "-c"
-      - "precreate-core hyrax_test /opt/solr/server/configsets/hyraxconf; precreate-core hyrax-valkyrie-test /opt/solr/server/configsets/hyraxconf; solr-precreate hyrax /opt/solr/server/configsets/hyraxconf"
+      - "precreate-core hyrax_test /opt/solr/server/configsets/hyraxconf; precreate-core hyrax-valkyrie-test /opt/solr/server/configsets/hyraxconf; precreate-core hyrax-valkyrie-dev /opt/solr/server/configsets/hyraxconf; solr-precreate hyrax /opt/solr/server/configsets/hyraxconf"
     volumes:
-      - solr_home:/opt/solr/server/solr
+      - solr_home:/var/solr/data:cached
       - .dassie/solr/conf:/opt/solr/server/configsets/hyraxconf
+    networks:
+      - hyrax
 
 volumes:
   db:
@@ -130,3 +154,9 @@ volumes:
   sidekiq-public:
   sidekiq-tmp:
   solr_home:
+
+networks:
+  hyrax:
+    driver: bridge
+    driver_opts:
+      com.docker.network.bridge.name: br-hyrax

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

@@ -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.5 release.
+Hyrax requires Rails 5. We recommend the latest Rails 5.2 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.2.5
+gem install rails -v 5.2.6
 ```
 
 ### 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.5_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.1/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.2/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.1__. If you are looking for instructions on installing a different
+v3.0.2__. 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.5 release.
+Hyrax requires Rails 5. We recommend the latest Rails 5.2 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.2.5
+gem install rails -v 5.2.6
 ```
 
 ### 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.5_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.1/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.2/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/lib/hyrax/configuration.rb

@@ -385,6 +385,18 @@ module Hyrax
     # @!endgroup
     # @!group Valkyrie
 
+    ##
+    # @return [Valkyrie::StorageAdapter]
+    def branding_storage_adapter
+      @branding_storage_adapter ||= Valkyrie::StorageAdapter.find(:branding_disk)
+    end
+
+    ##
+    # @param [#to_sym] adapter
+    def branding_storage_adapter=(adapter)
+      @branding_storage_adapter = Valkyrie::StorageAdapter.find(adapter.to_sym)
+    end
+
     ##
     # @return [#save, #save_all, #delete, #wipe!] an indexing adapter
     def index_adapter

data/lib/hyrax/engine.rb

@@ -31,6 +31,7 @@ module Hyrax
     require 'hyrax/search_state'
     require 'hyrax/transactions'
     require 'hyrax/errors'
+    require 'hyrax/valkyrie_simple_path_generator'
 
     # Force these models to be added to Legato's registry in development mode
     config.eager_load_paths += %W[

data/lib/hyrax/resource_name.rb

@@ -7,6 +7,7 @@ module Hyrax
   class ResourceName < Name
     def initialize(klass, namespace = nil, name = nil)
       super
+      return unless defined?(Wings::ModelRegistry)
 
       legacy_model = Wings::ModelRegistry.lookup(klass)
       return unless legacy_model

data/lib/hyrax/specs/capybara.rb

@@ -15,9 +15,9 @@ require 'capybara/rspec'
 require 'capybara/rails'
 require 'capybara-screenshot/rspec'
 require 'selenium-webdriver'
-require 'webdrivers'
+require 'webdrivers' unless ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
 
-if ENV['IN_DOCKER'].present?
+if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
   args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
   args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
 

data/lib/hyrax/valkyrie_simple_path_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # Provide "simple", paths for the valkyrie disk storage adapter.
+  #
+  # By default, Valkyrie does bucketed/pairtree style paths. Since some of our
+  # older on-disk file storage does not do this, we need this to provide
+  # backward compatibility.
+  class ValkyrieSimplePathGenerator
+    attr_reader :base_path
+
+    def initialize(base_path:)
+      @base_path = base_path
+    end
+
+    def generate(resource:, file:, original_filename:) # rubocop:disable Lint/UnusedMethodArgument
+      Pathname.new(base_path).join(resource.id, original_filename)
+    end
+  end
+end