[DOC] Update Helm chart doc

knylander-grafana commented 1 week ago

Update the Helm chart documentation to address gaps in content and common questions.

Helm chart doc: https://github.com/grafana/tempo/issues/4326

pages to update:

Helm chart doc, https://grafana.com/docs/helm-charts/tempo-distributed/next/get-started-helm-charts/
Enterprise traces gateway, https://grafana.com/docs/enterprise-traces/latest/configure/gateway/

- [x] Evaluate helm chart doc to make sure steps are up to date
- [x] Evaluate if we have gaps
- [ ] Provide some example configs
- [x] Add TLS info - https://github.com/grafana/tempo/pull/4328
- [x] Clarify the different types of gateway used in Helm chart for GET (enterpriseGateway), Tempo (gateway: true), nginx
- [x] Use the collapse shortcode for large configuration sections  (https://grafana.com/docs/writers-toolkit/write/shortcodes/#collapse)
- [x] Address issues found by FE walkthrough of Helm chart docs (see comments below)
- [ ] Check for streaming endpoint in Helm chart https://github.com/grafana/tempo/issues/3987

knylander-grafana commented 1 week ago

Zach's PR to handle TLS with Helm - https://github.com/grafana/tempo/pull/4328/

hedss commented 1 week ago

Just rough C&P from GET install today:

4 cores and 16GB memory (don't believe this, unless it's 4vCPU per core, and anti-affinitising components could actually fail here if there aren't enough nodes)
Image tag shouldn't be set because for latest chart version options will be wrong, latest is always defined as App Version anyway)
Don't need to enable enterpriseGateway if enterprise is enabled, not even sure this flag is still valid?
Don't need to explicitly disable gateway (it's never on by default) anyway
Minio isn't enabled by default so you don't need to disable it in the chart if not using it
Add an example of both Tempo and GET gateways for ingress (it's not clear how these are different and has caused confusion). We should be very clear on what each does and how to configure it. I don't think we should be explicitly stating the Enterprise Gateway by default as this could add an ingress when only an internal cluster/shared VPC setup is required.

Worth checking the rest of the doc too for other things when we go through this. cc @ayah-el @danstadler-pdx

knylander-grafana commented 6 days ago

Verify that the GRPC endpoint for streaming is listed. Http2 proxy. Related: https://github.com/grafana/tempo/issues/3987#issuecomment-2452108337

From Joe: I have not operated istio so I can't say for sure. You will need to make sure that envoy is proxying HTTP2 generically or perhaps it supports GRPC more specifically?

Yes it seems there is missing config in the nginx gw in the helm chart to allow for TraceQL streaming. I'm was looking at the config here and I don't see a pass for the streaming GRPC endpoint. It may also need special config for proxying HTTP2.

knylander-grafana commented 3 days ago

PR to address FE issue:https://github.com/grafana/tempo/pull/4370

grafana / tempo

[DOC] Update Helm chart doc #4326