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

Kibana provides a tool for config validation #96377

Open
mshustov opened this issue Apr 7, 2021 · 4 comments
Open

Kibana provides a tool for config validation #96377

mshustov opened this issue Apr 7, 2021 · 4 comments
Labels
enhancement New value added to drive a business result Feature:Configuration Settings in kibana.yml Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc triage_needed

Comments

@mshustov
Copy link
Contributor

mshustov commented Apr 7, 2021

Currently, Kibana provides no tools to validate a config before and when running the server.
The only available option is to start the server and get a validation error message when it crashes.

It might be a problem in some environments. As @pmuellr pointed out, Cloud has to duplicate validation rules for configuration, even though they aren't complete by definition. So it might turn out that when a user applies config changes on Cloud, a value can be accepted in Cloud UI, but Kibana will fail to start due to a validation error.

Kibana could provide config validation as an HTTP service or CLI tool so that a customer can provide a json/yml config for validation and get a list of errors back. We should talk to the Cloud team, what option is preferable for them.

@mshustov mshustov added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Configuration Settings in kibana.yml labels Apr 7, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@mshustov mshustov added the enhancement New value added to drive a business result label Apr 7, 2021
@mshustov
Copy link
Contributor Author

mshustov commented Apr 7, 2021

a suggestion from @pmuellr

My thought was that we’d run an instance of Kibana - one instance for every version of Kibana supported - that had a special plugin which exposed a config validation service - input is JSON/YAML config, output is “OK” | error object with validation error messages.
Riffing off that, if we did have something like that, we could let Kibana manage the allow-listing of cloud config keys as well, instead of the simpler allow-list processing done in cloud today.

@pgayvallet
Copy link
Contributor

Does anyone knows who we should reach on Cloud's side to begin the discussion? @joshdover @kobelb maybe?

@mshustov
Copy link
Contributor Author

mshustov commented Apr 8, 2021

@pgayvallet you can address this question to #cloud-stack-n-soln channel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Configuration Settings in kibana.yml Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc triage_needed
Projects
Development

No branches or pull requests

3 participants