diff --git a/.changeset/ghcr-install-docs.md b/.changeset/ghcr-install-docs.md new file mode 100644 index 00000000..324c22cf --- /dev/null +++ b/.changeset/ghcr-install-docs.md @@ -0,0 +1,5 @@ +--- +"helm-charts": patch +--- + +docs: the READMEs now show how to install both charts from GHCR (`oci://ghcr.io/clickhouse/charts`) as well as from the Helm repo. diff --git a/README.md b/README.md index 85649d37..0f2ee84d 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,13 @@ helm install clickstack-operators clickstack/clickstack-operators helm install my-clickstack clickstack/clickstack ``` +Both charts are also published to GHCR as OCI artifacts, which needs no `helm repo add`: + +```bash +helm install clickstack-operators oci://ghcr.io/clickhouse/charts/clickstack-operators +helm install my-clickstack oci://ghcr.io/clickhouse/charts/clickstack +``` + For configuration, cloud deployment, ingress setup, and troubleshooting, see the [official documentation](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/helm). ## Charts diff --git a/charts/clickstack-operators/README.md b/charts/clickstack-operators/README.md index 752cb7f1..16584bae 100644 --- a/charts/clickstack-operators/README.md +++ b/charts/clickstack-operators/README.md @@ -15,6 +15,12 @@ helm repo update helm install clickstack-operators clickstack/clickstack-operators ``` +Or install from GHCR as an OCI artifact, with no `helm repo add`: + +```bash +helm install clickstack-operators oci://ghcr.io/clickhouse/charts/clickstack-operators +``` + After the operators are ready, install the [clickstack](../clickstack) chart. ## Requirements diff --git a/charts/clickstack-operators/README.md.gotmpl b/charts/clickstack-operators/README.md.gotmpl index c1138a0f..1fea1ad6 100644 --- a/charts/clickstack-operators/README.md.gotmpl +++ b/charts/clickstack-operators/README.md.gotmpl @@ -15,6 +15,12 @@ helm repo update helm install clickstack-operators clickstack/clickstack-operators ``` +Or install from GHCR as an OCI artifact, with no `helm repo add`: + +```bash +helm install clickstack-operators oci://ghcr.io/clickhouse/charts/clickstack-operators +``` + After the operators are ready, install the [clickstack](../clickstack) chart. {{ template "chart.requirementsSection" . }} diff --git a/charts/clickstack/README.md b/charts/clickstack/README.md index 619989cd..1f63ddab 100644 --- a/charts/clickstack/README.md +++ b/charts/clickstack/README.md @@ -24,6 +24,12 @@ helm repo update helm install my-clickstack clickstack/clickstack ``` +Or install from GHCR as an OCI artifact, with no `helm repo add`: + +```bash +helm install my-clickstack oci://ghcr.io/clickhouse/charts/clickstack +``` + See the [ClickStack Helm documentation](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/helm) for cloud-specific guides, ingress setup, and troubleshooting. ## Requirements diff --git a/charts/clickstack/README.md.gotmpl b/charts/clickstack/README.md.gotmpl index 2878dd91..f919f106 100644 --- a/charts/clickstack/README.md.gotmpl +++ b/charts/clickstack/README.md.gotmpl @@ -21,6 +21,12 @@ helm repo update helm install my-clickstack clickstack/clickstack ``` +Or install from GHCR as an OCI artifact, with no `helm repo add`: + +```bash +helm install my-clickstack oci://ghcr.io/clickhouse/charts/clickstack +``` + See the [ClickStack Helm documentation](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/helm) for cloud-specific guides, ingress setup, and troubleshooting. {{ template "chart.requirementsSection" . }} diff --git a/docs/UPGRADE.md b/docs/UPGRADE.md index 58aefd55..3432aed6 100644 --- a/docs/UPGRADE.md +++ b/docs/UPGRADE.md @@ -54,6 +54,8 @@ helm install clickstack-operators clickstack/clickstack-operators helm install my-clickstack clickstack/clickstack ``` +These commands use the `clickstack` Helm repo. To install from GHCR instead, replace `clickstack/` with `oci://ghcr.io/clickhouse/charts/`. See the [Quick Start](../README.md#quick-start). + Uninstall in reverse order: ```bash diff --git a/examples/alb-ingress/README.md b/examples/alb-ingress/README.md index 68f3c32c..05354c43 100644 --- a/examples/alb-ingress/README.md +++ b/examples/alb-ingress/README.md @@ -20,6 +20,8 @@ The primary ingress uses the chart's passthrough pattern: `annotations` and `spe ## Usage +These commands use the `clickstack` Helm repo. To install from GHCR instead, replace `clickstack/` with `oci://ghcr.io/clickhouse/charts/`. See the [Quick Start](../../README.md#quick-start). + ```bash # Install operators first (if not already installed) helm install clickstack-operators clickstack/clickstack-operators diff --git a/examples/api-only/README.md b/examples/api-only/README.md index a355d90f..6e1761bd 100644 --- a/examples/api-only/README.md +++ b/examples/api-only/README.md @@ -32,6 +32,8 @@ The chart will fail to render if `secrets: null` is used while any subchart (Mon ## Usage +These commands use the `clickstack` Helm repo. To install from GHCR instead, replace `clickstack/` with `oci://ghcr.io/clickhouse/charts/`. See the [Quick Start](../../README.md#quick-start). + ```bash helm install my-api clickstack/clickstack \ -f examples/api-only/values.yaml diff --git a/examples/otel-custom-config/README.md b/examples/otel-custom-config/README.md index f91b200a..0ec9196b 100644 --- a/examples/otel-custom-config/README.md +++ b/examples/otel-custom-config/README.md @@ -33,6 +33,8 @@ The custom config is merged **leaf-by-leaf** on top of the collector's built-in ## Usage +These commands use the `clickstack` Helm repo. To install from GHCR instead, replace `clickstack/` with `oci://ghcr.io/clickhouse/charts/`. See the [Quick Start](../../README.md#quick-start). + ```bash helm install my-clickstack clickstack/clickstack -f values.yaml ```