Skip to content

Commit

Permalink
docs: update the archivista helm docs
Browse files Browse the repository at this point in the history
- use reference to the in-toto repository
- remove the values and use dynamic values from the repository

Signed-off-by: Kairo Araujo <[email protected]>
  • Loading branch information
Kairo Araujo authored and kairoaraujo committed Feb 4, 2025
1 parent 7cb8fe9 commit b58447a
Showing 1 changed file with 22 additions and 31 deletions.
53 changes: 22 additions & 31 deletions charts/archivista/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
```

0 comments on commit b58447a

Please sign in to comment.