OpenLiberty / OpenLiberty/docs

gRPC examples and clarifications

Open
#5,463 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
14
Forks
58
Avg merge
4m
Merged PRs (30d)
35

Description

During the development of the gRPC topic in #2698 @hutchig identified a few enhancements that might improve the topic but that did not constitute a stop-ship to publish it. Recording them here so we can add to the topic in a future release.

  • What is not clear in the docs is if the (server) grpc feature enables 100% of the grpcClient feature's features. (i.e. a server can always also be a client without having grpcClient in the server.xml.)

  • Regarding 'it becomes accessible to remote gRPC clients on the configured HTTP ports.' I think it might help to have an example to clarify, if there is any, gRPC bits of the port config and if so how to do this.

  • Does having "headersToPropagate="cookie"." have an effect to 'propagate security tokens?

  • provide some further snippets of relevant actual config elements that fit in with the text.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the gRPC topic referenced in issue #2698 and review its current explanations of grpc and grpcClient, HTTP ports, headersToPropagate, and configuration. Done means answering the four listed questions and adding relevant, accurate configuration examples and snippets to the topic.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.