Update the commands of the helm post install notes to map helm chart fields correctly: #2008
+3
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…fields correctly:
When binder is installed with the helm chart, and is only exposed via a ClusterIP Kubernetes Service,
the `kubectl` commands of the post install notes are erroring in subtle ways:
~~~
kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "fullname" . }}" -o jsonpath="{.items[0].metadata.name}"
~~~
can fail because {{ template "fullname" . }} does not always match the hardcoded labels we set
in https://github.com/jupyterhub/binderhub/blob/33bcc37c2fd18573d19a13c5a41b1d8d563c3663/helm-chart/binderhub/templates/deployment.yaml#L20
and
~~~
kubectl port-forward $POD_NAME 8080:{{ .Values.service.externalPort }}
~~~
always fails because we don't expose set or expose an externalPort field in https://github.com/jupyterhub/binderhub/blob/33bcc37c2fd18573d19a13c5a41b1d8d563c3663/helm-chart/binderhub/values.yaml#L34
This commit fixes the two errors by using immutables, non-overridables values from the helm templates.
|
To reproduce the issue, and verify the fix, it should be enough to change in and install the helm chart following https://binderhub.readthedocs.io/en/latest/contribute.html#develop-helm-chart |
rgaiacs
approved these changes
Aug 25, 2025
|
@rgaiacs thanks for taking the time to review this, is there anything I need to do to get this merged ? |
I would like a review of another contributor as I'm a beginner regarding Kubernetes. |
|
Thanks! |
consideRatio
pushed a commit
to jupyterhub/helm-chart
that referenced
this pull request
Sep 3, 2025
jupyterhub/binderhub#2008 Merge pull request #2008 from EmmanuelKasper/main
|
Thanks for the review ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When binder is installed with the helm chart, and is only exposed via a ClusterIP Kubernetes Service, the
kubectlcommands of the post install notes are erroring in subtle ways:can fail because
{{ template "fullname" . }}does not always match the hardcoded labels we set inbinderhub/helm-chart/binderhub/templates/deployment.yaml
Line 20 in 33bcc37
and
always fails because we don't expose set or expose an externalPort field in
binderhub/helm-chart/binderhub/values.yaml
Line 34 in 33bcc37
This commit fixes the two errors by using immutables, non-overridables values from the helm templates.