### Suite Configuration Example (suite.yaml)

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/integration-tests/README.md

Specifies dependencies and configuration for a test suite. `needs_operators` installs operators, `needs_local_storage` sets up a provisioner, and `needs_nodejs` prepares a Node.js environment.

```yaml
needs_operators: false      # install clickstack-operators + wait for CRDs
needs_local_storage: false  # install local-path-provisioner as default StorageClass
needs_nodejs: false         # set up Node.js (for Playwright or other JS-based tests)
timeout: 300                # helm install --timeout in seconds
```

--------------------------------

### Install ClickStack Operators and ClickStack with ALB Values

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/examples/alb-ingress/README.md

Install the ClickStack operators first, then install ClickStack using the provided ALB ingress `values.yaml` file. Alternatively, you can install from the current directory using `-f values.yaml`.

```bash
helm install clickstack-operators clickstack/clickstack-operators

helm install my-clickstack clickstack/clickstack \
  -f examples/alb-ingress/values.yaml
```

--------------------------------

### Install ClickStack Helm Charts

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/README.md

Add the ClickStack Helm repository, update it, and then install the operators and the main ClickStack chart.

```bash
helm repo add clickstack https://clickhouse.github.io/ClickStack-helm-charts
helm repo update

# Step 1: Install operators and CRDs
helm install clickstack-operators clickstack/clickstack-operators

# Step 2: Install ClickStack (after operators are ready)
helm install my-clickstack clickstack/clickstack
```

--------------------------------

### Install helm-unittest Plugin

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/tests/README.md

Installs the helm-unittest plugin, which is required for running Helm chart tests. Ensure Helm v3 is installed before running this command.

```bash
helm plugin install https://github.com/quintush/helm-unittest
```

--------------------------------

### Install helm-unittest Plugin

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Installs the helm-unittest plugin, which is required for running unit tests on Helm charts.

```bash
helm plugin install https://github.com/helm-unittest/helm-unittest.git --version v1.0.3
```

--------------------------------

### Install Operators and ClickStack

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Install operators and CRDs in Phase 1, followed by the main ClickStack chart in Phase 2. Uninstall in reverse order.

```bash
# Phase 1: Install operators and CRDs
helm install clickstack-operators clickstack/clickstack-operators

# Phase 2: Install ClickStack
helm install my-clickstack clickstack/clickstack
```

```bash
helm uninstall my-clickstack
helm uninstall clickstack-operators
```

--------------------------------

### Helm Hook for Post-Install Job

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Use Helm hook annotations to control the ordering of `additionalManifests` during install or upgrade. This example defines a post-install job that runs a migration script.

```yaml
additionalManifests:
  - apiVersion: batch/v1
    kind: Job
    metadata:
      name: post-install-job
      annotations:
        helm.sh/hook: post-install
        helm.sh/hook-delete-policy: hook-succeeded
    spec:
      template:
        spec:
          restartPolicy: Never
          containers:
            - name: migrate
              image: my-migration-image:latest
              command: ["./migrate.sh"]
```

--------------------------------

### Install ClickStack API-Only

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/examples/api-only/README.md

Use this command to install the ClickStack chart with an API-only configuration, referencing a custom values file.

```bash
helm install my-api clickstack/clickstack \
  -f examples/api-only/values.yaml
```

--------------------------------

### Install JS Dependencies

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Installs JavaScript dependencies using Yarn. This is primarily for changesets and versioning scripts.

```bash
yarn install
```

--------------------------------

### Deploying a ConfigMap with additionalManifests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Example of adding a ConfigMap to the deployment using `additionalManifests`. Ensure template expressions within values are quoted.

```yaml
additionalManifests:
  - apiVersion: v1
    kind: ConfigMap
    metadata:
      name: '{{ include "clickstack.fullname" . }}-custom'
    data:
      release: '{{ .Release.Name }}'
```

--------------------------------

### Running a Test Suite Locally

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/integration-tests/README.md

Command to execute a specific test suite, such as 'api-only', from the repository root. Requires `kind`, `helm`, `kubectl`, and `yq` to be installed.

```bash
# From the repo root
./integration-tests/run-suite.sh api-only
```

--------------------------------

