Skip to content
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

Jump to bottom

docs: fix bullet lists in profile_list #670

Merged
merged 1 commit into from
Nov 9, 2022
Merged

docs: fix bullet lists in profile_list #670

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 10 additions & 8 deletions kubespawner/spawner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1599,19 +1599,21 @@ def _validate_image_pull_secrets(self, proposal):
- `kubespawner_override`: a dictionary with overrides to apply to the KubeSpawner
settings. Each value can be either the final value to change or a callable that
take the `KubeSpawner` instance as parameter and return the final value. This can
be further overridden by 'profile_options'
- 'profile_options': A dictionary of sub-options that allow users to further customize the
be further overridden by `profile_options`
- `profile_options`: A dictionary of sub-options that allow users to further customize the
selected profile. By default, these are rendered as a dropdown with the label
provided by `display_name`. Items should have a unique key representing the customization,
and the value is a dictionary with the following keys:
- 'display_name': Name used to identify this particular option
- 'choices': A dictionary containing list of choices for the user to choose from

- `display_name`: Name used to identify this particular option
- `choices`: A dictionary containing list of choices for the user to choose from
to set the value for this particular option. The key is an identifier for this
choice, and the value is a dictionary with the following possible keys:
- 'display_name': Human readable display name for this choice.
- 'default': (optional Bool) True if this is the default selected choice
- 'kubespawner_override': A dictionary with overrides to apply to the KubeSpawner
settings, on top of whatever was applied with the 'kubespawner_override' key

- `display_name`: Human readable display name for this choice.
- `default`: (optional Bool) True if this is the default selected choice
- `kubespawner_override`: A dictionary with overrides to apply to the KubeSpawner
settings, on top of whatever was applied with the `kubespawner_override` key
for the profile itself. The key should be the name of the kubespawner setting,
and value can be either the final value or a callable that returns the final
value when called with the spawner instance as the only parameter. The callable
Expand Down