Skip to content

Unconditionally put servername in annotations #887

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+7 −5
Open

Unconditionally put servername in annotations #887

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9faa29c
Unconditionally put servername in annotations
yuvipanda Apr 7, 2025
f3f6016
Put servername only on pod
yuvipanda Apr 7, 2025
1d4ae2c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions kubespawner/spawner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2166,11 +2166,11 @@ def _build_pod_labels(self, extra_labels):

def _build_common_annotations(self, extra_annotations):
# Annotations don't need to be escaped
annotations = {'hub.jupyter.org/username': self.user.name}
if self.name:
annotations['hub.jupyter.org/servername'] = self.name
annotations["hub.jupyter.org/kubespawner-version"] = __version__
annotations["hub.jupyter.org/jupyterhub-version"] = jupyterhub.__version__
annotations = {
'hub.jupyter.org/username': self.user.name,
"hub.jupyter.org/kubespawner-version": __version__,
"hub.jupyter.org/jupyterhub-version": jupyterhub.__version__,
}
Comment on lines -2169 to +2173
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this change we wouldn't get the servername annotation on PVCs etc

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PVCs are complicated because the template can be changed to create a shared or unshared volume.


annotations.update(extra_annotations)
return annotations
Expand Down Expand Up @@ -2285,6 +2285,8 @@ async def get_pod_manifest(self):
annotations = self._build_common_annotations(
self._expand_all(self.extra_annotations)
)
# Unconditionally put servername on the pods
annotations['hub.jupyter.org/servername'] = self.name
Comment on lines 2285 to +2289
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the unconditional assignment following right after calling _build_common_annotations should only be relevant if self.extra_annotations were declaring another hub.jupyter.org/servername, which would have a blank string value or similar.

        annotations = self._build_common_annotations(
            self._expand_all(self.extra_annotations)
        )
        # Unconditionally put servername on the pods
        annotations['hub.jupyter.org/servername'] = self.name

I wonder if its really a kubespawner issue, or z2jh / end-user issue based on this.


return make_pod(
name=self.pod_name,
Expand Down