### Wrapper Chart Template Example

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Render structural helpers like labels from a wrapper chart template (`templates/*.yaml`) instead of embedding them directly in values files. This example shows a ConfigMap using included labels and values.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ include "clickstack.fullname" . }}-extra
  labels:
    {{- include "clickstack.labels" . | nindent 4 }}
data:
  appPort: "{{ .Values.hyperdx.ports.app }}"
```

--------------------------------

### HyperDX Values Reorganization Example

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

The `hyperdx:` block is now organized by Kubernetes resource type. This example shows shared port numbers, frontend URL, and configuration for non-sensitive and sensitive environment variables.

```yaml
hyperdx:
  ports:          # Shared port numbers (Deployment, Service, ConfigMap, Ingress)
    api: 8000
    app: 3000
    opamp: 4320

  frontendUrl: "http://localhost:3000"   # Replaces the removed appUrl

  config:         # → clickstack-config ConfigMap (non-sensitive env vars)
    APP_PORT: "3000"
    HYPERDX_LOG_LEVEL: "info"
    # ... full list in values.yaml

  secrets:        # → clickstack-secret Secret (sensitive env vars)
    HYPERDX_API_KEY: "..."
    CLICKHOUSE_PASSWORD: "otelcollectorpass"
    CLICKHOUSE_APP_PASSWORD: "hyperdx"
    MONGODB_PASSWORD: "hyperdx"

  deployment:     # K8s Deployment spec (image, replicas, probes, etc.)
  service:        # K8s Service spec (type, annotations)
  ingress:        # K8s Ingress spec (host, tls, annotations)
  podDisruptionBudget:  # K8s PDB spec
  tasks:          # K8s CronJob specs (previously top-level tasks:)
```

--------------------------------

### Helm Unit Test Structure Example

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

An example YAML structure for a Helm unit test file using the helm-unittest framework. Defines tests for a specific component and template.

```yaml
suite: Test <Component Name>
templates:
  - <component>/<template>.yaml
tests:
  - it: should <describe expected behavior>
    set:
      <values to override>
    asserts:
      - isKind:
          of: <Kind>
      - equal:
          path: <jsonpath>
          value: <expected>
```

--------------------------------

### Deploying a ServiceAccount with additionalManifests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Example of creating a Kubernetes ServiceAccount using `additionalManifests`. Includes metadata like name, namespace, labels, and AWS role ARN annotation.

```yaml
additionalManifests:
  - apiVersion: v1
    kind: ServiceAccount
    metadata:
      name: '{{ include "clickstack.fullname" . }}'
      namespace: '{{ .Release.Namespace }}'
      labels:
        app.kubernetes.io/name: '{{ include "clickstack.name" . }}'
        app.kubernetes.io/instance: '{{ .Release.Name }}'
      annotations:
        eks.amazonaws.com/role-arn: "arn:aws:iam::123456789:role/my-role"
```

--------------------------------

### Setting up HorizontalPodAutoscaler with additionalManifests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Example of configuring a HorizontalPodAutoscaler to automatically adjust the number of pods. It targets a specific deployment and sets resource utilization metrics.

```yaml
additionalManifests:
  - apiVersion: autoscaling/v2
    kind: HorizontalPodAutoscaler
    metadata:
      name: '{{ include "clickstack.fullname" . }}-hpa'
    spec:
      scaleTargetRef:
        apiVersion: apps/v1
        kind: Deployment
        name: '{{ include "clickstack.fullname" . }}-app'
      minReplicas: 2
      maxReplicas: 10
      metrics:
        - type: Resource
          resource:
            name: cpu
            target:
              type: Utilization
              averageUtilization: 75
```

--------------------------------

### Configuring PodMonitor for Prometheus Operator

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Example of defining a PodMonitor resource for the Prometheus Operator. It selects pods based on labels and specifies the endpoint and scrape interval for metrics.

```yaml
additionalManifests:
  - apiVersion: monitoring.coreos.com/v1
    kind: PodMonitor
    metadata:
      name: '{{ include "clickstack.fullname" . }}'
      labels:
        release: prometheus
    spec:
      selector:
        matchLabels:
          app.kubernetes.io/name: '{{ include "clickstack.name" . }}'
          app.kubernetes.io/instance: '{{ .Release.Name }}'
      podMetricsEndpoints:
        - port: app
          interval: 30s
