diff --git a/functions/kubernetes/README.md b/functions/kubernetes/README.md index a98ef015..c2d2c3d1 100644 --- a/functions/kubernetes/README.md +++ b/functions/kubernetes/README.md @@ -1,7 +1,12 @@ -## How to deploy Shuffle on Kubernetes? +# Shuffle in Kubernetes 1. Make sure you have a Kubernetes cluster available. MiniKube works for testing. 2. Install `helm install shuffle oci://ghcr.io/shuffle/charts/shuffle --namespace shuffle --create-namespace` 3. Tweak the configuration files if needed! This is not meant to be a one-size-fits-all More details in the [kubernetes/Charts/Shuffle folder.](https://github.com/Shuffle/Shuffle/tree/main/functions/kubernetes/charts/shuffle#usage) + +## Architecture +Here is the default architecture it follows, with the "Frontend" being the exposed container you interact with. + +image