Merge pull request #439 from truenas/NAS-115808

NAS-115808 / 22.12 / Add photoprism application

test/photoprism/.helmignore

@@ -0,0 +1,2 @@
+# Patterns to ignore when building packages.
+*.png

test/photoprism/1.0.0/Chart.yaml

@@ -0,0 +1,13 @@
+apiVersion: v2
+appVersion: "20220121"
+icon: https://photoprism.app/static/icons/logo.svg
+description: AI-powered app for browsing, organizing & sharing your photo collection.
+name: photoprism
+version: 1.0.0
+dependencies:
+- name: common
+  repository: file://../../../library/common/2112.0.0
+  version: 2112.0.0
+home: https://photoprism.app/
+keywords:
+- media

test/photoprism/1.0.0/README.md

@@ -0,0 +1,3 @@
+# Photo Prism
+
+PhotoPrism is a server-based application for browsing, organizing and sharing your personal photo collection.

test/photoprism/1.0.0/app-readme.md

@@ -0,0 +1,3 @@
+# Photo Prism
+
+PhotoPrism is a server-based application for browsing, organizing and sharing your personal photo collection.

test/photoprism/1.0.0/ix_values.yaml

@@ -0,0 +1,4 @@
+image:
+  pullPolicy: IfNotPresent
+  repository: photoprism/photoprism
+  tag: "20220121"

test/photoprism/1.0.0/questions.yaml

@@ -0,0 +1,255 @@
+groups:
+  - name: "Configuration"
+    description: "Photo Prism application configuration"
+  - name: "Storage"
+    description: "Configure storage for photo prism"
+  - name: "Networking"
+    description: "Networking Configuration for photo prism"
+  - name: "Advanced DNS Settings"
+    description: "Configure DNS settings"
+
+portals:
+  web_portal:
+    protocols:
+      - "http"
+    host:
+      - "$node_ip"
+    ports:
+      - "$variable-web_port"
+    path: "/admin/"
+
+questions:
+  - variable: web_port
+    label: "Web Port for photo prism"
+    group: Networking
+    schema:
+      type: int
+      min: 8000
+      max: 65535
+      default: 20800
+      required: true
+
+  - variable: dnsConfig
+    label: "DNS Configuration"
+    group: "Advanced DNS Settings"
+    schema:
+      type: dict
+      attrs:
+        - variable: options
+          label: "DNS Options"
+          schema:
+            type: list
+            items:
+              - variable: optionsEntry
+                label: "Option Entry Configuration"
+                schema:
+                  type: dict
+                  attrs:
+                    - variable: name
+                      label: "Option Name"
+                      schema:
+                        type: string
+                        required: true
+                    - variable: value
+                      label: "Option Value"
+                      schema:
+                        type: string
+                        required: true
+
+  - variable: ownerUID
+    label: "Storage User ID"
+    description: "User ID of the storage volume being used (application will chown the storage volume path with specified UID)"
+    group: Configuration
+    schema:
+      type: int
+      default: 568
+      min: 1
+      max: 65535
+
+  - variable: ownerGID
+    label: "Storage Group ID"
+    description: "Group ID of the storage volume being used (application will chown the storage volume path with specified GID)"
+    group: Configuration
+    schema:
+      type: int
+      default: 568
+      min: 1
+      max: 65535
+
+  - variable: password
+    label: "Password"
+    group: "Configuration"
+    schema:
+      type: string
+      private: true
+      required: true
+      empty: false
+      immutable: true
+      default: "admin123"
+      show_if: [["public", "=", false]]
+
+  - variable: public
+    label: "Enable Public Access"
+    description: "Disable password authentication, WebDAV, and the advanced settings page"
+    group: "Configuration"
+    schema:
+      type: boolean
+      default: false
+
+  - variable: environmentVariables
+    label: "Photo Prism environment"
+    group: "Configuration"
+    schema:
+      type: list
+      default: []
+      items:
+        - variable: environmentVariable
+          label: "Environment Variable"
+          schema:
+            type: dict
+            attrs:
+              - variable: name
+                label: "Name"
+                schema:
+                  type: string
+              - variable: value
+                label: "Value"
+                schema:
+                  type: string
+
+  - variable: appVolumeMounts
+    label: "Photo Prism Storage"
+    group: "Storage"
+    schema:
+      type: dict
+      attrs:
+        - variable: original
+          label: "Storage Volume for Original Media"
+          schema:
+            type: dict
+            attrs:
+              - variable: datasetName
+                label: "Original Storage Volume Dataset Name"
+                schema:
+                  type: string
+                  hidden: true
+                  $ref:
+                    - "normalize/ixVolume"
+                  show_if: [["hostPathEnabled", "=", false]]
+                  default: "ix-photoprism_original"
+                  editable: false
+              - variable: mountPath
+                label: "Original Storage Mount Path"
+                description: "Path where the volume will be mounted inside the pod"
+                schema:
+                  type: path
+                  hidden: true
+                  editable: true
+                  default: "/photoprism/originals"
+              - variable: hostPathEnabled
+                label: "Enable Custom Host Path for Photo Prism Original Storage Volume"
+                schema:
+                  type: boolean
+                  default: false
+                  show_subquestions_if: true
+                  subquestions:
+                    - variable: hostPath
+                      label: "Host Path for Photo Prism Original Storage Volume"
+                      schema:
+                        type: hostpath
+                        required: true
+        - variable: storage
+          label: "Storage Volume for sidecar/cache/database"
+          schema:
+            type: dict
+            attrs:
+              - variable: datasetName
+                label: "Storage Volume Dataset Name"
+                schema:
+                  type: string
+                  hidden: true
+                  $ref:
+                    - "normalize/ixVolume"
+                  show_if: [["hostPathEnabled", "=", false]]
+                  default: "ix-photoprism_storage"
+                  editable: false
+              - variable: mountPath
+                label: "Storage Mount Path"
+                description: "Path where the volume will be mounted inside the pod"
+                schema:
+                  type: path
+                  hidden: true
+                  editable: true
+                  default: "/photoprism/storage"
+              - variable: hostPathEnabled
+                label: "Enable Custom Host Path for Photo Prism Storage Volume"
+                schema:
+                  type: boolean
+                  default: false
+                  show_subquestions_if: true
+                  subquestions:
+                    - variable: hostPath
+                      label: "Host Path for Photo Prism Storage Volume"
+                      schema:
+                        type: hostpath
+                        required: true
+        - variable: import
+          label: "Storage Volume for imports"
+          schema:
+            type: dict
+            attrs:
+              - variable: datasetName
+                label: "Import Storage Volume Dataset Name"
+                schema:
+                  type: string
+                  hidden: true
+                  $ref:
+                    - "normalize/ixVolume"
+                  show_if: [["hostPathEnabled", "=", false]]
+                  default: "ix-photoprism_import"
+                  editable: false
+              - variable: mountPath
+                label: "Storage Mount Path"
+                description: "Path where the volume will be mounted inside the pod"
+                schema:
+                  type: path
+                  hidden: true
+                  editable: true
+                  default: "/photoprism/import"
+              - variable: hostPathEnabled
+                label: "Enable Custom Host Path for Photo Prism Import Storage Volume"
+                schema:
+                  type: boolean
+                  default: false
+                  show_subquestions_if: true
+                  subquestions:
+                    - variable: hostPath
+                      label: "Host Path for Photo Prism Import Storage Volume"
+                      schema:
+                        type: hostpath
+                        required: true
+
+  - variable: extraAppVolumeMounts
+    label: "Extra Host Path Volumes"
+    group: "Storage"
+    schema:
+      type: list
+      items:
+        - variable: extraAppVolume
+          label: "Host Path Volume"
+          description: "Add an extra host path volume for Photo Prism application"
+          schema:
+            type: dict
+            attrs:
+              - variable: mountPath
+                label: "Mount Path in Pod"
+                description: "Path where the volume will be mounted inside the pod"
+                schema:
+                  type: path
+                  required: true
+              - variable: hostPath
+                label: "Host Path"
+                description: "Host path"
+                schema:
+                  type: hostpath
+                  required: true

