DEVELOPER.md

Developer documentation

Envoy is built using the Bazel build system. CircleCI builds, tests, and runs coverage against all pull requests and the master branch.

To get started building Envoy locally, see the Bazel quick start. To run tests, there are Bazel targets for Google Test. To generate a coverage report, there is a coverage build script.

If you plan to contribute to Envoy, you may find it useful to install the Envoy development support toolchain, which helps automate parts of the development process, particularly those involving code review.

Below is a list of additional documentation to aid the development process:

• General build and installation documentation

• Building and testing Envoy with Bazel

• Managing external dependencies with Bazel

• Guide to Envoy Bazel rules (managing BUILD files)

• Using Docker for building and testing

• Guide to contributing to Envoy

• Overview of Envoy's testing frameworks

• Overview of how to write integration tests for new code

• Envoy filter example project (how to consume and extend Envoy as a submodule)

• Performance testing Envoy with tcmalloc/pprof

And some documents on components of Envoy architecture:

• Envoy flow control

• Envoy's subset load balancer