```

--------------------------------

### Get Ingress Information

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/templates/NOTES.txt

If Ingress is enabled for HyperDX, use this command to retrieve the configured host from the Ingress resource. This is recommended for production environments.

```bash
kubectl get ingress -l "app.kubernetes.io/name={{ include "clickstack.name" . }}"
```

--------------------------------

### Configuring NetworkPolicy with additionalManifests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Example for restricting ingress traffic to pods by defining a NetworkPolicy. It selects pods based on app labels and specifies allowed ingress sources and ports.

```yaml
additionalManifests:
  - apiVersion: networking.k8s.io/v1
    kind: NetworkPolicy
    metadata:
      name: '{{ include "clickstack.fullname" . }}-allow-ingress'
    spec:
      podSelector:
        matchLabels:
          app.kubernetes.io/name: '{{ include "clickstack.name" . }}'
          app.kubernetes.io/instance: '{{ .Release.Name }}'
      policyTypes:
        - Ingress
      ingress:
        - from:
            - namespaceSelector:
                matchLabels:
                  kubernetes.io/metadata.name: ingress-nginx
          ports:
            - protocol: TCP
              port: 3000
            - protocol: TCP
              port: 8000
```

--------------------------------

### Uninstall ClickStack Helm Charts

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/README.md

Uninstall the ClickStack application and operators in reverse order of installation. Note that PersistentVolumeClaims are not automatically removed.

```bash
helm uninstall my-clickstack            # Remove app + CRs first
helm uninstall clickstack-operators     # Remove operators + CRDs
```

--------------------------------

### Run Integration Tests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Executes integration tests using a Kind cluster. Requires kind, helm, kubectl, and yq. Suites are located in integration-tests/<suite-name>/.

```bash
./integration-tests/run-suite.sh api-only    # or full-stack
# Cleanup
helm uninstall test-api-only || true
kind delete cluster --name test-api-only || true
```

--------------------------------

### Workflow Diagram

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/integration-tests/README.md

Illustrates the CI workflow for discovering and running integration test suites in parallel on separate runners.

```text
discover job                    integration-test matrix
┌─────────────┐     ┌──────────────────────────────────┐
│ scan for     │────▶│ full-stack   (parallel runner)   │
│ suite.yaml   │     │ api-only     (parallel runner)   │
│ → JSON array │     │ your-suite   (parallel runner)   │
└─────────────┘     └──────────────────────────────────┘
```

--------------------------------

### Build Helm Chart Dependencies

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Adds necessary Helm repositories and builds chart dependencies. Required before running template or test commands.

```bash
helm repo add mongodb https://mongodb.github.io/helm-charts
helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
helm dependency build charts/clickstack
```

--------------------------------

### ClickHouse Configuration (New)

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Configure ClickHouse using `ClickHouseCluster` and `KeeperCluster` custom resources. The CR specs are rendered verbatim from the provided values. User credentials should be sourced from `hyperdx.secrets`.

```yaml
clickhouse:
  enabled: true
  port: 8123
  nativePort: 9000
  prometheus:
    enabled: true
    port: 9363
  keeper:
    spec:                       # Full KeeperCluster CRD spec
      replicas: 1
      dataVolumeClaimSpec:
        accessModes: ["ReadWriteOnce"]
        resources:
          requests:
            storage: 5Gi
  cluster:
    spec:                       # Full ClickHouseCluster CRD spec
      replicas: 1
      shards: 1
      keeperClusterRef:
        name: '{{ include "clickstack.clickhouse.keeper" . }}'
      dataVolumeClaimSpec:
        accessModes: ["ReadWriteOnce"]
        resources:
          requests:
            storage: 10Gi
      settings:
        extraUsersConfig:
          users:
            app:
              password: '{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}'
            otelcollector:
              password: '{{ .Values.hyperdx.secrets.CLICKHOUSE_PASSWORD }}'
        extraConfig:
          max_connections: 4096
          keep_alive_timeout: 64
          max_concurrent_queries: 100
