From 03f33e674c1b4d60f571ab5db5f9ad226bfc8b1d Mon Sep 17 00:00:00 2001 From: Amandine Dupays Date: Wed, 27 Nov 2024 10:33:42 +0100 Subject: [PATCH] docs(getting-started): fix helm command --- docs/getting-started.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 83442c2e..dfd4d4bc 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -3,8 +3,8 @@ ## Pre-requisites - A kubernetes cluster -- [Optionnal for testing, necessary for production use] A storage bucket in a cloud provider (AWS, GCP, Azure) -- [Optionnal, recommended for production use] cert-manager installed in your cluster (for internal encryption of plans and logs & provider cache) +- [Optional for testing, necessary for production use] A storage bucket in a cloud provider (AWS, GCP, Azure) +- [Optional, recommended for production use] cert-manager installed in your cluster (for internal encryption of plans and logs & provider cache) ## Requirements @@ -17,13 +17,26 @@ Copy and modify the [default values](https://github.com/padok-team/burrito/blob/ Make sure to configure a tenant by updating the `tenant` field in the `values.yaml` file. The associated namespace will be created automatically and used to deploy Burrito resources on step 3. +For example, here is a default `values.yaml` file: +```yaml +config: + datastore: + storage: + mock: true + +tenants: + - namespace: + create: true + name: "burrito-project-1" +``` + !!! info - To try Burrito without setting up a local storage, set the `config.burrito.datastore.storage.mock` field to `true` in the `values.yaml` file. To persist data such as terraform logs, you must configure a storage bucket field. Make sure to specify a service account that has the necessary permissions to read/write to your remote bucket. + To try Burrito without setting up a remote storage, set the `config.burrito.datastore.storage.mock` field to `true` in the `values.yaml` file. To persist data such as terraform logs, you must configure a storage bucket field. Make sure to specify a service account that has the necessary permissions to read/write to your remote bucket. Then, install Burrito using the following command: ```bash -helm install burrito oci://ghcr.io/padok-team/charts/burrito -n burrito-system -f ./values.yaml +helm install burrito oci://ghcr.io/padok-team/charts/burrito --create-namespace -n burrito-system -f ./values.yaml ``` This will create a new namespace, `burrito-system`, where burrito services will be deployed.