diff --git a/functions/kubernetes/README.md b/functions/kubernetes/README.md index c2d2c3d1..7864eb38 100644 --- a/functions/kubernetes/README.md +++ b/functions/kubernetes/README.md @@ -10,3 +10,35 @@ More details in the [kubernetes/Charts/Shuffle folder.](https://github.com/Shuff Here is the default architecture it follows, with the "Frontend" being the exposed container you interact with. image + +## MiniKube +We don't support minikube yet. Please use GKE or another cloud based k8s engine to test out Shuffle. + +## GKE testing + +For testing on GKE, you can use the following command: + +```bash +PROJECT_NAME="project" +CLUSTER_NAME="cluster" + +# feel free to change the region and machine type +gcloud container clusters create "$CLUSTER_NAME" \ + --project "$PROJECT_NAME" \ + --region "asia-south2" \ + --release-channel "regular" \ + --machine-type "e2-standard-2" \ + --num-nodes "1" \ + --node-locations "asia-south2-b,asia-south2-a,asia-south2-c" + +kubectl config set-context $CLUSTER_NAME + +# apply shuffle k8s helm chart +helm install shuffle oci://ghcr.io/shuffle/charts/shuffle \ + --version 2.1.1 \ + --namespace shuffle \ + --create-namespace + +# 3. Verify +kubectl get pods -n shuffle +```