From 3b1f27b67402e7c8a3bf4d7df87aaf4f4d13a315 Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Wed, 25 Jan 2023 17:07:25 +0100 Subject: [PATCH] docs(install): Add kubernetes deployment documentation (#1418) * docs: Make some room in sidebar ordering * docs(install): Add kubernetes deployment documentation --- docs/docs/install/all-in-one.md | 2 +- docs/docs/install/docker-compose.md | 2 +- docs/docs/install/kubernetes.md | 24 ++++++++++++++++++++++++ docs/docs/install/portainer.md | 2 +- docs/docs/install/requirements.md | 2 +- docs/docs/install/script.md | 2 +- docs/docs/install/unraid.md | 2 +- 7 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 docs/docs/install/kubernetes.md diff --git a/docs/docs/install/all-in-one.md b/docs/docs/install/all-in-one.md index c459a8beeb..4d37952179 100644 --- a/docs/docs/install/all-in-one.md +++ b/docs/docs/install/all-in-one.md @@ -1,5 +1,5 @@ --- -sidebar_position: 99 +sidebar_position: 70 --- # All-In-One [Community] diff --git a/docs/docs/install/docker-compose.md b/docs/docs/install/docker-compose.md index c7985e742a..a062233069 100644 --- a/docs/docs/install/docker-compose.md +++ b/docs/docs/install/docker-compose.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 30 --- # Docker Compose [Recommended] diff --git a/docs/docs/install/kubernetes.md b/docs/docs/install/kubernetes.md new file mode 100644 index 0000000000..92c99d282d --- /dev/null +++ b/docs/docs/install/kubernetes.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 40 +--- + +# Kubernetes + +You can deploy Immich on Kubernetes using [the official Helm chart](https://github.com/immich-app/immich-charts/tree/main/charts/apps/immich). + +If you want examples of how other people run Immich on Kubernetes, using the official chart or otherwise, you can find them at https://nanne.dev/k8s-at-home-search/#/immich. + +:::caution DNS in Alpine containers +Immich makes use of Alpine container images. These can encounter [a DNS resolution bug](https://stackoverflow.com/a/65593511) on Kubernetes clusters if the host +nodes have a search domain set, like: + +``` +$ cat /etc/resolv.conf +search home.lan +nameserver 192.168.1.1 +``` + +When you encounter this bug, it will cause the immich-microservices to crash on startup because it cannot download +the geocoder data. This can be solved in one of two ways: Either reconfigure your nodes to remove the searchdomain from +`resolv.conf`, or set the `DISABLE_REVERSE_GEOCODING` environment variable for Immich to `true` to disable the geocoder. +::: \ No newline at end of file diff --git a/docs/docs/install/portainer.md b/docs/docs/install/portainer.md index 7a33421fa8..de3767e780 100644 --- a/docs/docs/install/portainer.md +++ b/docs/docs/install/portainer.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 50 --- # Portainer diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index 89a828c88a..fded1cb7b1 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 10 --- diff --git a/docs/docs/install/script.md b/docs/docs/install/script.md index cf1fef4713..b4ced91305 100644 --- a/docs/docs/install/script.md +++ b/docs/docs/install/script.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 20 --- # Install Script [Experimental] diff --git a/docs/docs/install/unraid.md b/docs/docs/install/unraid.md index ebe739209f..235a47b4de 100644 --- a/docs/docs/install/unraid.md +++ b/docs/docs/install/unraid.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 60 --- # Unraid