From d6468f7981a7a0cb41be857e7c03b27be44df273 Mon Sep 17 00:00:00 2001 From: Kairo Araujo Date: Mon, 9 Dec 2024 09:10:23 +0100 Subject: [PATCH] docs: update the archivista helm docs - use reference to the in-toto repository - remove the values and use dynamic values from the repository Signed-off-by: Kairo Araujo --- charts/archivista/README.md | 53 +++++++++++++++---------------------- 1 file changed, 22 insertions(+), 31 deletions(-) diff --git a/charts/archivista/README.md b/charts/archivista/README.md index d2ebdb4..8dd1bd3 100644 --- a/charts/archivista/README.md +++ b/charts/archivista/README.md @@ -12,13 +12,28 @@ to establish connections to each datastore. These environment variables can be a ## Quick Installation +Archivista helm charts are hosted by in-toto helm repository. +To add the repository run following command. + +```shell +helm repo add in-toto https://in-toto.io/helm-charts +``` +If you have already added the repository, run following command to update the +repository. + +```shell +helm repo update +``` + To install the helm chart with default values run following command. The [Values](#Values) section describes the configuration options for this chart. ```shell -helm install archivista . +helm install archivista in-toto/archivista ``` + + ## Uninstallation To uninstall the Helm chart run following command. @@ -40,33 +55,9 @@ helm uninstall archivista ## Values -| Key | Type | Default | -|--- |--- |--- | -| affinity | object | `{}` | -| autoscaling.enabled | bool | `false` | -| autoscaling.maxReplicas | int | `10` | -| autoscaling.minReplicas | int | `1` | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | -| deployment.env | list | `[]` | -| fullnameOverride | string | `""` | -| image.pullPolicy | string | `"IfNotPresent"` | -| image.repository | string | `"ghcr.io/testifysec/archivista"` | -| image.tag | string | `"0.1.1"` | -| ingress.annotations | object | `{}` | -| ingress.className | string | `""` | -| ingress.enabled | bool | `true` | -| ingress.hosts[0].host | string | `"archivista.localhost"` | -| ingress.hosts[0].path | string | `"/"` | -| ingress.tls | list | `[]` | -| nameOverride | string | `""` | -| nodeSelector | object | `{}` | -| podAnnotations | object | `{}` | -| podSecurityContext | object | `{}` | -| replicaCount | int | `1` | -| resources | object | `{}` | -| serviceAccount.annotations | object | `{}` | -| serviceAccount.create | bool | `false` | -| serviceAccount.name | string | `""` | -| service.port | int | `8082` | -| service.type | string | `"ClusterIP"` | -| tolerations | list | `[]` | +Run: + +```shell +helm show values in-toto/archivista +``` +