This repository contains Helm charts for OpenTelemetry Kubernetes stack.
For a streamlined deployment experience, you can use the provided deployment script that handles prerequisites and configuration automatically:
cd charts/opentelemetry-kube-stack
./deploy.shThe script will:
- Check and install required dependencies (cert-manager, OpenTelemetry operator)
- Prompt for namespace configuration
- Configure OpenTelemetry endpoint and API key
- Deploy the Helm chart with proper settings
- Verify the deployment
Prerequisites:
kubectlconfigured and connected to your clusterhelminstalled- Appropriate cluster permissions
Helm must be installed to use the charts. Please refer to Helm's documentation to get started.
Once Helm has been set up correctly, add the repo as follows:
helm repo add tsuga-charts https://tsuga-dev.github.io/helm-charts/If you had already added this repo earlier, run helm repo update to retrieve
the latest versions of the packages. You can then run helm search repo tsuga-charts to see the charts.
Before installing the opentelemetry-kube-stack chart, you need to install:
cert-manager (required by the OpenTelemetry Operator):
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.18.2/cert-manager.yamlYou can pre-install the OpenTelemetry Operator or install it with this chart.
Option A: Pre-Install
kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yamlOption B: Install with this chart by setting opentelemetry-operator.enabled=true in your values.yaml file or on the command line when installing:
helm install my-opentelemetry-kube-stack tsuga-charts/opentelemetry-kube-stack \
--set opentelemetry-operator.enabled=trueIt is recommended to create a secret for the Tsuga API key and use it in the values.yaml file or on the command line when installing:
Option A: Generate new secret (default)
helm install my-otel-stack ./charts/opentelemetry-kube-stack \
--set tsuga.otlpEndpoint="https://your-tsuga-endpoint.com" \
--set tsuga.apiKey="your-api-key-here"Option B: Use existing secret
helm install my-otel-stack ./charts/opentelemetry-kube-stack \
--set secret.create=false \
--set secret.name="my-existing-secret" \
--set secret.keyMapping.TSUGA_API_KEY="api-key" \
--set secret.keyMapping.TSUGA_OTLP_ENDPOINT="otlp-endpoint"To install the opentelemetry-kube-stack chart:
helm install my-opentelemetry-kube-stack tsuga-charts/opentelemetry-kube-stackTo uninstall the chart:
helm uninstall my-opentelemetry-kube-stackYou can check the examples folder for more details.
Each chart has its own README with full configuration and values reference:
- opentelemetry-kube-stack: OpenTelemetry Kubernetes operator with Tsuga integration — dual deployment pattern (agent DaemonSet + cluster receiver), secure credential management, and production-ready telemetry collection.
- opentelemetry-demo: Tsuga Observability Demo stack wiring the OpenTelemetry demo app with Tsuga-focused defaults.
- opentelemetry-database-monitoring: Deep monitoring for PostgreSQL via an OpenTelemetry sidecar collector — installs stored functions, a dedicated monitoring user, and emits metrics over OTLP.
- tsuga-spicy-gremlin: A minimal chart to run spicy-gremlin against OpenTelemetry Demo feature flags.
Each chart has its own CHANGELOG.md in Keep a Changelog format under its directory (e.g. charts/opentelemetry-kube-stack/CHANGELOG.md). When you bump a chart's version in Chart.yaml, you must add a corresponding entry to that chart's CHANGELOG.md; CI will fail otherwise.
Changelogs can be generated or updated with git-cliff using the per-chart config in each chart directory (e.g. charts/opentelemetry-kube-stack/cliff.toml). From the repo root, run:
git cliff -c charts/<chart-name>/cliff.tomlUse Conventional Commits (e.g. feat:, fix:, docs:) for commits that touch a chart so they are categorized correctly.
The charts are published to: https://tsuga-dev.github.io/helm-charts/
Please see the main repository for contribution guidelines and chart development.