Skip to content

Commit 982d1c6

Browse files
committed
migration: rename chart name to 'clickstack'
1 parent f2ae348 commit 982d1c6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+197
-197
lines changed

.github/workflows/chart-test.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ jobs:
3030
if: github.event_name == 'schedule'
3131
run: |
3232
echo "Updating appVersion to 2-nightly for scheduled builds"
33-
sed -i 's/^appVersion:.*/appVersion: 2-nightly/' charts/hdx-oss-v2/Chart.yaml
33+
sed -i 's/^appVersion:.*/appVersion: 2-nightly/' charts/clickstack/Chart.yaml
3434
echo "Updated Chart.yaml:"
35-
cat charts/hdx-oss-v2/Chart.yaml
35+
cat charts/clickstack/Chart.yaml
3636
3737
- name: Create kind cluster config
3838
run: |
@@ -64,9 +64,9 @@ jobs:
6464
- name: Run Helm unit tests
6565
run: |
6666
helm plugin install https://github.com/helm-unittest/helm-unittest.git || true
67-
helm unittest charts/hdx-oss-v2
67+
helm unittest charts/clickstack
6868
69-
- name: Deploy HyperDX chart
69+
- name: Deploy ClickStack chart
7070
run: |
7171
# Create test values for faster deployment
7272
cat > test-values.yaml << EOF
@@ -100,7 +100,7 @@ jobs:
100100
EOF
101101
102102
# Install the chart
103-
helm install hyperdx-test ./charts/hdx-oss-v2 -f test-values.yaml --timeout=5m
103+
helm install hyperdx-test ./charts/clickstack -f test-values.yaml --timeout=5m
104104
105105
# Give services time to initialize after pods are running
106106
echo "Waiting for services to initialize..."
@@ -112,7 +112,7 @@ jobs:
112112
kubectl wait --for=condition=Ready pods -l app=mongodb --timeout=300s
113113
114114
echo "Creating test team in MongoDB..."
115-
kubectl exec -n default deployment/hyperdx-test-hdx-oss-v2-mongodb -- mongosh hyperdx --eval "
115+
kubectl exec -n default deployment/hyperdx-test-clickstack-mongodb -- mongosh hyperdx --eval "
116116
db.teams.insertOne({
117117
name: 'CI Test Team',
118118
apiKey: 'test-api-key-for-ci',
@@ -123,7 +123,7 @@ jobs:
123123
"
124124
125125
echo "Verifying team creation..."
126-
kubectl exec -n default deployment/hyperdx-test-hdx-oss-v2-mongodb -- mongosh hyperdx --eval "
126+
kubectl exec -n default deployment/hyperdx-test-clickstack-mongodb -- mongosh hyperdx --eval "
127127
const team = db.teams.findOne({ apiKey: 'test-api-key-for-ci' });
128128
if (team) {
129129
print('Team created successfully:', team.name);
@@ -164,7 +164,7 @@ jobs:
164164
echo "=== Events ==="
165165
kubectl get events --sort-by=.metadata.creationTimestamp
166166
167-
echo "=== HyperDX App Logs ==="
167+
echo "=== ClickStack App Logs ==="
168168
kubectl logs -l app=app --tail=100 || true
169169
170170
echo "=== ClickHouse Logs ==="

.github/workflows/helm-test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ jobs:
3333
3434
- name: Run helm-unittest
3535
run: |
36-
helm unittest charts/hdx-oss-v2
36+
helm unittest charts/clickstack

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
uses: changesets/action@v1
3939
with:
4040
commit: 'chore(release): bump version'
41-
title: 'Release HyperDX Helm Charts'
41+
title: 'Release ClickStack Helm Charts'
4242
version: yarn run version
4343
publish: yarn run release
4444
env:

.github/workflows/update-app-version.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323

2424
- name: Update appVersion in Chart.yaml
2525
run: |
26-
sed -i "s/^appVersion: .*/appVersion: ${{ github.event.inputs.tag }}/" charts/hdx-oss-v2/Chart.yaml
26+
sed -i "s/^appVersion: .*/appVersion: ${{ github.event.inputs.tag }}/" charts/clickstack/Chart.yaml
2727
2828
- name: Create changeset
2929
run: |
@@ -45,6 +45,6 @@ jobs:
4545
body: |
4646
This PR updates the appVersion in Chart.yaml to `${{ github.event.inputs.tag }}`.
4747
48-
- Updated `charts/hdx-oss-v2/Chart.yaml`
48+
- Updated `charts/clickstack/Chart.yaml`
4949
branch: update-app-version-${{ github.event.inputs.tag }}
5050
delete-branch: true

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# HyperDX V2 Helm Charts
1+
# ClickStack Helm Charts
22

3-
Welcome to the official HyperDX Helm charts repository. This guide provides instructions on how to install, configure, and manage your HyperDX V2 deployment using Helm.
3+
Welcome to the official ClickStack Helm charts repository. ClickStack brings together the best of observability: **ClickHouse + OpenTelemetry + HyperDX**. This guide provides instructions on how to install, configure, and manage your ClickStack deployment using Helm.
44

55
## Table of Contents
66

@@ -33,29 +33,29 @@ Welcome to the official HyperDX Helm charts repository. This guide provides inst
3333
- Kubernetes cluster (v1.20+ recommended)
3434
- `kubectl` configured to interact with your cluster
3535

36-
### Install HyperDX (Full Stack)
36+
### Install ClickStack (Full Stack)
3737

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

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

4646
# Get the external IP (for cloud deployments)
4747
kubectl get services
4848

4949
# Access the UI at http://<EXTERNAL-IP>:3000
5050
```
5151

52-
**That's it!** HyperDX is now running with all components included.
52+
**That's it!** ClickStack is now running with all components included.
5353

5454
## Deployment Options
5555

5656
### Full Stack (Default)
5757

58-
By default, this Helm chart deploys the complete HyperDX stack including:
58+
By default, this Helm chart deploys the complete ClickStack including:
5959
- **HyperDX Application** (API, UI, and OpAMP server)
6060
- **ClickHouse** (for storing logs, traces, and metrics)
6161
- **OTEL Collector** (for receiving and processing telemetry data)
@@ -64,7 +64,7 @@ By default, this Helm chart deploys the complete HyperDX stack including:
6464
To install the full stack with default values:
6565

6666
```sh
67-
helm install my-hyperdx hyperdx/hdx-oss-v2
67+
helm install my-clickstack hyperdx/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/hdx-oss-v2 -f values.yaml
258+
helm upgrade my-hyperdx hyperdx/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/hdx-oss-v2 --set hyperdx.apiKey="your-api-key-here"
264+
helm upgrade my-hyperdx hyperdx/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-hdx-oss-v2-app my-hyperdx-hdx-oss-v2-otel-collector
270+
kubectl rollout restart deployment my-hyperdx-clickstack-app my-hyperdx-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.
@@ -278,7 +278,7 @@ For handling sensitive data such as API keys or database credentials, use Kubern
278278

279279
### Using Pre-Configured Secrets
280280

281-
The Helm chart includes a default secret template located at [`charts/hdx-oss-v2/templates/secrets.yaml`](https://github.com/hyperdxio/helm-charts/blob/main/charts/hdx-oss-v2/templates/secrets.yaml). This file provides a base structure for managing secrets.
281+
The Helm chart includes a default secret template located at [`charts/clickstack/templates/secrets.yaml`](https://github.com/hyperdxio/helm-charts/blob/main/charts/clickstack/templates/secrets.yaml). This file provides a base structure for managing secrets.
282282

283283

284284
If you need to manually apply a secret, modify and apply the provided `secrets.yaml` template:
@@ -506,7 +506,7 @@ hyperdx:
506506
To upgrade to a newer version:
507507

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

512512
To check available chart versions:
@@ -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/hdx-oss-v2 \
546+
helm install my-hyperdx hyperdx/clickstack \
547547
--set hyperdx.frontendUrl="http://your-external-ip-or-domain.com" \
548-
--set otel.opampServerUrl="http://my-hyperdx-hdx-oss-v2-app.default.svc.cluster.local:4320"
548+
--set otel.opampServerUrl="http://my-hyperdx-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-hdx-oss-v2-app.default.svc.cluster.local:4320"
559+
opampServerUrl: "http://my-hyperdx-clickstack-app.default.svc.cluster.local:4320"
560560
561561
# Adjust for GKE pod networking if needed
562562
clickhouse:
@@ -627,5 +627,5 @@ For HTTP-only deployments (development/testing), some browsers may show crypto A
627627
### Checking Logs
628628

629629
```sh
630-
kubectl logs -l app.kubernetes.io/name=hdx-oss-v2
630+
kubectl logs -l app.kubernetes.io/name=clickstack
631631
```

charts/clickstack/Chart.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
apiVersion: v2
2+
name: clickstack
3+
description: A Helm chart for ClickStack - Full-stack observability with ClickHouse, OpenTelemetry, and HyperDX
4+
type: application
5+
version: 0.8.3
6+
appVersion: 2.7.1
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
HyperDX has been installed.
1+
ClickStack has been installed.
22

3-
Note: By default, this chart also installs clickhouse and the otel-collector. However, for production,
4-
it is recommended that you use the clickhouse and otel-collector operators instead.
3+
Note: By default, this chart installs the complete ClickStack: ClickHouse, OpenTelemetry Collector, MongoDB, and HyperDX.
4+
For production, it is recommended that you use the ClickHouse and OTEL Collector operators instead.
55

66
To disable clickhouse and otel-collector, set the following values:
77
helm install myrelease <chart-name-or-path> --set clickhouse.enabled=false --set clickhouse.persistence.enabled=false --set otel.enabled=false
@@ -20,12 +20,12 @@ Application Access:
2020
--set hyperdx.ingress.tls.enabled=true
2121

2222
2. Port Forward (Development/Testing):
23-
kubectl port-forward svc/{{ include "hdx-oss.fullname" . }}-app {{ .Values.hyperdx.appPort }}:{{ .Values.hyperdx.appPort }}
23+
kubectl port-forward svc/{{ include "clickstack.fullname" . }}-app {{ .Values.hyperdx.appPort }}:{{ .Values.hyperdx.appPort }}
2424
Then access: http://localhost:{{ .Values.hyperdx.appPort }}
2525

2626
Note: This application handles sensitive telemetry data and should not be exposed
2727
directly to the internet without proper authentication and encryption.
2828
{{- end }}
2929

3030
To verify the deployment status, run:
31-
kubectl get pods -l "app.kubernetes.io/name={{ include "hdx-oss.name" . }}"
31+
kubectl get pods -l "app.kubernetes.io/name={{ include "clickstack.name" . }}"
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{{/*
22
Expand the name of the chart.
33
*/}}
4-
{{- define "hdx-oss.name" -}}
4+
{{- define "clickstack.name" -}}
55
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
66
{{- end }}
77

88
{{/*
99
Create a default fully qualified app name.
1010
*/}}
11-
{{- define "hdx-oss.fullname" -}}
11+
{{- define "clickstack.fullname" -}}
1212
{{- if .Values.fullnameOverride }}
1313
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
1414
{{- else }}
@@ -24,16 +24,16 @@ Create a default fully qualified app name.
2424
{{/*
2525
Create chart name and version as used by the chart label.
2626
*/}}
27-
{{- define "hdx-oss.chart" -}}
27+
{{- define "clickstack.chart" -}}
2828
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
2929
{{- end }}
3030

3131
{{/*
3232
Common labels
3333
*/}}
34-
{{- define "hdx-oss.labels" -}}
35-
helm.sh/chart: {{ include "hdx-oss.chart" . }}
36-
{{ include "hdx-oss.selectorLabels" . }}
34+
{{- define "clickstack.labels" -}}
35+
helm.sh/chart: {{ include "clickstack.chart" . }}
36+
{{ include "clickstack.selectorLabels" . }}
3737
{{- if .Chart.AppVersion }}
3838
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
3939
{{- end }}
@@ -43,7 +43,7 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
4343
{{/*
4444
Selector labels
4545
*/}}
46-
{{- define "hdx-oss.selectorLabels" -}}
47-
app.kubernetes.io/name: {{ include "hdx-oss.name" . }}
46+
{{- define "clickstack.selectorLabels" -}}
47+
app.kubernetes.io/name: {{ include "clickstack.name" . }}
4848
app.kubernetes.io/instance: {{ .Release.Name }}
4949
{{- end }}

0 commit comments

Comments
 (0)