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

Jump to bottom

[Serve] Document WebSocket support in Serve #36735

Merged
merged 12 commits into from
Jun 26, 2023
Merged

[Serve] Document WebSocket support in Serve #36735

merged 12 commits into from
Jun 26, 2023

Conversation

shrekris-anyscale
Copy link
Contributor

@shrekris-anyscale shrekris-anyscale commented Jun 22, 2023 •
edited
Loading

Why are these changes needed?

#35953 added experimental support for WebSockets to Serve. This change documents the feature.

Link to updated documentation: https://anyscale-ray--36735.com.readthedocs.build/en/36735/serve/http-guide.html#websockets

Related issue number

N/A

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
      • All code added for this documentation is tested in CI.

@shrekris-anyscale
Create doc code for websockets
b2c398e 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Add noqa
8338fbc 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Change ws_handler to echo
17b1843 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Fix log message
2ed2ab9 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Rename websockets.py to websockets_example.py
d28f425 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Finish section about websockets
d81234a 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Merge branch 'master' of github.com:ray-project/ray into document_web…
0df37fc 
…sockets
@shrekris-anyscale
Remove tip
5527d1e 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
edoakes
edoakes approved these changes Jun 23, 2023
View reviewed changes
Copy link
Contributor

@edoakes edoakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you :)

@shrekris-anyscale
Fix second code snippet
beeb542 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
@shrekris-anyscale
Merge branch 'master' of github.com:ray-project/ray into document_web…
07d373b 
…sockets
@shrekris-anyscale
Fix type hint
ca4b3c8 
Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
angelinalg
angelinalg approved these changes Jun 23, 2023
View reviewed changes
Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great writing!

doc/source/serve/http-guide.md Outdated Show resolved Hide resolved
@shrekris-anyscale @angelinalg
Update doc/source/serve/http-guide.md
a9e9fd6 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: shrekris-anyscale <92341594+shrekris-anyscale@users.noreply.github.com>
@shrekris-anyscale
Copy link
Contributor Author

shrekris-anyscale commented Jun 24, 2023 •
edited
Loading

All tests are passing.

@architkulkarni @edoakes This change is ready to merge.

@architkulkarni architkulkarni merged commit 0bae448 into ray-project:master Jun 26, 2023
@akshay-anyscale akshay-anyscale mentioned this pull request Jul 21, 2023
Closed
8 tasks
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
@shrekris-anyscale @angelinalg @arvind-chandra
[Serve] Document WebSocket support in Serve (ray-project#36735)
2d9d894 
ray-project#35953 added experimental support for WebSockets to Serve. This change documents the feature.

Link to updated documentation: https://anyscale-ray--36735.com.readthedocs.build/en/36735/serve/http-guide.html#websockets

---------

Signed-off-by: Shreyas Krishnaswamy <shrekris@anyscale.com>
Signed-off-by: shrekris-anyscale <92341594+shrekris-anyscale@users.noreply.github.com>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edoakes edoakes edoakes approved these changes

@angelinalg angelinalg angelinalg approved these changes

@sihanwang41 sihanwang41 Awaiting requested review from sihanwang41

@zcin zcin Awaiting requested review from zcin zcin is a code owner

@architkulkarni architkulkarni Awaiting requested review from architkulkarni

Assignees

@sihanwang41 sihanwang41

@edoakes edoakes

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@shrekris-anyscale @edoakes @angelinalg @architkulkarni @sihanwang41