FAQ

Build

• Where do I get binaries?
• Why does Envoy use BoringSSL?
• Why does Envoy take so long to compile?

API

• How do I configure Envoy to use the v3 API?
• How does API versioning interact with a new extension?
• What do the v2, v3, vN etc. mean in API package names?
• Why are the Envoy xDS APIs versioned? What is the benefit?
• What is the status of incremental xDS support?

Debugging

• Why is Envoy sending internal responses?
• Why is Envoy sending HTTP/2 resets?
• Why is Envoy sending 404s to CONNECT requests?
• Why is Envoy sending 413s?
• Why is my route not found?
• Why is Envoy operating on X-Forwarded-Proto instead of :scheme or vice-versa?
• How to dump heap profile of Envoy?

Performance

• How fast is Envoy?
• What are best practices for benchmarking Envoy?

Configuration

• How do I configure Envoy as an edge proxy?
• How do I configure Envoy as a level two proxy?
• How do I configure SNI for listeners?
• How do I configure SNI for clusters?
• How do I configure zone aware routing?
  • Envoy configuration on the source service
  • Envoy configuration on the destination service
  • Infrastructure setup
  • Verification steps
• How do I configure tracing?
• How do I configure flow control?
• How do I configure timeouts?
  • HTTP/gRPC
  • TCP
  • Transport Socket
• How are configuration deprecations handled?
• How does Envoy prevent file descriptor exhaustion?

Load balancing

• I setup health checking. When I fail some hosts, Envoy starts routing to all of them again. Why?
• Why doesn’t RR load balancing appear to be even?
• Is there a way to disable circuit breaking?
• How do I handle transient failures?
  • Circuit Breaking
  • Retries
  • Retries in gRPC services
  • Outlier Detection
• How do I make Envoy fail over to another region during service degradation?

Extensions

• Is there a contract my HTTP filter must adhere to?
• Are there well-known headers that will appear in the given headers map of decodeHeaders()?

Windows

Note

On August 31, 2023 the Envoy project ended official Windows support due to a lack of resources. We will continue to accept patches related to the Windows build. Until further notice, Windows builds are excluded from Envoy CI, as well as the Envoy release and security processes.

• What are the requirements to run on Envoy on Windows?
• Which Envoy features are not supported on Windows?
• Does Envoy on Windows support FIPS?
• How fast is Envoy on Windows?
• What is the security release process?
• Can I run Envoy on Windows under SCM?