The steps described in this hybrid install process are performed with one or more of the following:
Google Cloud console
Apigee hybrid UI
gcloud command line
Environment variables
The steps performed using the command line make use of user-created environment variables. If your
terminal window is disconnected, the environment variables are not saved.
The environment variables used in these procedures are as follows:
Variable name contents that contain spaces must be enclosed in double quotes. For example: "My Project"
Authorization credentials token
Thegcloudauthorization credentials token expires after 20 minutes.
If you don't complete all of the steps within that time, you must get the authorization
credentials again. For example:
TOKEN=$(gcloud auth print-access-token)
Process overview
This section provides an overview of the tasks you must accomplish to set up the hybrid UI
and Google Cloud services.
The general process for setting up the Apigee hybrid UI and Google Cloud services is as follows:
An environment provides an isolated context orsandboxfor running API proxies.
In a single organization, you can create multiple environments.
If you don't do this, you won't be able to complete the hybrid runtime installation, nor
will you have anywhere to deploy your API proxies to.
Next step
Each of these steps is described in the sections that follow.
[[["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-09-04 UTC."],[[["\u003cp\u003eThis documentation covers version 1.5 of Apigee hybrid, which is end-of-life, and users should upgrade to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eThe hybrid installation process involves using the Google Cloud console, Apigee hybrid UI, or the \u003ccode\u003egcloud\u003c/code\u003e command line.\u003c/p\u003e\n"],["\u003cp\u003eEnvironment variables are essential for command-line procedures, and a shell script is recommended for quickly setting them up.\u003c/p\u003e\n"],["\u003cp\u003eSetting up Apigee hybrid includes creating a Google Cloud account and project, enabling APIs, creating an organization, and adding an environment.\u003c/p\u003e\n"],["\u003cp\u003eThe gcloud authorization credentials token expires after 20 minutes, and if you take longer than that to complete all the steps you will have to generate it again.\u003c/p\u003e\n"]]],[],null,["# Part 1: Google Cloud services and hybrid UI configuration\n\n| You are currently viewing version 1.5 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nBefore you begin\n----------------\n\n\nThe steps described in this hybrid install process are performed with one or more of the following:\n\n- Google Cloud console\n- Apigee hybrid UI\n- gcloud command line\n\n### Environment variables\n\n\nThe steps performed using the command line make use of user-created environment variables. If your\nterminal window is disconnected, the environment variables are not saved.\n| **Tip:** Create a shell script to quickly set the environment variables.\n\n\nThe environment variables used in these procedures are as follows:\n\u003cvar translate=\"no\"\u003e\u003c/var\u003e \n\n```gdscript\nexport PROJECT_ID=\"\u003cvar translate=\"no\"\u003eyour_project_id\u003c/var\u003e\"\nexport ORG_NAME=$PROJECT_ID\nORG_DISPLAY_NAME=\"\u003cvar translate=\"no\"\u003eorg_friendly_name\u003c/var\u003e\"\nORGANIZATION_DESCRIPTION=\"\u003cvar translate=\"no\"\u003eorg_description_text\u003c/var\u003e\"\nexport ANALYTICS_REGION=\"\u003cvar translate=\"no\"\u003eanalytics_region\u003c/var\u003e\"\nexport RUNTIMETYPE=HYBRID\nexport LONG_RUNNING_OPERATION_ID=\"\u003cvar translate=\"no\"\u003elong_running_operation_ID\u003c/var\u003e\"\nexport ENV_NAME=\"\u003cvar translate=\"no\"\u003eenvironment_name\u003c/var\u003e\"\nENV_DISPLAY_NAME=\"\u003cvar translate=\"no\"\u003eenv_friendly_name\u003c/var\u003e\"\nENV_DESCRIPTION=\"\u003cvar translate=\"no\"\u003eenv_description_text\u003c/var\u003e\"\nexport DOMAIN=\"\u003cvar translate=\"no\"\u003eexample.com\u003c/var\u003e\"\nexport ENV_GROUP=\"\u003cvar translate=\"no\"\u003eenvironment-group-name\u003c/var\u003e\"\nexport CLUSTER_NAME=\"\u003cvar translate=\"no\"\u003ecluster_name\u003c/var\u003e\"\nexport CLUSTER_LOCATION=\"\u003cvar translate=\"no\"\u003ecluster_region\u003c/var\u003e\"\n```\nVariable name contents that contain spaces must be enclosed in double quotes. For example: \"My Project\" **Tip:** Use the `echo $`\u003cvar translate=\"no\"\u003evariable-name\u003c/var\u003e command to verify that the environment variables are properly set.\n\n### Authorization credentials token\n\n\nThe `gcloud` authorization credentials token expires after 20 minutes.\nIf you don't complete all of the steps within that time, you must get the authorization\ncredentials again. For example: \n\n```text\nTOKEN=$(gcloud auth print-access-token)\n```\n\n### Process overview\n\n\nThis section provides an overview of the tasks you must accomplish to set up the hybrid UI\nand Google Cloud services.\n\nThe general process for setting up the Apigee hybrid UI and Google Cloud services is as follows:\n\n| **Note:** If you plan to enable Google Cloud [Virtual Private Cloud (VPC) Service\n| Controls](https://cloud.google.com/vpc-service-controls) with your Apigee hybrid installation, see [Using VPC Service Controls with Apigee and\n| Apigee hybrid](/apigee/docs/api-platform/security/vpc-sc) for instructions before you proceed.\n\nNext step\n---------\n\nEach of these steps is described in the sections that follow.\n\n[Let's Go!](/apigee/docs/hybrid/v1.5/precog-gcpaccount)"]]
