REP: Ray Kubectl Plugin #52
Conversation
andrewsykim
force-pushed
the
ray-kubectl-plugin
branch
from
9b93651
to
305a527
Compare
|
|
||
| ## Implementation Details | ||
|
|
||
| The kubectl plugin will be developed in the cli directory, replacing the current KubeRay CLI. While the kubectl plugin will overlap with the existing KubeRay CLI in some ways (especially in managing KubeRay cluster), it will go further by enhancing day-to-day operations with Ray clusters. These enhancements include authenticating to clusters, establishing local sessions, submitting jobs, and scaling clusters. In addition, the kubectl plugin will not depend on the KubeRay API server, making it viable for a larger audience of KubeRay users. |
There was a problem hiding this comment.
I am OK with deprecating the existing KubeRay CLI. I have never heard of any user using it.
| $ kubectl ray job submit --cluster my-cluster --image=image:tag -- python job.py | ||
| ``` | ||
|
|
||
| ### Ray Session - Interactive Client / Dashboard |
There was a problem hiding this comment.
We should reconsider whether we want to support port forwarding for the Ray client or not. It has not been actively maintained for more than a year. The Ray community doesn't recommend users use it. We have had some internal discussions about building a Ray client 2.0 to solve its stability issues, but it has not happened yet.
|
|
||
| MVP Scope: | ||
| * `kubectl ray cluster get|list` | ||
| * `kubectl ray cluster get|list` |
There was a problem hiding this comment.
This is a duplicate of the line above.
| The CLI will extend kubectl using kubectl’s plugin mechanism. See [Extend kubectl with plugins](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) for more details. | ||
|
|
||
| MVP Scope: | ||
| * `kubectl ray cluster get|list` |
There was a problem hiding this comment.
Do we need list? kubectl doesn't support list. Maybe we can use
kubectl ray get cluster # list all RayCluster CRs
kubectl ray get cluster $CR_NAME # Get the RayCluster CR
| * `kubectl ray cluster session` | ||
| * `kubectl ray cluster dashboard` | ||
| * `kubectl ray cluster logs` | ||
|
|
There was a problem hiding this comment.
We can also support get RayJob.
There was a problem hiding this comment.
added to future scope for now
| ### Ray Job Submissions (using RayJob) | ||
|
|
||
| ``` | ||
| $ kubectl ray job submit --cluster my-cluster --image=image:tag -- python job.py |
There was a problem hiding this comment.
Would it be a pre-requisite for my-cluster to pre-exist before job submission? Or could this command create the cluster if not available, then submit?
There was a problem hiding this comment.
Would it be a pre-requisite for my-cluster to pre-exist before job submission?
Currently, yes.
Or could this command create the cluster if not available, then submit?
This is planned for future work. The MVP only includes reading operations for the Kubernetes API server; the writing operations are not included in the MVP.
There was a problem hiding this comment.
My intention for the kubectl ray job submit command is that it will create a RayJob. If you don't speify --cluster, the RayJob will be configured to create a new RayCluster for the job.
There was a problem hiding this comment.
As @kevin85421 said this is not in MVP scope and will be developed after the initial kubectl ray cluster functionality
There was a problem hiding this comment.
Similar requests from Slack
https://ray-distributed.slack.com/archives/C02GFQ82JPM/p1717058981028339
|
cc @jjyao: Could we merge this PR, or do we still have another process to complete? |
Signed-off-by: Andrew Sy Kim <[email protected]>
andrewsykim
force-pushed
the
ray-kubectl-plugin
branch
from
305a527
to
a302f1a
Compare
|
Something might be useful: |
Add REP for a Ray Kubectl Plugin