```

--------------------------------

### Environment Variables for assert.sh

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/integration-tests/README.md

Lists environment variables available to the `assert.sh` script for verification. These include suite name, release name, namespace, and paths to the suite directory and repository root.

```markdown
| Variable |
|----------|----------|
| `SUITE_NAME` | Directory name | `my-new-suite` |
| `RELEASE_NAME` | Helm release name | `test-my-new-suite` |
| `NAMESPACE` | Kubernetes namespace | `default` |
| `SUITE_DIR` | Absolute path to suite directory | `/path/to/integration-tests/my-new-suite` |
| `REPO_ROOT` | Absolute path to repo root | `/path/to/ClickStack-helm-charts` |
```

--------------------------------

### Configure OTEL Collector Deployment

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Enable and configure the OTEL Collector deployment, specifying the image repository and tag. Environment variables are shared via `clickstack-config` ConfigMap and `clickstack-secret` Secret. Ensure ports for OTLP and OTLP-HTTP are enabled as needed.

```yaml
otel-collector:
  enabled: true
  mode: deployment
  image:
    repository: docker.clickhouse.com/clickhouse/clickstack-otel-collector
    tag: ""
  extraEnvsFrom:
    - configMapRef:
        name: clickstack-config
    - secretRef:
        name: clickstack-secret
  ports:
    otlp:
      enabled: true
      containerPort: 4317
      servicePort: 4317
    otlp-http:
      enabled: true
      containerPort: 4318
      servicePort: 4318
    # ... see values.yaml for full port list
```

--------------------------------

### Run All Helm Chart Tests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/tests/README.md

Executes all unit tests defined for the ClickStack Helm chart. This command should be run from the root directory of the chart.

```bash
helm unittest charts/clickstack
```

--------------------------------

### Integration Test Suite Structure

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/integration-tests/README.md

Defines the required and optional files for a new integration test suite. The `suite.yaml` declares dependencies, `values.yaml` provides Helm values, and `assert.sh` contains verification logic.

```bash
integration-tests/
  my-new-suite/
    suite.yaml       # required -- declares what the suite needs
    values.yaml      # required -- Helm values for the chart install
    assert.sh        # required -- verification script (exit 0 = pass)
    prereq.sh        # optional -- runs before helm install
    kind-config.yaml # optional -- custom Kind cluster config
```

--------------------------------

### Verify ClickStack Deployment Status

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/templates/NOTES.txt

Run this command to check the status of all pods belonging to the ClickStack deployment. This helps in confirming that all components are running as expected.

```bash
kubectl get pods -l "app.kubernetes.io/name={{ include "clickstack.name" . }}"
```

--------------------------------

### MongoDB Persistence Configuration (New)

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Add persistence for MongoDB by including a `statefulSet` block within `mongodb.spec`. Specify the desired storage class and size.

```yaml
mongodb:
  spec:
    statefulSet:
      spec:
        volumeClaimTemplates:
          - metadata:
              name: data-volume
            spec:
              accessModes: ["ReadWriteOnce"]
              storageClassName: "your-storage-class"
              resources:
                requests:
                  storage: 10Gi
```

--------------------------------

### Access ClickStack Application via Port Forwarding

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/templates/NOTES.txt

This command is useful for development and testing to access the HyperDX service locally. It forwards traffic from your local machine to the HyperDX service within the cluster. Ensure the application is not exposed directly to the internet without proper security measures.

```bash
kubectl port-forward svc/{{ include "clickstack.hyperdx.fullname" . }} {{ .Values.hyperdx.ports.app }}:{{ .Values.hyperdx.ports.app }}
```

--------------------------------

### Run Helm Unit Tests

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Executes Helm unit tests. Supports running all tests, a single test file, or tests matching a specific pattern.

```bash
helm unittest charts/clickstack
```

```bash
helm unittest -f tests/app-deployment_test.yaml charts/clickstack
```

```bash
helm unittest -f 'tests/clickhouse-*_test.yaml' charts/clickstack
```

--------------------------------

### Configure Storage Class for MongoDB and ClickHouse

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Storage class is now configured directly in each operator's CR spec, replacing global settings. Ensure the specified storage class exists.

```yaml
mongodb:
  spec:
    statefulSet:
      spec:
        volumeClaimTemplates:
          - spec:
              storageClassName: "fast-ssd"

clickhouse:
  keeper:
    spec:
      dataVolumeClaimSpec:
        storageClassName: "fast-ssd"
  cluster:
    spec:
      dataVolumeClaimSpec:
        storageClassName: "fast-ssd"
