Skip to content

Commit 628e651

Browse files
committed
docs: add OTel Demo and GHCR images to READMEs
1 parent 18b7e56 commit 628e651

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

charts/observability-stack/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,22 @@ prometheus:
123123
kubernetes-api-servers: { enabled: false }
124124
# ... etc
125125
```
126+
127+
## OpenTelemetry Demo (Optional)
128+
129+
The [OpenTelemetry Demo](https://opentelemetry.io/docs/demo/) is available as an optional subchart. It deploys a full microservices e-commerce app (20+ services) that generates realistic telemetry — useful for load testing and showcasing the stack.
130+
131+
Disabled by default (~2GB additional memory required).
132+
133+
**Enable:**
134+
```bash
135+
helm upgrade obs-stack . -n observability-stack -f ../../terraform/aws/values-eks.yaml \
136+
--set opentelemetry-demo.enabled=true --no-hooks
137+
```
138+
139+
**Disable:**
140+
```bash
141+
helm upgrade obs-stack . -n observability-stack -f ../../terraform/aws/values-eks.yaml --no-hooks
142+
```
143+
144+
All bundled backends (Jaeger, Grafana, Prometheus, OpenSearch) in the demo chart are disabled — demo services send telemetry to our OTel Collector. No duplicate infrastructure.

terraform/aws/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,18 @@ kubectl port-forward -n observability-stack svc/obs-stack-opentelemetry-collecto
7676
export OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317"
7777
```
7878

79+
## Add OpenTelemetry Demo
80+
81+
To deploy the [OTel Demo](https://opentelemetry.io/docs/demo/) microservices app alongside the stack:
82+
83+
```bash
84+
cd terraform/aws
85+
helm upgrade obs-stack ../../charts/observability-stack -n observability-stack -f values-eks.yaml \
86+
--set opentelemetry-demo.enabled=true --no-hooks
87+
```
88+
89+
Adds 20+ services generating realistic e-commerce telemetry (~2GB additional memory). All demo telemetry flows through the stack's OTel Collector — no duplicate backends.
90+
7991
## Destroy
8092

8193
```bash

0 commit comments

Comments
 (0)