|
| 1 | +# OpenTelemetry Demo app + HotRODapp + Jaeger + OpenSearch |
| 2 | + |
| 3 | +This example provides a one-command deployment of a complete observability stack on Kubernetes: |
| 4 | +- Jaeger (all-in-one) for tracing |
| 5 | +- OpenSearch and OpenSearch Dashboards |
| 6 | +- OpenTelemetry Demo application (multi-service web store) |
| 7 | +- HotRod application |
| 8 | + |
| 9 | +It is driven by `deploy-all.sh`, which supports both clean installs and upgrades. |
| 10 | + |
| 11 | +## Prerequisites |
| 12 | +- Kubernetes cluster reachable via `kubectl` |
| 13 | +- Installed CLIs: `bash`, `git`, `curl`, `kubectl`, `helm` |
| 14 | +- Network access to Helm repositories |
| 15 | + |
| 16 | +## Quick start |
| 17 | +- Clean install (removes previous releases/namespaces, then installs everything): |
| 18 | +```bash path=null start=null |
| 19 | +./deploy-all.sh clean |
| 20 | +``` |
| 21 | +- Upgrade (default) — installs if missing, upgrades if present: |
| 22 | +```bash path=null start=null |
| 23 | +./deploy-all.sh |
| 24 | +# or explicitly |
| 25 | +./deploy-all.sh upgrade |
| 26 | +``` |
| 27 | +- Specify Jaeger all-in-one image tag: |
| 28 | +```bash path=null start=null |
| 29 | +./deploy-all.sh upgrade <image-tag> |
| 30 | +# Example |
| 31 | +./deploy-all.sh upgrade latest |
| 32 | +``` |
| 33 | + |
| 34 | +Environment variables: |
| 35 | +- ROLLOUT_TIMEOUT: rollout wait timeout in seconds (default 600) |
| 36 | + |
| 37 | +```bash path=null start=null |
| 38 | +ROLLOUT_TIMEOUT=900 ./deploy-all.sh clean |
| 39 | +``` |
| 40 | + |
| 41 | +## What gets deployed |
| 42 | +- Namespace `opensearch`: |
| 43 | + - OpenSearch (single node) StatefulSet |
| 44 | + - OpenSearch Dashboards Deployment |
| 45 | +- Namespace `jaeger`: |
| 46 | + - Jaeger all-in-one Deployment (storage=none) |
| 47 | + - HOTROD application |
| 48 | + - Jaeger Query ClusterIP service (jaeger-query-clusterip) |
| 49 | +- Namespace `otel-demo`: |
| 50 | + - OpenTelemetry Demo (frontend, load-generator, and supporting services) |
| 51 | + |
| 52 | + |
| 53 | +## Verifying the deployment |
| 54 | +- Pods status: |
| 55 | +```bash path=null start=null |
| 56 | +kubectl get pods -n opensearch |
| 57 | +kubectl get pods -n jaeger |
| 58 | +kubectl get pods -n otel-demo |
| 59 | +``` |
| 60 | +- Services: |
| 61 | +```bash path=null start=null |
| 62 | +kubectl get svc -n opensearch |
| 63 | +kubectl get svc -n jaeger |
| 64 | +kubectl get svc -n otel-demo |
| 65 | +``` |
| 66 | + |
| 67 | + |
| 68 | +## Automatic port-forward using scrpit |
| 69 | + - OpenSearch Dashboards: |
| 70 | +```bash path=null start=null |
| 71 | +./start-port-forward.sh |
| 72 | + |
| 73 | + |
| 74 | +## Customization |
| 75 | +- Helm values provided in this directory: |
| 76 | + - `opensearch-values.yaml` |
| 77 | + - `opensearch-dashboard-values.yaml` |
| 78 | + - `jaeger-values.yaml` |
| 79 | + - `jaeger-config.yaml` |
| 80 | + - `otel-demo-values.yaml` |
| 81 | + - `jaeger-query-service.yaml` |
| 82 | + |
| 83 | +You can adjust these files and re-run `./deploy-all.sh upgrade` to apply changes. |
| 84 | + |
| 85 | +## Clean-up |
| 86 | +- Clean uninstall using cleanup.sh : |
| 87 | +```bash path=null start=null |
| 88 | +./cleanup.sh |
| 89 | +``` |
| 90 | +- Manual teardown: |
| 91 | +```bash path=null start=null |
| 92 | +helm uninstall opensearch -n opensearch || true |
| 93 | +helm uninstall opensearch-dashboards -n opensearch || true |
| 94 | +helm uninstall jaeger -n jaeger || true |
| 95 | +helm uninstall otel-demo -n otel-demo || true |
| 96 | +kubectl delete namespace opensearch jaeger otel-demo --ignore-not-found=true |
| 97 | +``` |
| 98 | + |
| 99 | + |
| 100 | + |
0 commit comments