From 01a0ce3ced38f8db92ad3a836ea5834afb0bd12b Mon Sep 17 00:00:00 2001 From: Sajjad Anwar Date: Wed, 5 Mar 2025 07:56:04 +0530 Subject: [PATCH] helm setup docs --- deployment/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/deployment/README.md b/deployment/README.md index 02a12d9fc..d3cbdf4d9 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -80,3 +80,13 @@ prod cluster** - `kubectl delete -f .` - To not delete the persistent volumes (Document indexes and Users), specify the specific `.yaml` files instead of `.` without specifying delete on persistent-volumes.yaml. + +### Using Helm to deploy to an existing cluster + +Onyx has a helm chart that is convenient to install all services to an existing Kubernetes cluster. To install: + +* Currently the helm chart is not published so to install, clone the repo. +* Configure access to the cluster via kubectl. Ensure the kubectl context is set to the cluster that you want to use +* The default secrets, environment variables and other service level configuration are stored in `deployment/helm/charts/onyx/values.yml`. You may create another `override.yml` +* `cd deployment/helm/charts/onyx` and run `helm install onyx -n onyx -f override.yaml .`. This will install onyx on the cluster under the `onyx` namespace. +* Check the status of the deploy using `kubectl get pods -n onyx` \ No newline at end of file