tempo
tempo copied to clipboard
grafana
[Doc] Update or create doc for Tempo config using Helm
Update the HELM deployment instructions for Tempo. Right now we have a pointer to a Helm chart that goes to these places:
- GET: https://github.com/suitupalex/helm-charts/tree/enterprise-traces/charts/enterprise-traces
- Tempo: https://github.com/grafana/tempo/tree/main/example/helm
We don't have any instructions for Tempo for Helm configuration. Our instructions for Tempo point to the above repo link.
- Community has a Helm chart.
- Is the Helm chart for GET linked above provided by Grafana?
Possible SME: @zalegrala is researching Helm charts -- See https://github.com/grafana/helm-charts/pull/1701
Example Mimir docs:
- Doc in repo: https://github.com/grafana/mimir/blob/main/docs/sources/operators-guide/deploy-grafana-mimir/getting-started-helm-charts/_index.md
- Helm chart get started guide in Mimir: https://grafana.com/docs/mimir/latest/operators-guide/deploy-grafana-mimir/getting-started-helm-charts/
I've started some modifications on the Helm chart above. I think I should be able to get it working today.
See Mimir doc for Helm: https://github.com/grafana/mimir/pull/2299/files
Also, several members of the Doc Squad (Ursula, me, Chris, Fiona) are working with Helm chart people (Zach Leslie, Krajo) to work on how Helm chart documentation is presented to our customers. See (internal to Grafana Labs) Notes - Helm char docs Google file for notes.
@knylander-grafana - has this content been built out? and @osg-grafana - Will this be part of the new Helm docs approach?
@GrafanaWriter I'm going to schedule some time with @hedss to write the Tempo and GET doc for the helm chart for the Tempo 2.0 release. @osg-grafana should be a reviewer on this project.
See Loki blog post about Helm charts - https://grafana.com/blog/2022/12/19/the-only-helm-chart-you-need-for-grafana-loki-is-here/
New Helm portal is supposed to go live on Jan 9th. https://github.com/grafana/website/issues/10900#issuecomment-1355099192
@hedss and I met last week and started documenting how to use the tempo-distributed Helm chart. Heds found two issues with the Helm charts. He created a PR to address these issues ( https://github.com/grafana/helm-charts/issues/2111, https://github.com/grafana/helm-charts/issues/2112).
Unfortunately, we can't proceed with the doc until the above issue is resolved.
This issue also affects https://github.com/grafana/enterprise-traces/issues/403.
@joe-elliott has been working on the Tempo helm-charts repo to address some of the issues (not related to the issue Heds found).
I'm going to meet with Zach today to see what we can do to create a basic Helm cart doc for Tempo.
@zalegrala and I have created a draft Helm procedure for Tempo. I've been able to walk through the procedure and install the Helm chart itself and have the nodes start in the K8s cluster on my laptop. However, I have to work on storage configuration to get things working correctly.
@osg-grafana: @jdbaldry has a PR in the Tempo repo (https://github.com/grafana/tempo/pull/2096) to move the doc files so they mirror the Mimir repo's doc structure. This will let us have the Tempo Helm doc appear in the Helm doc portal.
@GrafanaWriter So far, we only have a single Helm page. The focus for now is to get the content to the site and the iterate and add more content.
Last Friday, Zach and I spent two hours reviewing the doc and updating. The PR was shared with the internal tempo and Helm channels for review.
Should we use the values.yaml or the custom.yaml file? After reading through the values.yaml file for the tempo-distributed helm chart, I updated the Helm doc PR with suggestions for using values.yaml. These changes are not merged, however the procedure itself works. I can test things, but I don't know how to verify that the Helm values are set properly.
Zach has also created a PR with Helm chart examples, including custom.yaml: https://github.com/grafana/tempo/pull/2124
This makes me think that the better option is to use the custom.yaml file. The values.yaml file is pretty complicated and would be nice to have as simple as possible.
The questions I have are:
- What is the best practice?
- If values are not set in customer.yaml (like the username and passwords), are those values defaulted to the ones present in values.yaml?
I am going to meet with @zalegrala this week to hopefully answer these questions.