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 manually, follow the instructions at bazel/README.md.
Requirements¶
Envoy was initially developed and deployed on Ubuntu 14 LTS. It should work on any reasonably recent Linux including Ubuntu 16 LTS.
Building Envoy has the following requirements:
- GCC 7+ or Clang/LLVM 7+ (for C++14 support).
- These Bazel native dependencies.
Please see the linked CI and Bazel documentation for more information on performing manual builds.
Pre-built binaries¶
We build and tag Docker images with release versions when we do official releases. These images can be found in the following repositories:
- envoyproxy/envoy: Release binary with symbols stripped on top of an Ubuntu Xenial base.
- envoyproxy/envoy-alpine: Release binary with symbols stripped on top of a glibc alpine base.
- envoyproxy/envoy-alpine-debug: Release binary with debug symbols on top of a glibc alpine base.
In the above repositories, the latest tag points to the latest official release.
Note
The above repositories used to contain the dev images described below. They remain to avoid breaking existing users. New dev images are added to the repositories described in the following section.
On every master commit we additionally create a set of development Docker images. These images can be found in the following repositories:
- envoyproxy/envoy-dev: Release binary with symbols stripped on top of an Ubuntu Xenial base.
- envoyproxy/envoy-alpine-dev: Release binary with symbols stripped on top of a glibc alpine base.
- envoyproxy/envoy-alpine-debug-dev: Release binary with debug symbols on top of a glibc alpine base.
In the above dev repositories, the latest tag points to the last Envoy SHA in master that passed tests.
Note
The Envoy project considers master to be release candidate quality at all times, and many organizations track and deploy master in production. We encourage you to do the same so that issues can be reported as early as possible in the development process.
We will consider producing additional binary types depending on community interest in helping with CI, packaging, etc. Please open an issue in GitHub if desired.
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.