ray-project
[Feature] [apiserver] Provide migration doc from v1 to v2
Search before asking
- [x] I had searched in the issues and found no similar feature requirement.
Description
This issue is not a blocker item for v1.4 release, but I think it's good to have the doc prepared as early as possible, and add it to kuberay official doc. According to the kuberay community sync-up, we should have the doc well-prepared at apiserver dev stage-2.
There're a few items we could mention in the migration doc:
- Target customer
- Advanced and early customers who have used v1 in their production environment
- Difference explanation for v1 vs v2
- In the kuberay official doc (hosted on ray repo), we'll only record v2 but not v1
- Endpoint difference between v1 vs v2 (i.e. no longer provide grpc)
- Monitoring difference (i.e. key metrics)
- Migration general practice and example
- I don't imagine change for http request users, better to provide an easy example for grpc
- Dev progress track
- We don't plan to implement all features for v1.4 release
- Issue report
- Better to add tag v1 or v2, by default consider it v2
Use case
No response
Related issues
No response
Are you willing to submit a PR?
- [ ] Yes I am willing to submit a PR!
I don't have a preference if you want to put it in Google doc or kuberay repo readme, before we stage it into ray repo
@dentiny, I’m putting together a draft in this doc. Just keeping it simple for now — feel free to take a look and help verify the content when you have time. Thanks!
Hi @dentiny, Would it be okay if I submit a PR with the current draft of the migration doc? Thanks!