diff options
| author | chemicstry <chemicstry@gmail.com> | 2022-06-20 17:11:09 +0300 |
|---|---|---|
| committer | Maximilien R <maximilien@deuxfleurs.fr> | 2022-09-30 18:46:57 +0200 |
| commit | 37a73d7d3782ec8a5cd8b0e71a00722f90321ced (patch) | |
| tree | abb348d2ffb96112a6ea3bca14f9e823fbe46bdd /script/helm/README.md | |
| parent | d0f08c254e3cc996dbf3d565df9ff2c89e15c639 (diff) | |
| download | garage-37a73d7d3782ec8a5cd8b0e71a00722f90321ced.tar.gz garage-37a73d7d3782ec8a5cd8b0e71a00722f90321ced.zip | |
Move documentation to book
Diffstat (limited to 'script/helm/README.md')
| -rw-r--r-- | script/helm/README.md | 72 |
1 files changed, 1 insertions, 71 deletions
diff --git a/script/helm/README.md b/script/helm/README.md index b7a3a35b..5f919a23 100644 --- a/script/helm/README.md +++ b/script/helm/README.md @@ -1,73 +1,3 @@ # Garage helm3 chart -This chart deploys garage on a kubernetes cluster. - -## Deploying - -With default options: - -```bash -helm install --create-namespace --namespace garage garage ./garage -``` - -With custom values: - -```bash -helm install --create-namespace --namespace garage garage ./garage -f values.override.yaml -``` - -After deploying, cluster layout must be configured manually as per garage's documentation. Use the following command to access garage CLI: - -```bash -kubectl exec --stdin --tty -n garage garage-0 -- ./garage status -``` - -## Overriding default values - -All possible configuration values can be found in [values.yaml](garage/values.yaml). - -This is an example `values.overrride.yaml` for deploying in a microk8s cluster with a https s3 api ingress route: - -```yaml -garage: - # Make sure to generate a new secret for your deployment - rpcSecret: "1799bccfd7411eddcf9ebd316bc1f5287ad12a68094e1c6ac6abde7e6feae1ec" - -# Start 4 instances (StatefulSets) of garage -replicaCount: 4 - -# Override default storage class and size -persistence: - meta: - storageClass: "openebs-hostpath" - size: 100Mi - data: - storageClass: "openebs-hostpath" - size: 1Gi - -ingress: - s3: - api: - enabled: true - className: "public" - annotations: - cert-manager.io/cluster-issuer: "letsencrypt-prod" - nginx.ingress.kubernetes.io/proxy-body-size: 500m - hosts: - - host: s3-api.my-domain.com - paths: - - path: / - pathType: Prefix - tls: - - secretName: garage-ingress-cert - hosts: - - s3-api.my-domain.com -``` - -## Removing - -```bash -helm delete --namespace garage garage -``` - -Note that this will leave behind custom CRD `garagenodes.deuxfleurs.fr`, which must be removed manually if desired. +Documentation is located [here](/doc/book/cookbook/kubernetes.md). |