Getting Started

    Envoy does not currently provide separate pre-built binaries, but does provide Docker images. This is the fastest way to get started using Envoy. Should you wish to use Envoy outside of a Docker container, you will need to .

    These examples use the v2 Envoy API, but use only the static configuration feature of the API, which is most useful for simple requirements. For more complex requirements is supported.

    These instructions run from files in the Envoy repo. The sections below give a more detailed explanation of the configuration file and execution steps for the same configuration.

    A very minimal Envoy configuration that can be used to validate basic plain HTTP proxying is available in configs/google_com_proxy.v2.yaml. This is not intended to represent a realistic Envoy deployment.

    Copy both and configs/google_com_proxy.v2.yaml to the same directory on your local disk. Then, build and run the Dockerfile, and test out Envoy by sending a request to port 10000:

    Envoy can be configured using a single YAML file passed in as an argument on the command line.

    The is required to configure the administration server. The address key specifies the listening address which in this case is simply 0.0.0.0:9901.

    2.   access_log_path: /tmp/admin_access.log
    3.   address:
    4.     socket_address: { address: 0.0.0.0, port_value: 9901 }

    The contains everything that is configured statically when Envoy starts, as opposed to the means of configuring resources dynamically when Envoy is running. The v2 API Overview describes this.

      The specification of the .

      The specification of the clusters.

      1. clusters:
      3.   connect_timeout: 0.25s
      4.   type: LOGICAL_DNS
      5.   # Comment out the following line to test on v6 networks
      6.   dns_lookup_family: V4_ONLY
      7.   lb_policy: ROUND_ROBIN
      9.   tls_context: { sni: www.google.com }
      1. RUN apt-get update
      2. COPY envoy.yaml /etc/envoy.yaml
      3. CMD /usr/local/bin/envoy -c /etc/envoy.yaml

      Build the Docker image that runs your configuration using:

      And now you can execute it with:

      And finally test is using:

      1. $ curl -v localhost:10000

      We’ve created a number of sandboxes using Docker Compose that set up different environments to test out Envoy’s features and show sample configurations. As we gauge peoples’ interests we will add more sandboxes demonstrating different features. The following sandboxes are available:

      In addition to the proxy itself, Envoy is also bundled as part of several open source distributions that target specific use cases.