Console
Start free

Step 1: Enable APIs

Version 1.14 keyboard_arrow_down

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 Google Cloud console to enable the APIs.

  • Complete the Prerequisites, and be sure you have the gcloud CLI installed in your local shell: 
    gcloud --help
  • 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
    • Select the tab for your intended installation to see the command to enable the APIs:

    GKE on Google Cloud

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

    Google Cloud console

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

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

    gcloud

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

    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. monitoring.googleapis.com Cloud Monitoring API Required for access to Cloud Monitoring metrics. 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.

    Google Cloud console

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

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

    gcloud

    gcloud services enable \
    apigee.googleapis.com \
    apigeeconnect.googleapis.com \
    cloudresourcemanager.googleapis.com \
    monitoring.googleapis.com \
    pubsub.googleapis.com  --project $PROJECT_ID
  • (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.