Add support for configuring Envoys route idle_timeout

[oulman]

Description

This PR adds support for configuring the Envoy route level idle_timeout for service-routers and local_app. For our teams scenario, this will let us extend the timeout for long-running gRPC services so that Envoy doesn't terminate the connection prematurely.

For service-routers a IdleTimeout parameter has been added, and for local_app a proxy config local_idle_timeout_ms parameter was created. I followed the RequestTimeout and local_request_timeout_ms definitions closely.

Testing & Reproduction steps

Manual Testing Steps

service-router IdleTimeout

Created a service-router and configured the IdleTimeout to 60s

Kind = "service-router"
Name = "waitserver"
Routes = [
  {
    Destination {
      Service = ""
      RequestTimeout = "60m"
      IdleTimeout = "60s"
    }
  }
]

Dumped the Envoy config and verified that the idle_timeout configuration parameter was set

<snip>
        "name": "waitserver",
        "domains": [
         "*"
        ],
        "routes": [
         {
          "match": {
           "prefix": "/"
          },
          "route": {
           "cluster": "waitserver.default.dc1.internal.ba4be18f-a3c7-7e2f-eff4-a25a8a1fce57.consul",
           "timeout": "3600s",
           "idle_timeout": "60s"
          }
         },
<snip>

local_idle_timeout_ms

Configure local_idle_timeout_ms on a service proxy.config

service {
  name = "waitserver"
  id = "waitserver"
  address = "10.5.0.20"
  port = 9222

  connect {
    sidecar_service {
      port = 10201

      proxy {
        config {
          local_request_timeout_ms = 0
          local_idle_timeout_ms = 0
        }
      }
      check {
        name = "Connect Envoy Sidecar"
        tcp = "10.5.0.20:10201"
        interval ="10s"
      }
    }
  }
}

Dumped the Envoy config and verified that the idle_timeout configuration parameter was set on the public_listener route for local_app

{
     "route_config": {
      "@type": "type.googleapis.com/envoy.config.route.v3.RouteConfiguration",
      "name": "public_listener",
      "virtual_hosts": [
       {
        "name": "public_listener",
        "domains": [
         "*"
        ],
        "routes": [
         {
          "match": {
           "prefix": "/"
          },
          "route": {
           "cluster": "local_app",
           "timeout": "0s",
           "idle_timeout": "0s"
          }
         }
        ]
       }
      ]
     },

Links

Include any links here that might be helpful for people reviewing your PR (Tickets, GH issues, API docs, external benchmarks, tools docs, etc). If there are none, feel free to delete this section.

Please be mindful not to leak any customer or confidential information. HashiCorp employees may want to use our internal URL shortener to obfuscate links.

PR Checklist

• updated test coverage
• external facing docs updated
• not a security concern

[boruszak]

I reviewed the changelong .txt, service-router.mdx, and envoy.mdx for docs changes.

I have one minor fix, otherwise LGTM. Approving on behalf of consul-docs.

[github-actions]

This pull request has been automatically flagged for inactivity because it has not been acted upon in the last 60 days. It will be closed if no new activity occurs in the next 30 days. Please feel free to re-open to resurrect the change if you feel this has happened by mistake. Thank you for your contributions.

[oulman]

@blake can you remove the stale label so this doesn't get closed? 🙏 Thanks!!

[jkirschner-hashicorp]

Done. I made this PR staleproof for now!

[oulman]

👋 Hi. I wanted to see now that 1.14 is out if this PR could be considered? Thanks!

[dhiaayachi]

Thank you for working on this @oulman. I have a few comments around doc changes and I believe this is missing a test around the local_request_timeout_ms at the xds generation level.

[oulman]

and I believe this is missing a test around the local_request_timeout_ms at the xds generation level.

Thanks, @dhiaayachi! Is that tests in addition to the changes here?

https://github.com/hashicorp/consul/pull/14340/files#diff-fb5ad005250adf2da36018fec648de9d65d05df9de42eed95310bac480e9c0b4

[dhiaayachi]

and I believe this is missing a test around the local_request_timeout_ms at the xds generation level.

Thanks, @dhiaayachi! Is that tests in addition to the changes here?

https://github.com/hashicorp/consul/pull/14340/files#diff-fb5ad005250adf2da36018fec648de9d65d05df9de42eed95310bac480e9c0b4

The missing test would be on the rendering side, could be an addition to this test

[oulman]

The missing test would be on the rendering side, could be an addition to this test

Ah! Thank you, @dhiaayach!i I have added the local_idle_timeout_ms to that test in this commit.

[david-yu]

Hi @dhiaayachi I just checked with @oulman and he has confirmed that he has addressed your comments. Are additional changes needed here?

[dhiaayachi]

LGTM! it would be good to have @hashicorp/consul-docs review the documentation bits.

[boruszak]

Reviewed 14340.txt, service-router.mdx, and envoy.mdx again at David Yu's request.

Everything LGTM!