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

Rewrite help for Kubespawner.cmd #502

Merged
merged 3 commits into from
May 2, 2021
Merged

Rewrite help for Kubespawner.cmd #502

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
641eb09
Rewrite docs for Kubespawner.cmd
manics Apr 30, 2021
898fd4b
Use capitals for container instructions
manics May 1, 2021
0df6123
Apply suggestions from code review
consideRatio May 1, 2021
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
16 changes: 6 additions & 10 deletions kubespawner/spawner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,18 +403,14 @@ def _namespace_default(self):
minlen=0,
config=True,
help="""
The command used for starting the single-user server.
The command used to start the single-user server.

Provide either a string or a list containing the path to the startup script command. Extra arguments,
other than this path, should be provided via `args`.
Either
- a string containing a single command or path to a startup script
- a list of the command and arguments
- `None` (default) to use the Docker image's `CMD`

This is usually set if you want to start the single-user server in a different python
environment (with virtualenv/conda) than JupyterHub itself.

Some spawners allow shell-style expansion here, allowing you to use environment variables.
Most, including the default, do not. Consult the documentation for your spawner to verify!

If set to `None`, Kubernetes will start the `CMD` that is specified in the Docker image being started.
If `cmd` is set, it will be augmented with `spawner.get_args(). This will override the `CMD` specified in the Docker image.
""",
)

Expand Down