Skip to content

Commit

Permalink
Merge pull request #502 from manics/cmd-doc
Browse files Browse the repository at this point in the history
Rewrite help for Kubespawner.cmd
  • Loading branch information
consideRatio authored May 2, 2021
2 parents 98bb577 + 0df6123 commit c82b354
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions kubespawner/spawner.py
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

0 comments on commit c82b354

Please sign in to comment.