Skip to content

Commit

Permalink
Trim down comment for original_ip_detection_extensions
Browse files Browse the repository at this point in the history
Signed-off-by: Raul Gutierrez Segales <[email protected]>
  • Loading branch information
Raul Gutierrez Segales committed May 13, 2021
1 parent 892a4a8 commit fd10840
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 92 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -516,31 +516,13 @@ message HttpConnectionManager {

// The configuration for the original-IP detection extensions.
//
// By default, when the :ref:`use_remote_address
// <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.use_remote_address>`
// option is not used, Envoy will rely on the :ref:`config_http_conn_man_headers_x-forwarded-for` header
// and the deprecated :ref:`xff_num_trusted_hops
// <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.xff_num_trusted_hops>`
// configuration option to detect the remote address. Once :ref:`xff_num_trusted_hops
// <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.xff_num_trusted_hops>`
// is removed, leaving this field empty will retain the default behavior when that field is unset. See
// the :ref:`xff extension <envoy_api_msg_extensions.http.original_ip_detection.xff.v3.XffConfig>` for how to
// configure xff_num_trusted_hops when using extensions.
//
// Furthermore, relying on the :ref:`config_http_conn_man_headers_x-forwarded-for`
// header doesn't necessarily work for all network configurations. For instance,
// if the number of trusted hops isn't consistent for requests flowing into
// Envoy this mechanism cannot be used reliably. For such cases, the following
// option allows for a list of custom extensions to be provided.
//
// When configured the extensions will be called along with the request headers
// and information about the downstream connection, such as direct connected address,
// when the HCM needs to populate the final remote address. Each extension will then rely
// on these parameters to decide the value of the request's final remote address.
// and information about the downstream connection, such as the directly connected address.
// Each extension will then use these parameters to decide the request's effective remote address.
// If an extension fails to detect the original IP address and isn't configured to reject
// the request when this happens, the HCM will then try the remaining configured extensions
// until one succeeds or the request is rejected. If the request isn't rejected nor any extension
// succeeds, the HCM will fallback to using the remote address.
// the request, the HCM will try the remaining extensions until one succeeds or rejects
// the request. If the request isn't rejected nor any extension succeeds, the HCM will
// fallback to using the remote address.
//
// [#extension-category: envoy.http.original_ip_detection]
repeated config.core.v3.TypedExtensionConfig original_ip_detection_extensions = 46;
Expand Down

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.

0 comments on commit fd10840

Please sign in to comment.