[Doc][Serve] gRPC Proxy Docs Changes #39140

GeneDer · 2023-08-31T00:37:53Z

Why are these changes needed?

Added usage doc and examples for using serve with gRPC. Also added related doc changes.

Related issue number

Closes #38703

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
- Release tests
- This PR is not tested :(

Signed-off-by: Gene Su <[email protected]>

doc/source/_toc.yml

Signed-off-by: Gene Su <[email protected]>

edoakes

@GeneDer I don't think we should organize HTTP & gRPC under "proxy guide" -- they're totally different features. The fact they're served by the same process is an implementation detail to the majority of users.

Let's leave the HTTP guide alone and put this new content as a replacement of the existing grpc guide.

doc/source/serve/advanced-guides/grpc-guide.md

Signed-off-by: Gene Su <[email protected]>

doc/source/serve/advanced-guides/direct-ingress.md

Signed-off-by: Gene Su <[email protected]>

angelinalg

Here is a batch of comments. I'm still working through the changes.

doc/source/serve/advanced-guides/grpc-guide.md

Signed-off-by: Gene Su <[email protected]>

doc/source/_toc.yml

Signed-off-by: Gene Su <[email protected]>

angelinalg

Hope these suggestions help. Feel free to ping me to talk through the comments that I suggested we discuss live.

doc/source/serve/advanced-guides/grpc-guide.md

doc/source/serve/production-guide/config.md

python/ray/serve/scripts.py

Signed-off-by: Gene Su <[email protected]>

Signed-off-by: Edward Oakes <[email protected]>

GeneDer · 2023-09-08T21:05:37Z

@edoakes can we get this merged in so I can raise the cherry pick PR🙏

Signed-off-by: Gene Su <[email protected]>

Signed-off-by: Edward Oakes <[email protected]>

Added usage doc and examples for using serve with gRPC. Also added related doc changes. Signed-off-by: Gene Su <[email protected]>

* [Doc][Serve] gRPC Proxy Docs Changes (#39140) Added usage doc and examples for using serve with gRPC. Also added related doc changes. Signed-off-by: Gene Su <[email protected]> * fix missed conflicit Signed-off-by: Gene Su <[email protected]> --------- Signed-off-by: Gene Su <[email protected]>

Added usage doc and examples for using serve with gRPC. Also added related doc changes. Signed-off-by: Jim Thompson <[email protected]>

Added usage doc and examples for using serve with gRPC. Also added related doc changes. Signed-off-by: Victor <[email protected]>

GeneDer added 13 commits August 29, 2023 23:22

[serve] add grpc docs

a83379b

Signed-off-by: Gene Su <[email protected]>

WIP

116df13

Signed-off-by: Gene Su <[email protected]>

linting

44a0d65

Signed-off-by: Gene Su <[email protected]>

completed grpc proxy docs

5844e2f

Signed-off-by: Gene Su <[email protected]>

linting

cd18253

Signed-off-by: Gene Su <[email protected]>

add grpc-guide to _toc.yml

88de99f

Signed-off-by: Gene Su <[email protected]>

update proto files

20d9196

Signed-off-by: Gene Su <[email protected]>

fix typo

c43256d

Signed-off-by: Gene Su <[email protected]>

polish

997e2b3

Signed-off-by: Gene Su <[email protected]>

Merge branch 'master' into grpc-proxy-docs

449ceec

Signed-off-by: Gene Su <[email protected]>

embed proto into the doc

7ac0b2e

Signed-off-by: Gene Su <[email protected]>

use more distinct tags

f761d6b

Signed-off-by: Gene Su <[email protected]>

rename doc_code directory

1dcecd0

Signed-off-by: Gene Su <[email protected]>

akshay-anyscale reviewed Sep 1, 2023

View reviewed changes

doc/source/_toc.yml Outdated Show resolved Hide resolved

GeneDer added 4 commits September 1, 2023 10:48

move grpc guide into advanced guides

269aead

Signed-off-by: Gene Su <[email protected]>

replace the existing grpc support with the new grpc proxy

b3a661f

Signed-off-by: Gene Su <[email protected]>

use the correct code path

ebd303c

Signed-off-by: Gene Su <[email protected]>

test updadte architectual diagram

75beb29

Signed-off-by: Gene Su <[email protected]>

edoakes reviewed Sep 1, 2023

View reviewed changes

doc/source/serve/advanced-guides/grpc-guide.md Outdated Show resolved Hide resolved

edoakes reviewed Sep 1, 2023

View reviewed changes

doc/source/serve/advanced-guides/grpc-guide.md Outdated Show resolved Hide resolved

edoakes reviewed Sep 1, 2023

View reviewed changes

doc/source/serve/advanced-guides/grpc-guide.md Outdated Show resolved Hide resolved

edoakes reviewed Sep 1, 2023

View reviewed changes

doc/source/serve/advanced-guides/grpc-guide.md Outdated Show resolved Hide resolved

GeneDer added 7 commits September 1, 2023 14:17

try to update architecture diagram again

529d771

Signed-off-by: Gene Su <[email protected]>

address some comments

c9f0a30

Signed-off-by: Gene Su <[email protected]>

add back user_defined_protos_pb2.py

1f31785

Signed-off-by: Gene Su <[email protected]>

fix grpc_guide.py path

72f22e9

Signed-off-by: Gene Su <[email protected]>

shorten tab titles

e342bc8

Signed-off-by: Gene Su <[email protected]>

using grpc proxy with serve config file

6388c3b

Signed-off-by: Gene Su <[email protected]>

WIP: trying to use a real example

8933485

Signed-off-by: Gene Su <[email protected]>

GeneDer requested a review from a team as a code owner September 6, 2023 16:27

GeneDer requested a review from angelinalg September 6, 2023 17:17

GeneDer changed the title ~~Grpc proxy docs~~ [Doc][Serve] gRPC Proxy Docs Changes Sep 6, 2023

Merge branch 'master' into grpc-proxy-docs

e8fe40f

Signed-off-by: Gene Su <[email protected]>

edoakes reviewed Sep 6, 2023

View reviewed changes

doc/source/serve/advanced-guides/direct-ingress.md Outdated Show resolved Hide resolved

GeneDer added 2 commits September 6, 2023 13:59

remove unused doc code

7034dee

Signed-off-by: Gene Su <[email protected]>

Merge branch 'master' into grpc-proxy-docs

d247530

Signed-off-by: Gene Su <[email protected]>

angelinalg reviewed Sep 6, 2023

View reviewed changes

makes better doc

be94aa0

Signed-off-by: Gene Su <[email protected]>

akshay-anyscale reviewed Sep 6, 2023

View reviewed changes

doc/source/_toc.yml Outdated Show resolved Hide resolved

move gRPC support higher in the advanced guides

5e10c6c

Signed-off-by: Gene Su <[email protected]>

angelinalg approved these changes Sep 7, 2023

View reviewed changes

GeneDer added 4 commits September 6, 2023 20:38

Merge branch 'master' into grpc-proxy-docs

c41fa0e

Signed-off-by: Gene Su <[email protected]>

fix grammars

3861240

Signed-off-by: Gene Su <[email protected]>

drop specific routing method in doc

9a1f702

Signed-off-by: Gene Su <[email protected]>

Merge branch 'master' into grpc-proxy-docs

25e2a19

Signed-off-by: Gene Su <[email protected]>

edoakes approved these changes Sep 8, 2023

View reviewed changes

Merge branch 'master' into grpc-proxy-docs

5760f38

Signed-off-by: Edward Oakes <[email protected]>

GeneDer and others added 4 commits September 8, 2023 14:19

Merge branch 'master' into grpc-proxy-docs

ddfb659

Signed-off-by: Gene Su <[email protected]>

Merge branch 'master' into grpc-proxy-docs

baff0ee

Signed-off-by: Gene Su <[email protected]>

Merge branch 'master' into grpc-proxy-docs

1ffa4d1

Merge branch 'master' into grpc-proxy-docs

bc5a414

Signed-off-by: Edward Oakes <[email protected]>

edoakes merged commit 7297a1e into ray-project:master Sep 9, 2023
15 of 35 checks passed

GeneDer added a commit to GeneDer/ray that referenced this pull request Sep 9, 2023

[Doc][Serve] gRPC Proxy Docs Changes (ray-project#39140)

1ac03b1

Added usage doc and examples for using serve with gRPC. Also added related doc changes. Signed-off-by: Gene Su <[email protected]>

GeneDer mentioned this pull request Sep 9, 2023

[Doc][Serve] gRPC Proxy Docs Changes (#39140) #39509

Merged

8 tasks

GeneDer deleted the grpc-proxy-docs branch September 9, 2023 04:07

vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023

[Doc][Serve] gRPC Proxy Docs Changes (ray-project#39140)

8c3766f

Added usage doc and examples for using serve with gRPC. Also added related doc changes. Signed-off-by: Victor <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc][Serve] gRPC Proxy Docs Changes #39140

[Doc][Serve] gRPC Proxy Docs Changes #39140

GeneDer commented Aug 31, 2023 •

edited

Loading

edoakes left a comment

angelinalg left a comment

angelinalg left a comment

GeneDer commented Sep 8, 2023

[Doc][Serve] gRPC Proxy Docs Changes #39140

[Doc][Serve] gRPC Proxy Docs Changes #39140

Conversation

GeneDer commented Aug 31, 2023 • edited Loading

Why are these changes needed?

Related issue number

Checks

edoakes left a comment

Choose a reason for hiding this comment

angelinalg left a comment

Choose a reason for hiding this comment

angelinalg left a comment

Choose a reason for hiding this comment

GeneDer commented Sep 8, 2023

GeneDer commented Aug 31, 2023 •

edited

Loading