From 2a84dadb7da4169a81d1ef9a6bcb74add966fa84 Mon Sep 17 00:00:00 2001 From: Lennart Elsen Date: Tue, 16 Jun 2026 21:57:07 +0200 Subject: [PATCH] [doc] goquery-ui: document GHCR install, steer off docker pull MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit GHCR's package page suggests `docker pull` for the chart, which is wrong — it's a Helm OCI artifact. Add an Install-from-GHCR section using helm with --version, a subchart-dependency snippet, and a note to ignore the docker pull hint. Bump chart to 0.1.1 since the README ships in the package. Co-Authored-By: Claude Opus 4.8 (1M context) --- charts/goquery-ui/Chart.yaml | 2 +- charts/goquery-ui/README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/charts/goquery-ui/Chart.yaml b/charts/goquery-ui/Chart.yaml index a0bdcb57..b16763df 100644 --- a/charts/goquery-ui/Chart.yaml +++ b/charts/goquery-ui/Chart.yaml @@ -9,7 +9,7 @@ description: | type: application # Chart's own semver — bump on chart changes. -version: 0.1.0 +version: 0.1.1 # Version of the goprobe/frontend image this chart was validated against. # image.tag defaults to this value. diff --git a/charts/goquery-ui/README.md b/charts/goquery-ui/README.md index ef99e37d..eb9916c7 100644 --- a/charts/goquery-ui/README.md +++ b/charts/goquery-ui/README.md @@ -28,6 +28,26 @@ backend already runs as a Service you can reach in-cluster. `backend.url` is **required** — there is no safe default. The chart fails to render without it. +The chart is published to GHCR as an OCI artifact at +`oci://ghcr.io/els0r/charts/goquery-ui`. The package is public, so no +`helm registry login` is needed to pull. + +> **Note:** GHCR's package page shows a `docker pull …` snippet — ignore it. +> This is a Helm chart, not a container image; use `helm`, and pass the +> version with `--version` rather than as a `:tag`. + +```bash +helm install goquery-ui oci://ghcr.io/els0r/charts/goquery-ui \ + --version 0.1.1 \ + --namespace network-observability --create-namespace \ + --set backend.url=http://global-query.network-observability.svc.cluster.local:8145 +``` + +Inspect before installing with `helm show chart oci://ghcr.io/els0r/charts/goquery-ui --version 0.1.1`. + +To install from a local checkout instead (e.g. while developing the chart), +point at the source directory: + ```bash helm install goquery-ui ./charts/goquery-ui \ --namespace network-observability --create-namespace \ @@ -41,6 +61,20 @@ kubectl -n network-observability port-forward svc/goquery-ui 8080:80 # open http://localhost:8080 ``` +### Use as a subchart dependency + +Declare it in your own chart's `Chart.yaml` — the `repository` is the parent +OCI path, with the chart name and version as separate fields: + +```yaml +dependencies: + - name: goquery-ui + version: 0.1.1 + repository: oci://ghcr.io/els0r/charts +``` + +then run `helm dependency update`. + ## Key values | Key | Default | Description |