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.

Sign up for GitHub

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

Jump to bottom

charts: Add a values schema #1926

Open
illume opened this issue Apr 24, 2024 · 1 comment · May be fixed by #2025
Open

charts: Add a values schema #1926

illume opened this issue Apr 24, 2024 · 1 comment · May be fixed by #2025
Assignees
@knrt10
Labels
helm Related to helm and app-catalog security
Milestone
v0.25.0

Comments

@illume
Copy link
Contributor

illume commented Apr 24, 2024 •
edited

It was mentioned here #1897 to take a look at the bitnami charts for postgresql.

The have some docs https://github.com/bitnami/charts/blob/main/bitnami/postgresql/values.yaml#L1635
Also they have a values.schema.json https://github.com/bitnami/charts/blob/main/bitnami/postgresql/values.schema.json

So this issue is about adding a values.schema.json JSON schema file.
https://helm.sh/docs/topics/charts/#schema-files
https://medium.com/@hans.knechtions/6-tips-to-writing-a-great-helm-chart-35899b00a6cc

This would help people use the headlamp chart, by validating the user input.

Additionally, on artifact hub one of the quality badges is missing because it does not use a values schema.

image
@illume illume added the helm Related to helm and app-catalog label Apr 24, 2024
@illume illume mentioned this issue Apr 24, 2024
Merged
@illume illume changed the title charts: Add a schema charts: Add a values schema May 22, 2024
@knrt10 knrt10 self-assigned this Jun 3, 2024
@knrt10
Copy link
Contributor

knrt10 commented Jun 3, 2024

Thank you for creating the issue. Working on this

knrt10 added a commit that referenced this issue Jun 3, 2024
@knrt10
charts: Add schema for values.yaml
85b775b 
Charts did not have defined structure for Headlamp value configurations.
Now we have defined schema for the same which will run while linting,
installing, upgrading or templating the helm charts.

Fixes: #1926
Signed-off-by: Kautilya Tripathi <ktripathi@microsoft.com>
@knrt10 knrt10 linked a pull request Jun 3, 2024 that will close this issue
Open
@knrt10 knrt10 added this to the v0.25.0 milestone Jun 3, 2024
knrt10 added a commit that referenced this issue Jun 3, 2024
@knrt10
charts: Add schema for values.yaml
d52ff1c 
Charts did not have defined structure for Headlamp value configurations.
Now we have defined schema for the same which will run while linting,
installing, upgrading or templating the helm charts.

Fixes: #1926
Signed-off-by: Kautilya Tripathi <ktripathi@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@knrt10 knrt10

Labels
helm Related to helm and app-catalog security
Projects
None yet
Milestone
v0.25.0
Development

Successfully merging a pull request may close this issue.

charts: Add schema for values.yaml headlamp-k8s/headlamp
2 participants
@illume @knrt10