test/photoprism/1.0.0/templates/deployment.yaml

@@ -0,0 +1,51 @@
+apiVersion: {{ template "common.capabilities.deployment.apiVersion" . }}
+kind: Deployment
+metadata:
+  name: {{ template "common.names.fullname" . }}
+  labels:
+    app: {{ template "common.names.name" . }}
+    chart: {{ template "common.names.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+  annotations:
+    rollme: {{ randAlphaNum 5 | quote }}
+spec:
+  replicas: {{ (default 1 .Values.replicas) }}
+  strategy:
+    type: "Recreate"
+  selector:
+    matchLabels:
+      app: {{ template "common.names.name" . }}
+      release: {{ .Release.Name }}
+  template:
+    metadata:
+      name: {{ template "common.names.fullname" . }}
+      labels:
+        app: {{ template "common.names.name" . }}
+        release: {{ .Release.Name }}
+        {{- include "common.labels.selectorLabels" . | nindent 8 }}
+      annotations: {{ include "common.annotations" . | nindent 8 }}
+    spec:
+      hostNetwork: false
+      containers:
+        - name: {{ .Chart.Name }}
+          {{ include "common.containers.imageConfig" .Values.image | nindent 10 }}
+          volumeMounts: {{ include "common.storage.configureAppVolumeMountsInContainer" .Values | nindent 12 }}
+          ports:
+            - name: web
+              containerPort: 2342
+          env:
+            {{ $secretName := (include "common.names.fullname" .) }}
+            {{ $envList := (default list .Values.environmentVariables) }}
+            {{ $envList = mustAppend $envList (dict "name" "PHOTOPRISM_ADMIN_PASSWORD" "valueFromSecret" true "secretName" $secretName "secretKey" "password") }}
+            {{ if .Values.public }}
+            {{ $envList = mustAppend $envList (dict "name" "PHOTOPRISM_PUBLIC" "value" "true") }}
+            {{ end }}
+            {{ include "common.containers.environmentVariables" (dict "environmentVariables" $envList) | nindent 12 }}
+{{ include "common.networking.dnsConfiguration" .Values | nindent 6 }}
+      volumes: {{ include "common.storage.configureAppVolumes" .Values | nindent 8 }}
+      {{ range $index, $hostPathConfiguration := .Values.extraAppVolumeMounts }}
+        - name: extrappvolume-{{ $index }}
+          hostPath:
+            path: {{ $hostPathConfiguration.hostPath }}
+      {{ end }}

test/photoprism/1.0.0/templates/pre-install-job.yaml

@@ -0,0 +1,34 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: "{{ template "common.names.fullname" . }}-preinstall-job"
+  labels:
+    app.kubernetes.io/managed-by: {{ .Release.Service | quote }}
+    app.kubernetes.io/instance: {{ .Release.Name | quote }}
+    app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+    helm.sh/chart: {{ template "common.names.chart" . }}
+  annotations:
+    "helm.sh/hook": pre-install
+    "helm.sh/hook-delete-policy": hook-succeeded
+spec:
+  template:
+    metadata:
+      name: "{{ template "common.names.fullname" . }}-preinstall-hook"
+      labels:
+        app.kubernetes.io/managed-by: {{ .Release.Service | quote }}
+        app.kubernetes.io/instance: {{ .Release.Name | quote }}
+        helm.sh/chart: {{ template "common.names.chart" . }}
+    spec:
+      restartPolicy: Never
+      containers:
+      - name: pre-install-job
+        image: "alpine:latest"
+        command:
+          - "chown"
+          - "-R"
+          - "{{ .Values.ownerUID }}:{{ .Values.ownerGID }}"
+          - "{{ .Values.appVolumeMounts.storage.mountPath }}"
+          - "{{ .Values.appVolumeMounts.original.mountPath }}"
+          - "{{ .Values.appVolumeMounts.import.mountPath }}"
+        volumeMounts: {{ include "common.storage.configureAppVolumeMountsInContainer" .Values | nindent 12 }}
+      volumes: {{ include "common.storage.configureAppVolumes" .Values | nindent 8 }}

test/photoprism/1.0.0/templates/secret.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ template "common.names.fullname" . }}
+  labels: {{ include "common.labels" . | nindent 4 }}
+type: Opaque
+data:
+  password: {{ .Values.password | b64enc | quote }}

