Skip to content

docs: explain how to fetch values files when installing from OCI #2

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

Merged
cadolbeau-absyss merged 1 commit into from
May 26, 2026
Merged

docs: explain how to fetch values files when installing from OCI #2

Show file tree
Hide file tree
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
20 changes: 17 additions & 3 deletions README-fr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,16 +162,30 @@ Transferts de fichiers managés : serveur SFTP entrant + connecteurs sortants ve

Le chart est publié en tant qu'artefact OCI sur GitHub Container Registry. Aucune authentification requise.

**Étape 1 — Récupérer le chart en local** :
```bash
helm install visual-tom oci://ghcr.io/absysslab/visual-tom \
--version 0.1.0 \
-f values-azure.yaml \
helm pull oci://ghcr.io/absysslab/visual-tom --version 0.1.0 --untar
```
Cette commande télécharge le chart et le dépaquette dans un dossier `visual-tom/` contenant `Chart.yaml`, `values.yaml`, tous les `values-<cloud>.yaml`, le `values-client-template.yaml` et les `templates/`.

**Étape 2 — Préparer votre fichier de valeurs client** :
```bash
cp visual-tom/values-client-template.yaml values-monentreprise.yaml
# Éditer values-monentreprise.yaml et remplir les lignes marquées « # TODO »
```

**Étape 3 — Installer** :
```bash
helm install visual-tom ./visual-tom \
-f visual-tom/values-azure.yaml \
-f values-monentreprise.yaml \
--namespace vtom --create-namespace
```

Remplacer `values-azure.yaml` par `values-aws.yaml`, `values-gcp.yaml` ou `values-onpremise.yaml` selon votre cible.

> **Mises à jour** : pour passer à une version ultérieure (ex. 0.1.1), relancer l'étape 1 avec `--version 0.1.1`, vérifier les changements éventuels dans les `values-<cloud>.yaml`, puis `helm upgrade visual-tom ./visual-tom -f ... -f values-monentreprise.yaml --namespace vtom`.

## Depuis les sources

```bash
Expand Down
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,16 +162,30 @@ Managed file transfers: inbound SFTP server + outbound connectors to external ba

The chart is published as an OCI artifact on GitHub Container Registry. No authentication required.

**Step 1 — Pull the chart locally**:
```bash
helm install visual-tom oci://ghcr.io/absysslab/visual-tom \
--version 0.1.0 \
-f values-azure.yaml \
helm pull oci://ghcr.io/absysslab/visual-tom --version 0.1.0 --untar
```
This downloads the chart and extracts it into a `visual-tom/` directory containing `Chart.yaml`, `values.yaml`, all `values-<cloud>.yaml`, the `values-client-template.yaml` and the `templates/`.

**Step 2 — Prepare your client values file**:
```bash
cp visual-tom/values-client-template.yaml values-mycompany.yaml
# Edit values-mycompany.yaml and fill in the lines marked "# TODO"
```

**Step 3 — Install**:
```bash
helm install visual-tom ./visual-tom \
-f visual-tom/values-azure.yaml \
-f values-mycompany.yaml \
--namespace vtom --create-namespace
```

Replace `values-azure.yaml` with `values-aws.yaml`, `values-gcp.yaml` or `values-onpremise.yaml` according to your target.

> **Upgrades**: to move to a later version (e.g. 0.1.1), re-run step 1 with `--version 0.1.1`, review any changes in the `values-<cloud>.yaml`, then `helm upgrade visual-tom ./visual-tom -f ... -f values-mycompany.yaml --namespace vtom`.

## From sources

```bash
Expand Down