From 5ea78f081795e43207337091035e59ab354872ad Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Tue, 24 Sep 2024 14:16:07 +0000 Subject: [PATCH] Update readme --- chart/README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/chart/README.md b/chart/README.md index 11c56b73..9ae5ac21 100644 --- a/chart/README.md +++ b/chart/README.md @@ -3,7 +3,19 @@ # Recomendations This helm chart includes subcharts for Meilisearch, Postgres, and RabbitMQ. Those resources should be managed outside of this Helm release. -# Example Deployment +## Postgres +Kyoo consists of multiple microservices. Best practice is for each microservice to use its own database. Kyoo workloads support best practices or sharing a single postgres database. Please see the `POSTGRES_SCHEMA` setting for additional information. + +Strongly recomended to use a Kubernetes operator for managing Postgres. + +## Storage +Kyoo currently uses storage volumes for media, backend-storage, and transcoder-storage. Media content tends to consume a large amount of space and Kubernetes storage interfaces tend to replicate across nodes. Consider hosting the data outside of Kubernetes or assigning one node to handle storage. + +Storage for backend and transcoder will eventually be moved into a datastore application. + +# Quickstart +Below provides an example for deploying Kyoo and its dependencies. This is a minimalist setup that is not intended for longterm use. This approach uses a single Postgres instance and initializes mutliple databases. + ```sh helm upgrade kyoo . --install --values myvalues.yaml ```