feat: deprecate postgres chart dependency (#150)

* feat: deprecate postgres chart dependency

* chore: update README note about postgres configuration

* chore: chart version 0.9.0

* chore: add issue link to deprecation warnings

* chore: add artifacthub changes annotation

README.md

@@ -16,9 +16,13 @@ $ helm repo add immich https://immich-app.github.io/immich-charts
 $ helm install --create-namespace --namespace immich immich immich/immich -f values.yaml
 ```
 
+You should not copy the full values.yaml from this repository. Only set the values that you want to override.
+
 There are a few things that you are required to configure in your values.yaml before installing the chart:
 * You need to separately create a PVC for your library volume and configure `immich.persistence.library.existingClaim` to reference that PVC
-* You need to make sure that Immich has access to a redis, and postgresql instance. You can do this either by enabling them directly in the values.yaml, or by manually setting the entries under the `env` key to point to existing instances.
+* You need to make sure that Immich has access to a redis and postgresql instance. 
+  * Redis can be enabled directly in the values.yaml, or by manually setting the `env` to point to an existing instance.
+  * You need to deploy a suitable postgres instance with the pgvecto.rs extension yourself.
 * You need to set `image.tag` to the version you want to use, as this chart does not update with every Immich release.
 
 # Configuration

charts/immich/Chart.yaml

@@ -2,7 +2,7 @@
 apiVersion: v2
 description: A chart to power Immich (immich.app) running on kubernetes
 name: immich
-version: 0.8.5
+version: 0.9.0
 appVersion: v1.119.0
 home: https://immich.app/
 icon: https://raw.githubusercontent.com/immich-app/immich/main/design/immich-logo.svg
@@ -28,5 +28,9 @@ dependencies:
     version: 19.5.3
 annotations:
   artifacthub.io/category: storage
-  artifacthub.io/changes: |
-    - Added default startupProbe for machine-learning to allow for preloading models
+  artifacthub.io/changes: |-
+    - kind: deprecated
+      description: Deprecated postgres chart dependency
+      links:
+        - name: Details
+          url: https://github.com/immich-app/immich-charts/issues/149

charts/immich/templates/checks.yaml

@@ -1 +1,7 @@
-{{- $name := .Values.immich.persistence.library.existingClaim | required ".Values.immich.persistence.library.existingClaim is required." -}}
+{{- $name := .Values.immich.persistence.library.existingClaim | required ".Values.immich.persistence.library.existingClaim is required." -}}
+
+{{ if .Values.postgresql.enabled }}
+  {{ if not .Values.useDeprecatedPostgresChart}}
+    {{ fail "The postgres subchart is deprecated. Please see https://github.com/immich-app/immich-charts/issues/149 for more detail." }}
+  {{ end }}
+{{ end }}

charts/immich/values.yaml

@@ -39,6 +39,9 @@ immich:
 
 # Dependencies
 
+# DEPRECATED
+# The postgres subchart is deprecated and will be removed in chart version 0.10.0
+# See https://github.com/immich-app/immich-charts/issues/149 for more detail.
 postgresql:
   enabled: false
   image: