-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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.
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
docs: unhiding HTTP/3 and adding docs #15926
Changes from 1 commit
4f190b3
bb5e934
28a6ea6
f20546f
5257f2f
0bad720
8ccb35a
1702e4c
7c9c5fa
f4ccb1d
d388cb9
4ec4357
a95b39c
e4151ae
76f04d6
c2496a3
62d053a
e10ad5f
58aa631
d2ad3ab
aa1f4ef
4fa9c31
323f151
56e08a6
bdb245f
752afc7
e2ee7a9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,10 @@ | ||
.. _arch_overview_http3: | ||
|
||
phlax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
HTTP3 overview | ||
============== | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. whatever we keep in the api docs - i think a warning is warranted here too |
||
HTTP3 downstream | ||
================ | ||
---------------- | ||
|
||
HTTP/3 downstream support is still in Alpha, and should be used with caution. | ||
Outstanding issues required for HTTP/3 to go GA can be found | ||
|
@@ -14,7 +17,7 @@ ensuring the downstream transport socket is a QuicDownstreamTransport. | |
See example :repo:`downstream HTTP/3 configuration </configs/envoyproxy_io_proxy_http3_downstream.template.yaml1>` for example configuration. | ||
|
||
Note that the example configuration includes both a TCP and a UDP listener, and the TCP | ||
listener is advertising http/3 support via an alt-svc header. Advertising HTTP/3 is not necessary for | ||
listener is advertising http/3 support via an ``alt-svc header``. Advertising HTTP/3 is not necessary for | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i think the backticks should just be around |
||
in-house deployments where HTTP/3 is explicitly configured, but is needed for internet facing deployments | ||
where TCP is the default, and clients such as Chrome will only attempt HTTP/3 if it is explicitly advertised. | ||
|
||
|
@@ -24,7 +27,7 @@ use BPF by default if multiple worker threads are configured, but may require ro | |
(e.g. sudo setcap cap_bpf+ep). Envoy will log a warning on start-up if BPF is attempted and fails. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe also worth to mention that if BPF is not supported by the platform and multiple worker threads are configured, Envoy will route packets across workers by itself and log a warning of performance degrading, or something similar. |
||
|
||
HTTP3 upstream | ||
=============== | ||
-------------- | ||
|
||
HTTP/3 upstream support is still in Alpha, and should be used with caution. | ||
Outstanding issues required for HTTP/3 to go GA can be found | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
im wondering if this note should be a warning - and also thinking it might be better placed in docs/root/intro/arch_overview/http/http3.rst as its linked to from various places - feels a bit arbitrary to add it to one proto
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I lean towards the API because I think folks will actually read it here, where I'm less confident of folks reading the docs. Happy to make it a warning through.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
im wondering if this should make use of the
experimental
annotation that has just been addedagreed that there needs to be a warning here - but i would put the fuller explanation in the ref docs and point to that - as is done in most of the the api protos - mho