This topic explains how to download and install Apigee Adapter for Envoy.
Overview
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
Create a base directory on your system in which to install the Remote Service CLI and
the Remote Service. For example:
Extract the tar file contents into the new directories:
tar -xf apigee-remote-service-cli_version_platform.tar.gz -C apigee-remote-service-clitar -xf apigee-remote-service-envoy_version_platform.tar.gz -C apigee-remote-service-envoy
Delete the tar files.
When you complete these steps, $ENVOY_HOME contains two directories:
ls -1 .
apigee-remote-service-cli
apigee-remote-service-envoy
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:
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:
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis guide provides instructions for downloading and installing the Apigee Remote Service CLI and the Apigee Remote Service for Envoy.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves creating a base directory, downloading the latest releases of both applications from their respective GitHub repositories, and extracting their contents into designated directories.\u003c/p\u003e\n"],["\u003cp\u003eAfter installation, you will have two main directories, \u003ccode\u003eapigee-remote-service-cli\u003c/code\u003e and \u003ccode\u003eapigee-remote-service-envoy\u003c/code\u003e, located in the \u003ccode\u003e$ENVOY_HOME\u003c/code\u003e directory.\u003c/p\u003e\n"],["\u003cp\u003eEnvironment variables \u003ccode\u003eCLI_HOME\u003c/code\u003e and \u003ccode\u003eREMOTE_SERVICE_HOME\u003c/code\u003e are created to reference the installed directories for the CLI and Remote Service, respectively.\u003c/p\u003e\n"],["\u003cp\u003eOnce installed, you can proceed to set up and use the Apigee Adapter for Envoy to proxy API calls with Apigee API management, including an example with Apigee hybrid using Istio.\u003c/p\u003e\n"]]],[],null,["# Getting started\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\nThis topic explains how to download and install Apigee Adapter for Envoy.\n\nOverview\n--------\n\n\nIn the following steps, you will download and set up two applications on your system:\nthe **Apigee Remote Service CLI** and the\n**Apigee Remote Service for Envoy**.\n\nDownload and install\n--------------------\n\n1. Create a base directory on your system in which to install the Remote Service CLI and the Remote Service. For example: \n\n mkdir ~/envoy-adapter\n cd ~/envoy-adapter\n export ENVOY_HOME=$PWD\n\n2. For the remaining steps, be sure you are in the `$ENVOY_HOME` directory: \n\n ```\n cd $ENVOY_HOME\n ```\n3. Download the [latest release](https://github.com/apigee/apigee-remote-service-cli/releases) of the **Apigee Remote Service CLI** into `$ENVOY_HOME`. Be sure to grab the correct package for your operating system.\n4. Download the [latest release](https://github.com/apigee/apigee-remote-service-envoy/releases) of the **Apigee Remote Service for Envoy** into `$ENVOY_HOME`.\n5. Create directories to hold the extracted package contents inside `$ENVOY_HOME`: \n\n mkdir apigee-remote-service-cli\n mkdir apigee-remote-service-envoy\n\n6. Extract the tar file contents into the new directories: \n\n tar -xf apigee-remote-service-cli_\u003cvar translate=\"no\"\u003eversion_platform\u003c/var\u003e.tar.gz -C apigee-remote-service-cli\n tar -xf apigee-remote-service-envoy_\u003cvar translate=\"no\"\u003eversion_platform\u003c/var\u003e.tar.gz -C apigee-remote-service-envoy\n\n7. Delete the tar files.\n8. When you complete these steps, `$ENVOY_HOME` contains two directories: \n\n ```\n ls -1 .\n apigee-remote-service-cli\n apigee-remote-service-envoy\n ```\n9. 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: \n\n export CLI_HOME=$PWD/apigee-remote-service-cli\n export REMOTE_SERVICE_HOME=$PWD/apigee-remote-service-envoy\n\nNext steps\n----------\n\n\nYou are now ready to set up and use the\nApigee Adapter for Envoy to proxy API calls with Apigee API management. The following examples\nshow you how to use the adapter with Apigee hybrid:"]]
