Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update the archivista helm docs #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update the archivista helm docs #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 22 additions & 31 deletions charts/archivista/README.md
View file
Open in desktop
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
```

Loading