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:

    If you will be running your clusters on Google Kubernetes Engine (GKE), run this command to enable the required 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).

    Enable the Apigee, Apigee Connect, Cloud Pub/Sub, Cloud Resource Manager, Kubernetes Engine, Compute Engine APIs.

    Enable the APIs

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

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

    • AKS
    • EKS
    • GKE on AWS
    • OpenShift
    • Software-only Google Distributed Cloud on VMware or bare metal
    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.

    Enable the Apigee, Apigee Connect, Cloud Pub/Sub, Cloud Resource Manager APIs.

    Enable the APIs

    gcloud services enable \
        apigee.googleapis.com \
        apigeeconnect.googleapis.com \
        cloudresourcemanager.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.