diff --git a/nextcloud-aio-helm-chart/readme.md b/nextcloud-aio-helm-chart/readme.md index 959588ac..60e448a3 100755 --- a/nextcloud-aio-helm-chart/readme.md +++ b/nextcloud-aio-helm-chart/readme.md @@ -1,6 +1,19 @@ -# You can also install the AIO containers on Kubernetes using this Helm Chart +# Nextcloud AIO Helm-chart -This is currently beta and not ready yet. +You can run the containers that are build for AIO with Kubernetes using this Helm chart. This comes with a few downsides, that are discussed below. + +### Advantages +- You can run it without a container having access to the docker socket +- You can run the containers with Kubernetes + +### Disadvantages +- You lose the AIO interface +- You lose update notifications and automatic updates +- You lose all AIO backup and restore features +- You need to know what you are doing +- For updating, you need to strictly follow the at the bottom described update routine +- You need to monitor yourself if the volumes have enough free space and increase them if they don't by adjusting their size in values.yaml +- Probably more ## How to use this? @@ -12,3 +25,13 @@ Then run: helm repo add nextcloud-aio https://nextcloud.github.io/all-in-one/ helm install my-release nextcloud-aio/nextcloud-aio-helm-chart -f values.yaml ``` + +And after a while, everything should be set up. + +## How to update? +Since the values of this helm chart may change in the future, it is highly recommended to strictly follow the following procedure whenever you want to upgrade it. +1. Stop all running pods +1. Back up all volumes that got created by the Helm chart and the values.yaml file +1. Run `helm repo update nextcloud-aio` in order to get the updated yaml files from the repository +1. Now download the updated values.yaml file from https://raw.githubusercontent.com/nextcloud/all-in-one/main/nextcloud-aio-helm-chart/values.yaml and compare that with the one that you currently have locally. Look for variables that changed or got added. You can use the diff command to compare them. +1. After the file update was successful, simply run `helm install my-release nextcloud-aio/nextcloud-aio-helm-chart -f values.yaml` to update to the new version. diff --git a/readme.md b/readme.md index dd6f86e7..f1da637c 100644 --- a/readme.md +++ b/readme.md @@ -577,6 +577,9 @@ If you get an error during the domain validation which states that your ip-addre ### Can I run this with Docker swarm? Yes. For that to work, you need to use and follow the [manual-install documentation](./manual-install/). +### Can I run this with Kubernetes? +Yes. For that to work, you need to use and follow the [helm-chart documentation](./nextcloud-aio-helm-chart/). + ### How to run this with Docker rootless? You can run AIO also with docker rootless. How to do this is documented here: [docker-rootless.md](https://github.com/nextcloud/all-in-one/blob/main/docker-rootless.md)