Building

The Envoy build system uses Bazel.

In order to ease initial building and for a quick start, we provide an Ubuntu 16 based docker container that has everything needed inside of it to build and statically link Envoy, see ci/README.md.

In order to build without using the Docker container, follow the instructions at bazel/README.md.

Requirements

Envoy was initially developed and deployed on Ubuntu 14.04 LTS. It should work on any reasonably recent Linux including Ubuntu 18.04 LTS.

Building Envoy has the following requirements:

  • GCC 7+ or Clang/LLVM 7+ (for C++14 support). Clang/LLVM 9+ preferred where Clang is used (see below).

  • About 2GB of RAM per core (so 32GB of RAM for 8 cores with hyperthreading)

  • These Bazel native dependencies.

Please see the linked CI and Bazel documentation for more information on performing manual builds. Please note that for Clang/LLVM 8 and lower, Envoy may need to be built with –define tcmalloc=gperftools as the new tcmalloc code is not guaranteed to compile with lower versions of Clang.

Modifying Envoy

If you’re interested in modifying Envoy and testing your changes, one approach is to use Docker. This guide will walk through the process of building your own Envoy binary, and putting the binary in an Ubuntu container.