Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/ghcr-install-docs.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions charts/clickstack-operators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions charts/clickstack-operators/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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" . }}
Expand Down
6 changes: 6 additions & 0 deletions charts/clickstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions charts/clickstack/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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" . }}
Expand Down
2 changes: 2 additions & 0 deletions docs/UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<chart>` with `oci://ghcr.io/clickhouse/charts/<chart>`. See the [Quick Start](../README.md#quick-start).

Uninstall in reverse order:

```bash
Expand Down
2 changes: 2 additions & 0 deletions examples/alb-ingress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<chart>` with `oci://ghcr.io/clickhouse/charts/<chart>`. See the [Quick Start](../../README.md#quick-start).

```bash
# Install operators first (if not already installed)
helm install clickstack-operators clickstack/clickstack-operators
Expand Down
2 changes: 2 additions & 0 deletions examples/api-only/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<chart>` with `oci://ghcr.io/clickhouse/charts/<chart>`. See the [Quick Start](../../README.md#quick-start).

```bash
helm install my-api clickstack/clickstack \
-f examples/api-only/values.yaml
Expand Down
2 changes: 2 additions & 0 deletions examples/otel-custom-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<chart>` with `oci://ghcr.io/clickhouse/charts/<chart>`. See the [Quick Start](../../README.md#quick-start).

```bash
helm install my-clickstack clickstack/clickstack -f values.yaml
```
Expand Down
Loading