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

Cortex Configuration Validation Tool #6426

Open
CharlieTLe opened this issue Dec 14, 2024 · 0 comments
Open

Cortex Configuration Validation Tool #6426

CharlieTLe opened this issue Dec 14, 2024 · 0 comments

Comments

@CharlieTLe
Copy link
Member

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.

@dosubot dosubot bot added the type/feature label Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant