From 56398ed3c46430e8c7939e8bbe6ec5b076d312f1 Mon Sep 17 00:00:00 2001 From: Max Goltzsche Date: Thu, 11 Apr 2024 03:05:20 +0200 Subject: [PATCH] docs: update OCI chart repo usage documentation --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb96381..2c8b27a 100644 --- a/README.md +++ b/README.md @@ -255,10 +255,12 @@ Unlike Helm khelm allows usage of any repository when `repositories.yaml` is not ### Loading a chart from an OCI registry Using Helm, you can store a Helm chart as OCI image within a container registry. -To load a chart from an OCI registry using khelm you can leave the `repository` field empty and specify the container registry/image name within the `chart` field, prefixed with `oci://`. +To load a chart from an OCI registry using khelm, you can specify the OCI registry within the `repository` field, prefixed with `oci://`. +The complete OCI image name is constructed from the `repository` and the `chart` field values, separated by `/`. +For an example, see [here](./example/oci-image/generator.yaml) and [here](./example/oci-dependency/Chart.yaml). + When using a chart from an OCI registry, Helm's `repository.yaml` configuration is not used. Instead, Docker's `config.json` is used to read private registry credentials from, if any. -This behaviour is aligned with Helm. ## Helm support