-
Notifications
You must be signed in to change notification settings - Fork 303
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.
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
Conversation
Co-authored-by: Erik Sundell <[email protected]>
FYI I picked the original |
kubespawner/spawner.py
Outdated
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. | ||
`cmd` will be passed to the image's `ENTRYPOINT`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cmd
will be passed to the image'sENTRYPOINT
.
I think it is a problematic statement for two reasons.
- It only influence the k8s Pod rather than the Dockerfile or similarly.
- It actually configures the k8s container's
args
(like Dockerfile's CMD) rather thancommand
(like Dockerfile's ENTRYPOINT).
A related confusion is described in #493.
I think we can make small progressions and I find this change PR mergable if we just update this to reference that it implies setting the k8s Pod's container's args
where the command
won't be set. This also implies that any Dockerfile's ENTRYPOINT will always be respected as kubespawner never sets command
. Here is related documentation about that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
THANK YOU FOR YOUR WORK ON THIS @manics!! ❤️
I forgot to convey that part before!
Co-authored-by: Simon Li <[email protected]>
I'll go for a merge on this as it is and work on an entrypoint traitlet PR. |
Whilst working on jupyterhub/zero-to-jupyterhub-k8s#2138 I noticed the current description for
cmd
is mostly copied from the parent class and is a bit confusing. I've attempted to simplify it.