Skip to content

values: simplify profile images to a single kubespawner_override.image#109

Open
aktech wants to merge 5 commits into
mainfrom
docs/values-image-map
Open

values: simplify profile images to a single kubespawner_override.image#109
aktech wants to merge 5 commits into
mainfrom
docs/values-image-map

Conversation

@aktech

@aktech aktech commented Jun 5, 2026

Copy link
Copy Markdown
Member

Documents and simplifies how the JupyterLab image is configured per profile.

Verified against jhub-apps (server-types.tsx + spawner_creation.py) and kubespawner override rules: a profile's kubespawner_override.image already feeds both the native spawn form and the jhub-apps image box. The single-choice profile_options.image block only restated that image (and rendered a one-item dropdown jhub-apps ignores), so it is removed. Adds a short image reference map covering hub, lab, and nebi-binary images.

Add an image reference map and per-site precedence notes so it is clear
which image launches each pod, how profile image overrides resolve, how
the nebi binary image is derived, and which tags bump_image_tags.py syncs.
@aktech aktech force-pushed the docs/values-image-map branch from 1762ed2 to 5126c2c Compare June 5, 2026 10:59
A profile's kubespawner_override.image already drives both the native
JupyterHub spawn form (override precedence) and the jhub-apps image box
(server-types reads kubespawner_override.image, ignores profile_options).
The single-choice profile_options block only re-stated that image and
rendered a useless one-item dropdown, so remove it and document the one
field that matters.
@aktech aktech changed the title docs: make values.yaml image references explicit and unambiguous values: simplify profile images to a single kubespawner_override.image Jun 5, 2026
aktech and others added 3 commits June 5, 2026 12:27
Name the jupyterhub.custom.profiles key explicitly and state that the
singleuser.image fallback applies only when that list is set to [].
Document each image where its value lives instead of a separate map block.
@aktech aktech marked this pull request as ready for review June 5, 2026 12:06
@pmeier pmeier self-requested a review June 5, 2026 14:36
Comment thread values.yaml
# Nebi binary image. An init container copies the nebi binary from this image
# into each JupyterLab pod, so the version is controlled at deploy time
# rather than baked into the JupyterLab image.
# nebi binary image (init container copies the binary into lab pods), NOT

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe not relevant here, but I still wanna ask: why does the lab image has a nebi baked in if we override it anyway?

Comment thread values.yaml
# Nebi binary image (repository:tag) copied into singleuser pods.
# If empty, derived as `<nebi.image.repository>:<nebi.image.tag>`.
# Override for the nebi binary image. Empty = derive from nebi.image.
nebi-image: ""

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: Maybe make this jupyterhub.nebi.image.tag and jupyterhub.nebi.image.pullPolicy?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants