Skip to content

Commit 5dc3a48

Browse files
committed
docs: update README.md
1 parent fb61d67 commit 5dc3a48

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Welcome to the official ClickStack Helm charts repository. ClickStack brings tog
3737

3838
```sh
3939
# Add the ClickStack Helm repository
40-
helm repo add hyperdx https://hyperdxio.github.io/helm-charts
40+
helm repo add clickstack https://hyperdxio.github.io/helm-charts
4141
helm repo update
4242

4343
# Install with default values (includes ClickHouse, OTEL collector, MongoDB, HyperDX)
44-
helm install my-clickstack hyperdx/clickstack
44+
helm install my-clickstack clickstack/clickstack
4545

4646
# Get the external IP (for cloud deployments)
4747
kubectl get services
@@ -64,7 +64,7 @@ By default, this Helm chart deploys the complete ClickStack including:
6464
To install the full stack with default values:
6565

6666
```sh
67-
helm install my-clickstack hyperdx/clickstack
67+
helm install my-clickstack clickstack/clickstack
6868
```
6969

7070
### External ClickHouse
@@ -255,19 +255,19 @@ hyperdx:
255255
Then upgrade your deployment:
256256
257257
```sh
258-
helm upgrade my-hyperdx hyperdx/clickstack -f values.yaml
258+
helm upgrade my-clickstack clickstack/clickstack -f values.yaml
259259
```
260260

261261
#### Method 2: Update via Helm upgrade with --set flag
262262

263263
```sh
264-
helm upgrade my-hyperdx hyperdx/clickstack --set hyperdx.apiKey="your-api-key-here"
264+
helm upgrade my-clickstack clickstack/clickstack --set hyperdx.apiKey="your-api-key-here"
265265
```
266266

267267
**Important:** After updating the API key, you need to restart the pods to pick up the new configuration:
268268

269269
```sh
270-
kubectl rollout restart deployment my-hyperdx-clickstack-app my-hyperdx-clickstack-otel-collector
270+
kubectl rollout restart deployment my-clickstack-clickstack-app my-clickstack-clickstack-otel-collector
271271
```
272272

273273
**Note:** The chart automatically creates a Kubernetes secret (`<release-name>-app-secrets`) with your API key. No additional secret configuration is needed unless you want to use an external secret.
@@ -506,21 +506,21 @@ hyperdx:
506506
To upgrade to a newer version:
507507

508508
```sh
509-
helm upgrade my-hyperdx hyperdx/clickstack -f values.yaml
509+
helm upgrade my-clickstack clickstack/clickstack -f values.yaml
510510
```
511511

512512
To check available chart versions:
513513

514514
```sh
515-
helm search repo hyperdx
515+
helm search repo clickstack
516516
```
517517

518-
### Uninstalling HyperDX
518+
### Uninstalling ClickStack
519519

520520
To remove the deployment:
521521

522522
```sh
523-
helm uninstall my-hyperdx
523+
helm uninstall my-clickstack
524524
```
525525

526526
This will remove all resources associated with the release, but persistent data (if any) may remain.
@@ -543,9 +543,9 @@ GKE's LoadBalancer service can cause internal DNS resolution issues where pod-to
543543
Use the fully qualified domain name (FQDN) for the OpAMP server URL:
544544

545545
```bash
546-
helm install my-hyperdx hyperdx/clickstack \
546+
helm install my-clickstack clickstack/clickstack \
547547
--set hyperdx.frontendUrl="http://your-external-ip-or-domain.com" \
548-
--set otel.opampServerUrl="http://my-hyperdx-clickstack-app.default.svc.cluster.local:4320"
548+
--set otel.opampServerUrl="http://my-clickstack-clickstack-app.default.svc.cluster.local:4320"
549549
```
550550

551551
#### Other GKE Considerations
@@ -556,7 +556,7 @@ hyperdx:
556556
frontendUrl: "http://34.123.61.99" # Use your LoadBalancer external IP
557557
558558
otel:
559-
opampServerUrl: "http://my-hyperdx-clickstack-app.default.svc.cluster.local:4320"
559+
opampServerUrl: "http://my-clickstack-clickstack-app.default.svc.cluster.local:4320"
560560
561561
# Adjust for GKE pod networking if needed
562562
clickhouse:

0 commit comments

Comments
 (0)