Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Update config examples to include Helm chart examples #4649

Open
knylander-grafana opened this issue Feb 1, 2025 · 0 comments
Open
Labels
type/docs Improvements or additions to documentation

Comments

@knylander-grafana
Copy link
Contributor

knylander-grafana commented Feb 1, 2025

Currently, the configuration examples in the Configure and Manage documentation work with the standard Tempo configuration. They aren't set up to use with tempo-distributed Helm chart.

Summary of issues

The configuration values don't map between Tempo's configuration and the equivalent values in the tempo-distributed Helm chart. We could add a column to the values table in the tempo-distributed Helm chart README to map these values as a stop-gap.

The tempo-distributed Helm chart README has a table with a list of values. Most of these values are missing descriptions of what they do.

Configuration doc in Tempo OSS doesn't include instructions for using the values.yaml for Helm.

Exploration

How do we fix it?

Determine the scope and prioritize work

  • Inventory of configuration options used in Tempo
  • Inventory of configuration options used in tempo-distributed Helm chart
  • Inventory of the examples that require updating for Helm chart usage
  • Prioritize the examples to update and create a list
  • Update the most important ones first
@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant