Skip to content

[DOC] Update config examples to include Helm chart examples (also Rhythm updates) #4649

@knylander-grafana

Description

@knylander-grafana

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    type/docsImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions