Skip to content

Cortex Configuration Validation Tool #6426

Open
@CharlieTLe

Description

Is your feature request about a problem? Please describe.

Validating the Cortex configuration can be tricky. Users should be able to make changes to the configuration file without worrying about syntax or semantics. Before using the file at runtime, Cortex should check that the values are valid.

Describe the solution you’d like:

  • Basic configuration validation checks.
  • Ensure proper flags are set together.
  • Print basic and advanced options.
  • Print the configuration with sensitive values redacted to allow for sharing safely without leaking confidential data.

Describe alternatives you’ve considered:

Writing documentation for every possible configuration combination and validating this would be a lot of work and would get outdated as the configuration and functionality change. If the tooling itself is checked into the repo with Cortex, it would make validating behavior better tested and understood over time.

Additional context:

This was brought up in our last Cortex Community meeting, and many people on the calls thought this would be helpful for the community.

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions