About the documentation¶
The Envoy documentation is composed of a few major sections:
- Introduction: This section covers a general overview of what Envoy is, an architecture overview, how it is typically deployed, etc.
- Installation: How to build/install Envoy using Docker.
- Configuration: Detailed configuration instructions common to both the legacy v1 API and the new v2 API. Where relevant, the configuration guide also contains information on statistics, runtime configuration, and APIs.
- Operations: General information on how to operate Envoy including the command line interface, hot restart wrapper, administration interface, a general statistics overview, etc.
- Extending Envoy: Information on how to write custom filters for Envoy.
- v1 API reference: Configuration details specific to the legacy v1 API.
- v2 API reference: Configuration details specific to the new v2 API.
- Envoy FAQ: Have questions? We have answers. Hopefully.