Add schema.yaml for helm3 compliant chart validation #1331
Conversation
| @@ -6,7 +6,7 @@ type: Opaque | |||
| data: | |||
| {{- $values := dict "config" dict }} | |||
| {{- $cfg := .Values.config }} | |||
| binder.hub-token: {{ .Values.jupyterhub.hub.services.binder.apiToken | b64enc | quote }} | |||
| binder.hub-token: {{ .Values.jupyterhub.hub.services.binder.apiToken | required "jupyterhub.hub.services.binder.apiToken must be explicitly set!" | b64enc | quote }} | |||
There was a problem hiding this comment.
Note that this would just error when b64enc receives a null value with a less obvious error message, so adding this required pipe isn't a breaking change.
I want to consider if we can generate these tokens in the future like in z2jh, but for now, this is what we do.
consideRatio
force-pushed
the
pr/add-json-schema
branch
from
dd4e653
to
41431e0
Compare
| @@ -120,7 +117,7 @@ spec: | |||
| {{- end }} | |||
| {{- end }} | |||
| {{- with .Values.extraEnv }} | |||
| {{- . | toYaml | nindent 8 }} | |||
| {{- include "jupyterhub.extraEnv" . | nindent 8 }} | |||
There was a problem hiding this comment.
This couples a helper function from the jupyterhub chart here. We aren't doing that elsewhere in our chart. Can we put this in a different PR so we can discuss that separately?
There was a problem hiding this comment.
Reverted in a4c368a!
There was a problem hiding this comment.
The tests of relevance succeeded, but there was an intermittent failure with polling zenodo - restarted jobs.
|
Thanks, @consideRatio! |
|
I think this PR broke the helm chart publishing action. It looks like the fix would be to install a Python yaml library. Do you want to follow up this PR with a fix? |
Closes #1329 by mimicing jupyterhub/zero-to-jupyterhub-k8s#2033 that converts a schema.yaml file into values.schema.json before publishing and package it with the Helm chart so
helmautomatically can perform validation logic wheneverhelm template,helm installorhelm upgradeis run.My process to create the schema.yaml file was to look in values.yaml and add schema entries for everything there. I copied various schema.yaml entries from z2jh's schema.yaml file to save me some work, but a lot of descriptions is still just having a TODO note. I consider it out of scope for this PR to also write descriptions for everything in the schema.yaml. The descriptions are currently not used anyhow, but they can be used to generate a configuration reference in the future.
I've tried this schema against mybinder.org's Helm chart, adjusted the schema by adding
hpaandnetworkPolicyto not break mybinder.org-deploy and because these configuration options may very well be upstreamed to BinderHub itself.