Getting started

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

This topic explains how to download and install Apigee Adapter for Envoy.


In the following steps, you will download and set up two applications on your system: the Apigee Remote Service CLI and the Apigee Remote Service for Envoy.

Download and install

  1. Create a base directory on your system in which to install the Remote Service CLI and the Remote Service. For example:
    mkdir ~/envoy-adapter
    cd ~/envoy-adapter
    export ENVOY_HOME=$PWD
  2. For the remaining steps, be sure you are in the $ENVOY_HOME directory:
    cd $ENVOY_HOME
  3. Download the latest release of the Apigee Remote Service CLI into $ENVOY_HOME. Be sure to grab the correct package for your operating system.
  4. Download the latest release of the Apigee Remote Service for Envoy into $ENVOY_HOME.
  5. Create directories to hold the extracted package contents inside $ENVOY_HOME:
    mkdir apigee-remote-service-cli
    mkdir apigee-remote-service-envoy
  6. Extract the tar file contents into the new directories:
    tar -xf apigee-remote-service-cli_version_platform.tar.gz -C apigee-remote-service-cli
    tar -xf apigee-remote-service-envoy_version_platform.tar.gz -C apigee-remote-service-envoy
  7. Delete the tar files.
  8. When you complete these steps, $ENVOY_HOME contains two directories:
    ls -1 .
  9. Create the following environment variables for the apigee-remote-service-cli and apigee-remote-service-envoy directories. You will use these environment variables throughout the documentation:
    export CLI_HOME=$PWD/apigee-remote-service-cli
    export REMOTE_SERVICE_HOME=$PWD/apigee-remote-service-envoy

Next steps

You are now ready to set up and use the Apigee Adapter for Envoy to proxy API calls with Apigee API management. The following examples show you how to use the adapter with Apigee hybrid:

Example Description
Istio sidecar with Apigee hybrid Deploy the Remote Service into an Istio service mesh. The remote service provides the endpoints to the Istio sidecar proxies that are installed on your target services. This steup lets you use the Apigee Adapter for Envoy with an Apigee hybrid installation.