docs: ext-proc #3608
docs: ext-proc #3608
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3608 +/- ##
==========================================
- Coverage 68.34% 68.32% -0.02%
==========================================
Files 170 170
Lines 20707 20707
==========================================
- Hits 14152 14148 -4
- Misses 5532 5535 +3
- Partials 1023 1024 +1 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Guy Daich <[email protected]>
|
/retest |
|
|
||
| Create a new EnvoyExtensionPolicy resource to configure the external processing service. This EnvoyExtensionPolicy targets the HTTPRoute | ||
| "myApp" created in the previous step. It calls the GRPC external processing service "grpc-ext-proc" on port 9002 for | ||
| processing. The `processingMode` struct defines that headers of requests and responses will be sent to the external processing server. |
There was a problem hiding this comment.
may a line in here saying, by default all request headers are sent, but in this example we are sending none would be helpful
Signed-off-by: Guy Daich <[email protected]>
| processing. The `processingMode` struct defines that headers of requests and responses will be sent to the external processing server. | ||
| processing. | ||
|
|
||
| By default, requests and responses are not sent to the external processor. The `processingMode` struct is used to define what should be sent to the external processor. |
There was a problem hiding this comment.
There was a problem hiding this comment.
maybe we should explicitly mention body so readers like me dont confuse it with headers
There was a problem hiding this comment.
yes, but not in EG. We wanted to simplify the API (avoid explicitly mentioning header processing modes) while still supporting opt-out for request and/or response processing and explicit body processing mode configuration.
To accomodate this, the API currently behaves like this:
- if request/response is set to an empty struct - headers are sent.
- if request/response is configured with a body - headers and body are sent.
- is request/response is not configured at all - opt-out of calling the processor.
I can extend the example to also include body forwarding in one of the flows to help explain how this works.
There was a problem hiding this comment.
thanks for explaining this, in that case, can we update above text mentioning that request headers will be sent ?
Signed-off-by: Guy Daich <[email protected]>
* docs: ext-proc Signed-off-by: Guy Daich <[email protected]> * elaborate on processing mode Signed-off-by: Guy Daich <[email protected]> * explain processing modes Signed-off-by: Guy Daich <[email protected]> --------- Signed-off-by: Guy Daich <[email protected]> Signed-off-by: bjlhlin <[email protected]>
* docs: ext-proc Signed-off-by: Guy Daich <[email protected]> * elaborate on processing mode Signed-off-by: Guy Daich <[email protected]> * explain processing modes Signed-off-by: Guy Daich <[email protected]> --------- Signed-off-by: Guy Daich <[email protected]> Signed-off-by: bjlhlin <[email protected]>
What this PR does / why we need it:
docs for the ext-proc feature
Which issue(s) this PR fixes:
Fixes #3456