Skip to content

Commit d84d777

Browse files
committed
add docs for profile_options
1 parent 5bba1c3 commit d84d777

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/docs/explanations/advanced-profiles-settings.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ profiles:
1818
description: Stable environment with 1 cpu / 1 GB ram
1919
access: all
2020
default: true
21+
profile_options:
22+
image:
23+
display_name: Image
24+
choices:
25+
default:
26+
display_name: quay.io/nebari/nebari-jupyterlab:latest
27+
default: true
28+
kubespawner_override:
29+
image: quay.io/nebari/nebari-jupyterlab:latest
30+
custom:
31+
display_name: <my-container-registry>/myOrg/my-custom-image:mytag
32+
kubespawner_override:
33+
image: <my-container-registry>/myOrg/my-custom-image:mytag
2134
kubespawner_override:
2235
cpu_limit: 1
2336
cpu_guarantee: 1
@@ -35,6 +48,8 @@ Each profile under `jupyterlab` is a named JupyterLab profile.
3548

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

51+
`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.
52+
3853
`kubespawner_override` field to define behavior as per the [KubeSpawner](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html) API.
3954

4055
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

0 commit comments

Comments
 (0)