```

--------------------------------

### Local Test Suite Cleanup

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/integration-tests/README.md

Commands to clean up resources after running a local test suite, including uninstalling the Helm release and deleting the Kind cluster.

```bash
# Clean up
helm uninstall test-api-only || true
kind delete cluster --name test-api-only || true
```

--------------------------------

### Shell Script Conventions

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Standard practices for shell scripts in this project, including shebang, error handling, variable naming, and function usage.

```shell
#!/bin/bash
set -e
set -o pipefail
```

```shell
RELEASE_NAME=my-release
NAMESPACE=my-namespace
SUITE_DIR=/tmp/suites
```

```shell
echo "${VAR:-default}"
```

```shell
echo "${1:?Usage message}"
```

--------------------------------

### MongoDB Configuration (New)

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Configure MongoDB using the `MongoDBCommunity` custom resource. The spec is rendered verbatim from `mongodb.spec`. Ensure the MongoDB password is set in `hyperdx.secrets.MONGODB_PASSWORD`.

```yaml
mongodb:
  enabled: true
  spec:                         # Full MongoDBCommunity CRD spec
    members: 1
    type: ReplicaSet
    version: "5.0.32"
    security:
      authentication:
        modes: ["SCRAM"]
    users:
      - name: hyperdx
        db: hyperdx
        passwordSecretRef:
          name: '{{ include "clickstack.mongodb.fullname" . }}-password'
        roles:
          - name: dbOwner
            db: hyperdx
          - name: clusterMonitor
            db: admin
        scramCredentialsSecretName: '{{ include "clickstack.mongodb.fullname" . }}-scram'
    additionalMongodConfig:
      storage.wiredTiger.engineConfig.journalCompressor: zlib
```

--------------------------------

### Set OTEL Collector Resources

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Configure resource requests and limits for the OTEL Collector deployment, specifying memory and CPU allocation. This replaces the previous `otel.resources` setting.

```yaml
otel-collector:
  resources:
    requests:
      memory: "128Mi"
      cpu: "100m"
    limits:
      memory: "256Mi"
      cpu: "200m"
```

--------------------------------

### Define TargetGroupBinding for ALB

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Create an explicit TargetGroupBinding resource for ALB scenarios that require it. Ensure the serviceRef and targetGroupARN are correctly specified.

```yaml
additionalManifests:
  - apiVersion: elbv2.k8s.aws/v1beta1
    kind: TargetGroupBinding
    metadata:
      name: '{{ include "clickstack.fullname" . }}-tgb'
    spec:
      serviceRef:
        name: '{{ include "clickstack.fullname" . }}-app'
        port: app
      targetGroupARN: "arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/my-tg/abc123"
      targetType: ip
```

--------------------------------

### Run Specific Helm Test Suite

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/tests/README.md

Runs a specific test suite for the ClickStack Helm chart, identified by its test file. This allows for targeted testing of particular components.

```bash
helm unittest -f tests/app-deployment_test.yaml charts/clickstack
```

--------------------------------

### Configure OTEL Collector Node Selector and Tolerations

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Define node selectors and tolerations for the OTEL Collector pods to control scheduling. This replaces the previous `otel.nodeSelector` and `otel.tolerations` settings.

```yaml
otel-collector:
  nodeSelector:
    node-role: monitoring
  tolerations:
    - key: monitoring
      operator: Equal
      value: otel
      effect: NoSchedule
```

--------------------------------

### Validate Helm Templates

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/AGENTS.md

Renders Helm templates to validate they produce no errors. Can be used with a specific values file for targeted validation.

```bash
helm template clickstack-test charts/clickstack
```

```bash
helm template clickstack-test charts/clickstack -f examples/alb-ingress/values.yaml
```

```bash
helm template clickstack-test charts/clickstack -f examples/api-only/values.yaml
```

--------------------------------

### Removed ClickHouse Configuration

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

This configuration block for ClickHouse is no longer used and should not be deployed.

```yaml
# REMOVED -- do not use
clickhouse:
  image: "..."
  terminationGracePeriodSeconds: 90
  resources: {}
  livenessProbe: ...
  readinessProbe: ...
  startupProbe: ...
  nodeSelector: {}
  tolerations: []
  service:
    type: ClusterIP
    annotations: {}
  persistence:
    enabled: true
    dataSize: 10Gi
    logSize: 5Gi
  config:
    clusterCidrs: [...]
    users:
      appUserPassword: "..."
      otelUserPassword: "..."
      otelUserName: "..."