test/photoprism/1.0.0/templates/service.yaml

@@ -0,0 +1,9 @@
+{{ $selectors := list }}
+{{ $selectors = mustAppend $selectors (dict "key" "app" "value" (include "common.names.name" .) ) }}
+{{ $selectors = mustAppend $selectors (dict "key" "release" "value" .Release.Name ) }}
+{{ $ports := list }}
+{{ $ports = mustAppend $ports (dict "name" "web" "port" .Values.web_port "nodePort" .Values.web_port "targetPort" 2342) }}
+{{ $params := . }}
+{{ $_ := set $params "commonService" (dict "type" "NodePort" "ports" $ports ) }}
+{{ $_1 := set .Values "extraSelectorLabels" $selectors }}
+{{ include "common.classes.service" $params }}

test/photoprism/1.0.0/templates/tests/deployment-check.yaml

@@ -0,0 +1,21 @@
+{{- $serviceName := (include "common.names.fullname" .) -}}
+apiVersion: v1
+kind: Pod
+metadata:
+  name: {{ .Release.Name }}-photoprism
+  labels:
+    app: {{ .Release.Name }}
+    release: {{ .Release.Name }}
+  annotations:
+    "helm.sh/hook": test
+spec:
+    containers:
+      - name: test-curl
+        image: alpine/curl
+        imagePullPolicy: "IfNotPresent"
+        command:
+          - /bin/sh
+          - -ec
+          - |
+            curl --connect-timeout 5 --max-time 10 --retry 5 --retry-delay 15 --retry-max-time 90 --retry-all-errors -ksf http://{{ $serviceName }}:{{.Values.web_port}}/
+    restartPolicy: Never

test/photoprism/1.0.0/test_values.yaml

@@ -0,0 +1,24 @@
+image:
+  pullPolicy: IfNotPresent
+  repository: photoprism/photoprism
+  tag: "20220121"
+password: "admin123"
+environmentVariables: []
+extraAppVolumeMounts: []
+web_port: 32000
+dnsConfig:
+  options: []
+emptyDirVolumes: true
+appVolumeMounts:
+  original:
+    emptyDir: true
+    mountPath: /photoprism/originals
+  storage:
+    emptyDir: true
+    mountPath: /photoprism/storage
+  import:
+    emptyDir: true
+    mountPath: /photoprism/import
+ownerUID: 568
+ownerGID: 568
+public: false

test/photoprism/item.yaml

@@ -0,0 +1,3 @@
+icon_url: https://photoprism.app/static/icons/logo.svg
+categories:
+- media

test/photoprism/upgrade_info.json

@@ -0,0 +1 @@
+{"filename":  "ix_values.yaml", "keys": ["image"]}

test/photoprism/upgrade_strategy

@@ -0,0 +1,25 @@
+#!/usr/bin/python3
+import json
+import sys
+
+from catalog_update.upgrade_strategy import semantic_versioning
+
+
+def newer_mapping(image_tags):
+    key = list(image_tags.keys())[0]
+    tags = {t: t for t in image_tags[key]}
+    version = semantic_versioning(list(tags))
+    if not version:
+        return {}
+
+    return {
+        'tags': {key: tags[version]},
+        'app_version': version,
+    }
+
+
+if __name__ == '__main__':
+    if len(sys.argv) != 2:
+        exit(1)
+
+    print(json.dumps(newer_mapping(json.loads(sys.argv[1]))))