From 4a9ab3bf0b0fa5388c4cc14d979d22f30d28ae86 Mon Sep 17 00:00:00 2001 From: Ilya Nikokoshev Date: Fri, 5 Jan 2024 15:19:11 +0100 Subject: [PATCH] fix: doc improvements --- langfuse/README.md | 38 ++++++++++++++++++++++++++++++++++---- langfuse/values.yaml | 2 +- 2 files changed, 35 insertions(+), 5 deletions(-) diff --git a/langfuse/README.md b/langfuse/README.md index 908c41e..283441e 100644 --- a/langfuse/README.md +++ b/langfuse/README.md @@ -12,13 +12,16 @@ helm install langfuse-demo https://github.com/ilyannn/charts/releases/download/l ### Default Installation -With the default values, Langfuse will be installed with the bundled Postgres. -The password will be generated and saved in a secret (in this case, `langfuse-demo-postgres-secret`) +By default, Langfuse will be installed with the bundled Postgres. +The password will be generated and saved in a `Secret` (in this case, `langfuse-demo-postgres-secret`). -### Connecting existing Postgres instance -You can pass the exising connection URL. +### OAuth + +### Using Existing Database Connection + +Disable the bundled database and pass an exising connection URL instead. ```yaml databaseURL: "postgresql://some-existing-url" @@ -26,3 +29,30 @@ databaseURL: "postgresql://some-existing-url" postgresql: enabled: false ``` + + +### Accessing the installation + +The chart comes with an ingress that can be set up with + +```yaml +ingress: + enabled: true + hosts: ... +``` + + +### Uninstalling + + +The usual `helm uninstall RELEASE_NAME` should work, but note that the following objects are not deleted automatically: + +- the data PVC of the `postgres` subchart (if the subchart was enabled) +- the `-postgres-secret` secret (unless `postgresql.secret.alwaysKeepWhenUninstalled` is unset) + +This means that you can reinstall the chart and continue accessing the same data. + + +### Example values + +See [megaver.se demo](https://docs.cluster.megaver.se/cluster/langfuse-demo-values.yaml) diff --git a/langfuse/values.yaml b/langfuse/values.yaml index 5bcd6f3..c5be7f6 100644 --- a/langfuse/values.yaml +++ b/langfuse/values.yaml @@ -39,7 +39,7 @@ postgresql: # Set this to false if you want the secret to be deleted with `helm delete` # This has no effect unless createIfMissing is also true. # Warning: reinstalling the chart will generate a new password, but Postgres will - # continue to use an old password since it's stored on the the PVC. + # continue to use an old password since it's stored on the PVC. alwaysKeepWhenUninstalled: true