Getting started

This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

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: theApigee Remote Service CLI and theApigee 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-adaptercd~/envoy-adapterexportENVOY_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 theApigee Remote Service CLI into$ENVOY_HOME. Be sure to grab the correct package for your operating system.
  4. Download the latest release of theApigee Remote Service for Envoy into$ENVOY_HOME.
  5. Create directories to hold the extracted package contents inside$ENVOY_HOME:
    mkdir apigee-remote-service-climkdir 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-clitar -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 .  apigee-remote-service-cli  apigee-remote-service-envoy
  9. Create the following environment variables for theapigee-remote-service-cli andapigee-remote-service-envoy directories. You will use these environment variables throughout the documentation:
    exportCLI_HOME=$PWD/apigee-remote-service-cliexportREMOTE_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 shows you how to use the adapter with Apigee and Apigee hybrid:

ExampleDescription
Native Envoy example for Apigee and hybridInstall and run Envoy and the Remote Service locally, not inside a Kubernetes cluster. You can follow the example in this document for both Apigee and Apigee hybrid installations.
Apigee hybrid example with KubernetesDeploy 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 setup lets you use the Apigee Adapter for Envoy with an Apigee hybrid installation.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.