Step 1: Enable APIs

Apigee hybrid requires certain Google Cloud service APIs. In this step, you will enable the APIs that are required for your installation platform.

Use gcloud to enable the required APIs as explained in the following steps. If you prefer, you can use the Cloud Console to enable the APIs.

1. Complete the Prerequisites, and be sure you have the gcloud CLI installed in your local shell:

   gcloud --help

2. Create a PROJECT_ID environment variable where the value is the ID of the Google Cloud project you plan to use for Apigee hybrid. A project ID is a unique string used to differentiate your project from all others in Google Cloud. If needed, see Locate the project ID:

   export PROJECT_ID=YOUR_PROJECT_ID

3. Select the tab for your intended installation to see the command to enable the APIs:

   OpenShift

   If you will be running your clusters on OpenShift, enable the APIs with the following command:

   Click to see details on the APIs

   Name	Title	Description
   apigee.googleapis.com	Apigee API	Provides communication between your project and other hybrid services and Google Cloud APIs.
   apigeeconnect.googleapis.com	Apigee Connect API	Provides communication between the Apigee management plane and the runtime plane.
   cloudapis.googleapis.com	Google Cloud APIs	This is a meta service for Google Cloud APIs for convenience (OpenShift-based clusters only)
   cloudresourcemanager.googleapis.com	Cloud Resource Manager API	Used by hybrid to validate service accounts.
   compute.googleapis.com	Compute Engine API	Used for cluster management (GKE-based and OpenShift-based clusters only).
   dns.googleapis.com	Cloud DNS API	Google Cloud DNS is a scalable, reliable, and managed authoritative Domain Name System (DNS) service running on the same infrastructure as Google. (OpenShift-based clusters only).
   iam.googleapis.com	Identity and Access Management (IAM) API	Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. (OpenShift-based clusters only).
   iamcredentials.googleapis.com	IAM Service Account Credentials API	Service Account Credentials API allows developers to create short-lived, limited-privilege credentials for their service accounts on Google Cloud Platform. (OpenShift-based clusters only).
   pubsub.googleapis.com	Cloud Pub/Sub API	Required for the Apigee quota feature to operate.
   servicemanagement.googleapis.com	Service Management API	Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. (OpenShift-based clusters only).
   serviceusage.googleapis.com	Service Usage API	Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. (OpenShift-based clusters only).
   storage-api.googleapis.com	Google Cloud Storage JSON API	Lets you store and retrieve potentially-large, immutable data objects (OpenShift-based clusters only).
   storage-component.googleapis.com	Cloud Storage	Google Cloud Storage is a RESTful service for storing and accessing your data on Google's infrastructure. (OpenShift-based clusters only).

   gcloud services enable \
       apigee.googleapis.com \
       apigeeconnect.googleapis.com \
       cloudapis.googleapis.com \
       cloudresourcemanager.googleapis.com \
       compute.googleapis.com \
       dns.googleapis.com \
       iam.googleapis.com \
       iamcredentials.googleapis.com \
       pubsub.googleapis.com \
       servicemanagement.googleapis.com \
       serviceusage.googleapis.com \
       storage-api.googleapis.com \
       storage-component.googleapis.com  --project $PROJECT_ID
   

   Other Platforms

   If you will be running your clusters on one of the following platforms run the command below to enable the required APIs:

   • Software-only Google Distributed Cloud on VMware or bare metal
   • AKS
   • GKE on AWS
   • EKS

   Click to see details on the APIs

   Name	Title	Description
   apigee.googleapis.com	Apigee API	Provides communication between your project and other hybrid services and Google Cloud APIs.
   apigeeconnect.googleapis.com	Apigee Connect API	Provides communication between the Apigee management plane and the runtime plane.
   pubsub.googleapis.com	Cloud Pub/Sub API	Required for the Apigee quota feature to operate.
   cloudresourcemanager.googleapis.com	Cloud Resource Manager API	Used by hybrid to validate service accounts.

   gcloud services enable \
       apigee.googleapis.com \
       apigeeconnect.googleapis.com \
       cloudresourcemanager.googleapis.com \
       pubsub.googleapis.com  --project $PROJECT_ID

   GKE on Google Cloud

   If you will be running your clusters on Google Kubernetes Engine (GKE), run this command to enable the required APIs:

   Click to see details on the APIs

   Name	Title	Description
   apigee.googleapis.com	Apigee API	Provides communication between your project and other hybrid services and Google Cloud APIs.
   apigeeconnect.googleapis.com	Apigee Connect API	Provides communication between the Apigee management plane and the runtime plane.
   pubsub.googleapis.com	Cloud Pub/Sub API	Required for the Apigee quota feature to operate.
   cloudresourcemanager.googleapis.com	Cloud Resource Manager API	Used by hybrid to validate service accounts.
   container.googleapis.com	Kubernetes Engine API	Enable if you plan to use Google Kubernetes Engine (GKE) on Google Cloud or software-only Google Distributed Cloud for your hybrid runtime installation.
   compute.googleapis.com	Compute Engine API	Used for cluster management (GKE-based and OpenShift-based clusters only).

     gcloud services enable \
         apigee.googleapis.com \
         apigeeconnect.googleapis.com \
         cloudresourcemanager.googleapis.com \
         compute.googleapis.com \
         container.googleapis.com \
         pubsub.googleapis.com --project $PROJECT_ID
     

4. (Optional) To verify that the required APIs are enabled, execute this command. If the required APIs are in the returned list, then they are enabled.

   gcloud services list --project $PROJECT_ID

Next step

Go to Step 2: Create an organization.