From 3c3397c6518c296a602dc222a658fdae641ccf74 Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Tue, 17 Dec 2024 15:46:39 +0100 Subject: [PATCH 1/5] feat: deprecate postgres chart dependency --- charts/immich/templates/checks.yaml | 8 +++++++- charts/immich/values.yaml | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/charts/immich/templates/checks.yaml b/charts/immich/templates/checks.yaml index d34a209c..937a62d3 100644 --- a/charts/immich/templates/checks.yaml +++ b/charts/immich/templates/checks.yaml @@ -1 +1,7 @@ -{{- $name := .Values.immich.persistence.library.existingClaim | required ".Values.immich.persistence.library.existingClaim is required." -}} \ No newline at end of file +{{- $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 for more detail." }} + {{ end }} +{{ end }} diff --git a/charts/immich/values.yaml b/charts/immich/values.yaml index 03836383..8991f266 100644 --- a/charts/immich/values.yaml +++ b/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 for more detail. postgresql: enabled: false image: From a5ed891532e19fa4104d186d376c37fe73d33bc6 Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Tue, 17 Dec 2024 15:54:39 +0100 Subject: [PATCH 2/5] chore: update README note about postgres configuration --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a12596ec..f62dc088 100644 --- a/README.md +++ b/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 From ce6252325ba95b668b72b31c111e3648f59c1e68 Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Tue, 17 Dec 2024 15:55:08 +0100 Subject: [PATCH 3/5] chore: chart version 0.9.0 --- charts/immich/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/immich/Chart.yaml b/charts/immich/Chart.yaml index 39388217..b38a84ef 100644 --- a/charts/immich/Chart.yaml +++ b/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 From 3eb81f1a5724d54890602dea151e6d104f1f94a5 Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Tue, 17 Dec 2024 15:56:15 +0100 Subject: [PATCH 4/5] chore: add issue link to deprecation warnings --- charts/immich/templates/checks.yaml | 2 +- charts/immich/values.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/immich/templates/checks.yaml b/charts/immich/templates/checks.yaml index 937a62d3..b67aa674 100644 --- a/charts/immich/templates/checks.yaml +++ b/charts/immich/templates/checks.yaml @@ -2,6 +2,6 @@ {{ if .Values.postgresql.enabled }} {{ if not .Values.useDeprecatedPostgresChart}} - {{ fail "The postgres subchart is deprecated. Please see for more detail." }} + {{ fail "The postgres subchart is deprecated. Please see https://github.com/immich-app/immich-charts/issues/149 for more detail." }} {{ end }} {{ end }} diff --git a/charts/immich/values.yaml b/charts/immich/values.yaml index 8991f266..1cc095c9 100644 --- a/charts/immich/values.yaml +++ b/charts/immich/values.yaml @@ -41,7 +41,7 @@ immich: # DEPRECATED # The postgres subchart is deprecated and will be removed in chart version 0.10.0 -# See for more detail. +# See https://github.com/immich-app/immich-charts/issues/149 for more detail. postgresql: enabled: false image: From 1482e122d4a662760566279ee0d82fe825cd26dc Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Thu, 19 Dec 2024 14:13:49 +0100 Subject: [PATCH 5/5] chore: add artifacthub changes annotation --- charts/immich/Chart.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/charts/immich/Chart.yaml b/charts/immich/Chart.yaml index b38a84ef..f166a1e5 100644 --- a/charts/immich/Chart.yaml +++ b/charts/immich/Chart.yaml @@ -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