search

jupyterhub / zero-to-jupyterhub-k8s

Helm Chart & Documentation for deploying JupyterHub on Kubernetes
https://zero-to-jupyterhub.readthedocs.io
Other
1.5k stars 788 forks source link

Document how to select a choice different from list of available choices in profileList #3152

Open echarles opened 1 year ago

echarles commented 1 year ago

Once https://github.com/jupyterhub/kubespawner/pull/735#issuecomment-1622767400 is merged and release, and that Z2jh uses that new releases, it will be good to document (or mention in the doc) how to allow the selection a choice different from list of available choices in profileList

(see @yuvipanda comment on https://github.com/jupyterhub/kubespawner/pull/735#issuecomment-1622767400)

consideRatio commented 1 year ago

👍

When doing this, we should link out to kubespawners docs and lean on them to a large extent and make sure they are considered the source of truth.

My experience with documentating authenticator config in z2jh/tljh is that its unsustainable and too much work to keep them updated in multiple places, so that we should do our best to avoid repeating ourselves and mitigating issues if one text gets outdated.

echarles commented 1 year ago

@consideRatio Makes sense.

z2jkh should just point to the reference kubespawner docs, maybe giving simple examples to illustrate how to configure the helm deployment. However, in https://github.com/jupyterhub/kubespawner/pull/735/files, I don't see any doc for that.

Talking about tljh, as that feature is developed in kubespawner, it is not applicable. This makes me think to a conversation I had at JupyterCon with @MridulS about moving some of the user form implementation/logic from kubespawner to juyterhub core IIRC.

consideRatio commented 1 year ago

@echarles there is documentation generated based on the help string for the profile_list configuration, see https://jupyterhub-kubespawner--735.org.readthedocs.build/en/735/spawner.html#kubespawner.KubeSpawner.profile_list for a preview.

Overall, that is what we need to lean on. singleuser.profileList is after all a direct mapping to configure that, and could also be configured via hub.config.KubeSpawner.profile_list or via hub.extraConfig.my_custom_python_config = "c.KubeSpawner.profile_list = ..."