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

Add values schema to the k6-operator helm chart #431

Closed
petar-cvit opened this issue Jul 24, 2024 · 3 comments · Fixed by #432
Closed

Add values schema to the k6-operator helm chart #431

petar-cvit opened this issue Jul 24, 2024 · 3 comments · Fixed by #432
Labels
enhancement New feature or request helm
Milestone

Comments

@petar-cvit
Copy link
Contributor

petar-cvit commented Jul 24, 2024

Feature Description

Hey, could we add the values.schema.json to the helm chart? We are working on a tool that renders UIs for helm charts based on their schema and would love to support the k6-operator chart as well.

Suggested Solution (optional)

Add the values.schema.json to the chart. Initially, the schema can cover just the basic set of fields, so it is easier to maintain.

Already existing or connected issues / PRs (optional)

No response

@petar-cvit petar-cvit added the enhancement New feature or request label Jul 24, 2024
@yorugac
Copy link
Collaborator

yorugac commented Jul 26, 2024

Hi @petar-cvit, sounds great! Thanks for the issue. And if the schema can be used in your tool, then of course, we can add it.

The one thing that is worrying here is how to maintain this long-term 😅 I cannot promise additional commitment to maintaining this myself. Can I ask you, if the values.schema.json needs to be written by hand or there's another way? I.e. could this schema be generated somehow? I've just found this tool:
https://github.com/losisin/helm-values-schema-json
It seems to work with comment annotations... Would it be sufficient to update the schema file with CI?

I think it'd be "ideal" if it were possible to just re-generate the schema when someone makes a change to the Chart 🤔

@petar-cvit
Copy link
Contributor Author

petar-cvit commented Jul 26, 2024

Hey @yorugac, we did a similar thing with cerbos. Here is the PR adding a schema on their repo https://github.com/cerbos/cerbos/pull/2230/files

They used https://github.com/dadav/helm-schema to generate the schema from the values file based on the comments (the same way you described it). If you want, I can look into setting it up on your repo and open a PR

@yorugac
Copy link
Collaborator

yorugac commented Jul 26, 2024

@petar-cvit, yes, I think that'd be great! Make command to generate the schema that can be called then in CI 👍

@yorugac yorugac added this to the 0.17 milestone Aug 12, 2024
@yorugac yorugac added the helm label Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request helm
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants