Zero-to-jupyterhub-k8s: Incomplete reference documentation in schema.yaml

[ronlut]

Bug description

There are configuration options that doesn't appear in the documentation, although they are referenced multiple times across the different guides.
What I noticed missing:
singleuser.defaultUrl
singleuser.storage (and everything underneath)

Practically, I wanted to know what other configuration I can supply to extraVolumes and extraVolumeMounts.

Expected behaviour

Documentation should exist for those entries.

Actual behaviour

No Documentation.

How to reproduce

https://zero-to-jupyterhub.readthedocs.io/en/latest/reference/reference.html#singleuser

Thanks!

[welcome[bot]]

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.

You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:

Welcome to the Jupyter community! :tada:

[NerdSec]

I would be happy to pick this up, along with the security documentation that was discussed here.

However, I could not find the template used by the singleuser pod here. Generally speaking, there is no block diagram that explains the roles of the individual components too. Would it make sense to add something like an Architectural diagram in the docs too?

[meeseeksmachine]

This issue has been mentioned on Jupyter Community Forum. There might be relevant details there:

https://discourse.jupyter.org/t/restricted-psp-z2jh-fails-in-local-gitlab-oauth-workflow/6202/5

[consideRatio]

@NerdSec there is no Helm chart template for the singleuser pods, because these resources are dynamically created by the KubeSpawner Python class running as part of the JupyterHub server in the hub pod. KubeSpawner sends REST API requests to the k8s api-server to create pods just like a kubectl create command does.

@NerdSec I opened https://github.com/jupyterhub/zero-to-jupyterhub-k8s/issues/1801 to reflect the idea of documenting the components better.

Welcome :heart:

[consideRatio]

Another piece not documented in schema.yaml: https://github.com/jupyterhub/zero-to-jupyterhub-k8s/issues/1725

[NerdSec]

multiple times across the different guides

Hi @ronlut ,

Can you please provide a link/ref to where exactly this is referred?

[ronlut]

@NerdSec Sure, basically all over this page:
https://zero-to-jupyterhub.readthedocs.io/en/latest/customizing/user-storage.html
Specifically the volumes part that I was interested to learn more about is here

Regarding defaultUrl: here.

Thanks!

[consideRatio]

Closing this in favor of #1725