hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/chart/hyrax/Chart.yaml

@@ -0,0 +1,27 @@
+apiVersion: v2
+name: hyrax
+description: An open-source, Samvera-powered digital repository system
+type: application
+version: 0.4.1
+appVersion: 3.0.0-rc3
+dependencies:
+  - name: fcrepo
+    version: 0.4.1
+    repository: file://../fcrepo
+  - name: memcached
+    version: 4.2.21
+    repository: https://charts.bitnami.com/bitnami
+    condition: memcached.enabled
+  - name: postgresql
+    version: 9.3.3
+    repository: https://charts.bitnami.com/bitnami
+    condition: postgresql.enabled
+  - name: redis
+    version: 10.7.16
+    repository: https://charts.bitnami.com/bitnami
+    condition: redis.enabled
+  - name: solr
+    version: 1.5.2
+    repository: http://storage.googleapis.com/kubernetes-charts-incubator
+    condition: solr.enabled
+  # need something for fcrepo

data/chart/hyrax/README.md

@@ -0,0 +1,69 @@
+Hyrax Helm
+==========
+
+This [Helm][helm] chart provides configurable deployments for Hyrax applications
+to [Kubernetes][k8s] clusters. It seeks to be a complete but flexible
+production-ready setup for Hyrax applications. By default it deploys:
+
+  - A Hyrax-based Rails application
+  - Fedora Commons v4.7
+  - Postgresql
+  - Solr (in a cloud configuration, including Apache Zookeeper)
+  - Redis
+
+## A base Hyrax deployment
+
+Because Hyrax is a [Rails Engine][engine]---not a stand-alone application---
+deploying it requires us to have a specific application. This chart assumes that
+the user has a container image based on `samveralabs/hyrax` (see:
+[CONTAINERS.md][containers]) that includes their application. Point the chart at
+your image by setting the `image.repository` and `image.tag` values.
+
+By default, the chart deploys [images][dassie-images] for Hyrax's development
+application, [`dassie`][dassie].
+
+For application configuration, we take our queues from [12-factor][twelve]
+methodology. Applications using environment variables to manage their
+configuration can be easily reconfigured across different releases using this
+chart; e.g. the same chart can be used to deploy sandbox, staging, and
+production environments.
+
+The chart populates the following environment variables:
+
+|-------------------|--------------------------------|------------------------|
+| Variable          | Description                    | Condition              |
+|-------------------|--------------------------------|------------------------|
+| DB_HOST           | Postgresql hostname            | `postgresql.enabled`   |
+| DB_PORT           | Postgresql service port        | `postgresql.enabled`   |
+| MEMCACHED_HOST    | Memcached host                 | `memcached.enabled`    |
+| 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`         |
+|----------------- -|--------------------------------|------------------------|
+
+## For DevOps:
+
+For those interested in trying out or contributing to this Chart, it's helpful
+to setup a simple cluster locally. Various projects exist to make this easy; we
+recommend [`k3d`][k3d] or [minikube][minikube].
+
+For example, with `k3d`:
+
+```sh
+k3d cluster create dev-cluster --api-port 6550 -p 80:80@loadbalancer --agents 3
+```
+
+[containers]: ../../CONTAINERS.md#hyrax-image
+[dassie]: ../../.dassie/README.md
+[dassie-image]: https://hub.docker.com/r/samveralabs/dassie
+[engine]: https://guides.rubyonrails.org/engines.html
+[helm]: https://helm.sh
+[k3d]: https://k3d.io
+[k8s]: https://kubernetes.io
+[minikube]: https://minikube.sigs.k8s.io/docs/

data/chart/hyrax/templates/NOTES.txt

@@ -0,0 +1,21 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "hyrax.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "hyrax.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "hyrax.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "hyrax.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:3000
+{{- end }}

data/chart/hyrax/templates/_helpers.tpl

@@ -0,0 +1,92 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "hyrax.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "hyrax.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "hyrax.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "hyrax.labels" -}}
+helm.sh/chart: {{ include "hyrax.chart" . }}
+{{ include "hyrax.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "hyrax.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "hyrax.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "hyrax.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "hyrax.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create default fully qualified service names.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+*/}}
+{{- define "hyrax.fcrepo.fullname" -}}
+{{- printf "%s-%s" .Release.Name "fcrepo" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{- define "hyrax.memcached.fullname" -}}
+{{- printf "%s-%s" .Release.Name "memcached" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{- define "hyrax.postgresql.fullname" -}}
+{{- printf "%s-%s" .Release.Name "postgresql" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+
+{{- define "hyrax.redis.fullname" -}}
+{{- printf "%s-%s" .Release.Name "redis" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+
+{{- define "hyrax.solr.fullname" -}}
+{{- printf "%s-%s" .Release.Name "solr" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- define "hyrax.zk.fullname" -}}
+{{- printf "%s-%s" .Release.Name "zookeeper" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}

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

@@ -0,0 +1,32 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "hyrax.fullname" . }}-env
+  labels:
+    app.kubernetes.io/name: {{ include "hyrax.name" . }}
+    helm.sh/chart: {{ include "hyrax.chart" . }}
+    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_PORT: "5432"
+  {{- end }}
+  {{- if .Values.memcached.enabled }}
+  MEMCACHED_HOST: {{ template "hyrax.memcached.fullname" . }}
+  {{- end }}
+  RACK_ENV: production
+  RAILS_ENV: production
+  {{- if .Values.redis.enabled }}
+  REDIS_HOST: {{ template "hyrax.redis.fullname" . }}-master
+  {{- end }}
+  {{- if .Values.fcrepo.enabled }}
+  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
+  SOLR_PORT: "8983"
+  SOLR_URL: http://{{ template "hyrax.solr.fullname" . }}-svc:8983/solr/hyrax
+  {{- end }}

data/chart/hyrax/templates/deployment.yaml

@@ -0,0 +1,79 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "hyrax.fullname" . }}
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+{{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+{{- end }}
+  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-setup
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          envFrom:
+            - configMapRef:
+                name: {{ include "hyrax.fullname" . }}-env
+            - secretRef:
+                name: {{ template "hyrax.fullname" . }}
+          command:
+            - sh
+            - -c
+            - db-migrate-seed.sh
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "hyrax.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          envFrom:
+            - configMapRef:
+                name: {{ include "hyrax.fullname" . }}-env
+            - secretRef:
+                name: {{ template "hyrax.fullname" . }}
+          ports:
+            - name: http
+              containerPort: 3000
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

data/chart/hyrax/templates/fcrepo-secret.yaml

@@ -0,0 +1,13 @@
+{{- if .Values.fcrepo.enabled }}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "hyrax.fcrepo.fullname" . }}
+  labels:
+{{ include "hyrax.labels" . | indent 4 }}
+type: Opaque
+data:
+  DATABASE_PASSWORD: {{ .Values.postgresql.postgresqlPassword | b64enc }}
+  DATABASE_HOST: {{ include "fcrepo.postgresql.fullname" . | b64enc }}
+  JAVA_OPTS: {{ printf "-Dfcrepo.modeshape.configuration=\"classpath:/config/jdbc-postgresql/repository.json\" -Dfcrepo.postgresql.host=\"%s\" -Dfcrepo.postgresql.username=\"%s\" -Dfcrepo.postgresql.password=\"%s\" -Dfcrepo.object.directory=\"/data/objects\" -Dfcrepo.binary.directory=\"/data/binaries\"" ( include "fcrepo.postgresql.fullname" . ) .Values.postgresql.postgresqlUsername .Values.postgresql.postgresqlPassword | b64enc }}
+{{- end }}

data/chart/hyrax/templates/hpa.yaml

@@ -0,0 +1,28 @@
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2beta1
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "hyrax.fullname" . }}
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "hyrax.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+  {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: cpu
+        targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+  {{- end }}
+  {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: memory
+        targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
+  {{- end }}
+{{- end }}

data/chart/hyrax/templates/ingress.yaml

@@ -0,0 +1,41 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "hyrax.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ . }}
+            backend:
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+          {{- end }}
+    {{- end }}
+  {{- end }}

data/chart/hyrax/templates/secrets.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "hyrax.fullname" . }}
+  labels:
+{{ include "hyrax.labels" . | indent 4 }}
+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 }}
+  {{- end }}

data/chart/hyrax/templates/service.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "hyrax.fullname" . }}
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "hyrax.selectorLabels" . | nindent 4 }}

data/chart/hyrax/templates/serviceaccount.yaml

@@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "hyrax.serviceAccountName" . }}
+  labels:
+    {{- include "hyrax.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}