```

--------------------------------

### Valid Quoted Template Expression in values.yaml

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Demonstrates a valid way to include Helm template expressions within a string value in `values.yaml`. Unquoted expressions can lead to parsing errors.

```yaml
name: '{{ include "clickstack.fullname" . }}-app'
```

--------------------------------

### Set OTEL Collector Replica Count

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

Specify the desired number of replicas for the OTEL Collector deployment. This replaces the previous `otel.replicas` setting.

```yaml
otel-collector:
  replicaCount: 3
```

--------------------------------

### Configure AWS ALB Ingress

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Disable the built-in nginx Ingress and define a custom ALB Ingress resource when using the AWS Load Balancer Controller. Ensure the certificate ARN and host are correctly configured for your environment.

```yaml
hyperdx:
  ingress:
    enabled: false

additionalManifests:
  - apiVersion: networking.k8s.io/v1
    kind: Ingress
    metadata:
      name: '{{ include "clickstack.fullname" . }}-alb'
      annotations:
        alb.ingress.kubernetes.io/scheme: internet-facing
        alb.ingress.kubernetes.io/target-type: ip
        alb.ingress.kubernetes.io/certificate-arn: "arn:aws:acm:us-east-1:123456789:certificate/abc-123"
        alb.ingress.kubernetes.io/listen-ports: '[{"HTTPS":443}]'
        alb.ingress.kubernetes.io/ssl-redirect: "443"
        alb.ingress.kubernetes.io/group.name: clickstack
        alb.ingress.kubernetes.io/healthcheck-path: /api/health
    spec:
      ingressClassName: alb
      rules:
        - host: clickstack.example.com
          http:
            paths:
              - path: /
                pathType: Prefix
                backend:
                  service:
                    name: '{{ include "clickstack.fullname" . }}-app'
                    port:
                      name: app
```

--------------------------------

### Removed MongoDB Configuration

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

This configuration block for MongoDB is no longer used and should not be deployed.

```yaml
# REMOVED -- do not use
mongodb:
  image: "..."
  port: 27017
  strategy: ...
  nodeSelector: {}
  tolerations: []
  livenessProbe: ...
  readinessProbe: ...
  persistence:
    enabled: true
    dataSize: 10Gi
```

--------------------------------

### Invalid Structural Template Block in values.yaml

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Illustrates an invalid structural template block directly in `values.yaml`. Such constructs require a wrapper chart template for proper evaluation.

```yaml
labels:
  {{- include "clickstack.labels" . | nindent 2 }}
```

--------------------------------

### Removed OTEL Collector Configuration

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/UPGRADE.md

The entire `otel:` block for OTEL Collector configuration is removed and should not be used.

```yaml
# REMOVED -- do not use
otel:
  enabled: true
  image: ...
  replicas: 1
  resources: {}
  clickhouseEndpoint: ...
  clickhouseUser: ...
  clickhousePassword: ...
  clickhouseDatabase: "default"
  opampServerUrl: ...
  port: 13133
  nativePort: 24225
  grpcPort: 4317
  httpPort: 4318
  healthPort: 8888
  env: []
  customConfig: ...
```

--------------------------------

### Disable ClickStack Components with Helm

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/charts/clickstack/templates/NOTES.txt

Use this command to disable specific components like ClickHouse, MongoDB, or the OpenTelemetry Collector during Helm upgrades. Ensure corresponding endpoints in hyperdx.config are updated to point to external services.

```bash
helm upgrade {{ .Release.Name }} <chart-name-or-path> \
    --set clickhouse.enabled=false \
    --set mongodb.enabled=false \
    --set otel-collector.enabled=false
```

--------------------------------

### Invalid Unquoted Template Expression in values.yaml

Source: https://github.com/clickhouse/clickstack-helm-charts/blob/main/docs/ADDITIONAL-MANIFESTS.md

Shows an invalid usage where a Helm template expression is not quoted in `values.yaml`, which will cause YAML parsing issues.

```yaml
name: {{ include "clickstack.fullname" . }}-app
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.