Skip to content

add docs for profile_options #559

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

Merged
merged 3 commits into from
Feb 20, 2025
Merged

add docs for profile_options #559

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d84d777
add docs for profile_options
Adam-D-Lewis Feb 5, 2025
f3b71ad
update example
Adam-D-Lewis Feb 10, 2025
2e269f7
prettier fix
Adam-D-Lewis Feb 10, 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
15 changes: 15 additions & 0 deletions docs/docs/explanations/advanced-profiles-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@ profiles:
description: Stable environment with 1 cpu / 1 GB ram
access: all
default: true
profile_options:
image:
display_name: Image
choices:
default:
display_name: quay.io/nebari/nebari-jupyterlab:latest
default: true
kubespawner_override:
image: quay.io/nebari/nebari-jupyterlab:latest
custom:
display_name: <my-container-registry>/myOrg/my-custom-image:mytag
kubespawner_override:
image: <my-container-registry>/myOrg/my-custom-image:mytag
kubespawner_override:
cpu_limit: 1
cpu_guarantee: 1
Expand All @@ -35,6 +48,8 @@ Each profile under `jupyterlab` is a named JupyterLab profile.

`description` is a description of the profile that will be displayed to users.

`profile_options` makes it possible to set various sub-options per profile. See the [Kubespawner docs](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#kubespawner.KubeSpawner.profile_list) for more info.

`kubespawner_override` field to define behavior as per the [KubeSpawner](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html) API.

It is possible to control which users have access to which JupyterLab profiles. Each profile has a field named `access` which can be set to `all` (default if omitted), `yaml`, or
Expand Down
Loading