Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: deprecate postgres chart dependency #150

Merged
merged 5 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 7 additions & 3 deletions charts/immich/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
8 changes: 7 additions & 1 deletion charts/immich/templates/checks.yaml
Original file line number Diff line number Diff line change
@@ -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 }}
3 changes: 3 additions & 0 deletions charts/immich/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading