Skip to content

docs: add note about the buffer filter & upgrades#15790

Merged
mattklein123 merged 5 commits intoenvoyproxy:mainfrom
rgs1:docs-upgrades
Mar 31, 2021
Merged

docs: add note about the buffer filter & upgrades#15790
mattklein123 merged 5 commits intoenvoyproxy:mainfrom
rgs1:docs-upgrades

Conversation

@rgs1
Copy link
Copy Markdown
Member

@rgs1 rgs1 commented Mar 31, 2021

The buffer filter breaks web socket upgrades, so add a note about
this.

Signed-off-by: Raul Gutierrez Segales rgs@pinterest.com

The buffer filter breaks websocket upgrades, so add a note about
this.

Signed-off-by: Raul Gutierrez Segales <rgs@pinterest.com>
@rgs1
Copy link
Copy Markdown
Member Author

rgs1 commented Mar 31, 2021

cc: @alyssawilk

Copy link
Copy Markdown
Contributor

@alyssawilk alyssawilk left a comment

Choose a reason for hiding this comment

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

thanks for clarifying this for the next person who runs into this :-)

:ref:`filters <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.UpgradeConfig.filters>`
for the given upgrade type, up to and including only using the router filter to send the HTTP
data upstream.
data upstream. Note that the :ref:`Buffer filter <envoy_v3_api_msg_extensions.filters.http.buffer.v3.Buffer>` breaks
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/the Buffer filter breaks upgrades/buffering is generally not compatible with upgrades/

I think you could arguably have an H2 upgrade that worked with the buffer filter but it would be unusual, not the norm.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated -- thanks!

@alyssawilk alyssawilk self-assigned this Mar 31, 2021
Raul Gutierrez Segales added 2 commits March 31, 2021 12:47
Signed-off-by: Raul Gutierrez Segales <rgs@pinterest.com>
Signed-off-by: Raul Gutierrez Segales <rgs@pinterest.com>
Copy link
Copy Markdown
Contributor

@alyssawilk alyssawilk left a comment

Choose a reason for hiding this comment

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

Nice! LGTM modulo 1.5 remaining nits :-)

Raul Gutierrez Segales added 2 commits March 31, 2021 12:57
Fix
Signed-off-by: Raul Gutierrez Segales <rgs@pinterest.com>
Signed-off-by: Raul Gutierrez Segales <rgs@pinterest.com>
@mattklein123 mattklein123 merged commit 904ab01 into envoyproxy:main Mar 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants