Step 1: Enable APIs

Stay organized with collections Save and categorize content based on your preferences.

To use Apigee hybrid, you must (unless otherwise noted) enable the following service APIs:

Task Description
Apigee API Provides communication between your project and other hybrid services and Google Cloud APIs.
Apigee Connect API Provides communication between the Apigee management plane and the runtime plane.
Cloud Pub/Sub API Required for the Apigee quota feature to operate.
Cloud Resource Manager API Used by hybrid to validate service accounts.
Kubernetes Engine API Enable if you plan to use Google Kubernetes Engine (GKE), or GKE on-prem (Anthos) for your hybrid runtime installation.
Compute Engine API Used for cluster management (GKE-based and OpenShift-based clusters only).
Google Cloud APIs This is a meta service for Google Cloud APIs for convenience (OpenShift-based clusters only).
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).
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).
IAM Service Account Credentials API Service Account Credentials API allows developers to create short-lived, limited-privilege credentials for their service accounts on GCP. (OpenShift-based clusters only).
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).
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).
Google Cloud Storage JSON API Lets you store and retrieve potentially-large, immutable data objects (OpenShift-based clusters only).
Cloud Storage Google Cloud Storage is a RESTful service for storing and accessing your data on Google's infrastructure. (OpenShift-based clusters only).

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 -h
  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:

    GKE

    If you will be running your clusters in Google Cloud (GKE), enable the APIs with the following command:

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

    OpenShift

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

    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  --project $PROJECT_ID
        servicemanagement.googleapis.com \
        serviceusage.googleapis.com \
        storage-api.googleapis.com \
        storage-component.googleapis.com  --project $PROJECT_ID
    

    Other Platforms

    Enable the APIs with the following command if you will be running your clusters in another Kubernetes platform, such as

    • GKE on-prem
    • Anthos on bare metal
    • AKS
    • GKE on AWS
    • EKS
    gcloud services enable \
        apigee.googleapis.com \
        apigeeconnect.googleapis.com \
        cloudresourcemanager.googleapis.com \
        pubsub.googleapis.com  --project $PROJECT_ID
  4. Verify that all APIs are enabled, using the following command:
    gcloud services list --project $PROJECT_ID

    The output should include all the APIs you just enabled, as in this example:

    NAME                                 TITLE
    apigee.googleapis.com                Apigee API
    apigeeconnect.googleapis.com         Apigee Connect API
    bigquery.googleapis.com              BigQuery API
    bigquery.googleapis.com              BigQuery API
    bigquerystorage.googleapis.com       BigQuery Storage API
    cloudapis.googleapis.com             Google Cloud APIs
    clouddebugger.googleapis.com         Cloud Debugger API
    cloudresourcemanager.googleapis.com  Cloud Resource Manager API
    cloudtrace.googleapis.com            Cloud Trace API
    compute.googleapis.com               Compute Engine API
    container.googleapis.com             Kubernetes Engine API
    containeranalysis.googleapis.com     Container Analysis API
    containerregistry.googleapis.com     Container Registry API
    datastore.googleapis.com             Cloud Datastore API
    iam.googleapis.com                   Identity and Access Management (IAM) API
    iamcredentials.googleapis.com        IAM Service Account Credentials API
    logging.googleapis.com               Cloud Logging API
    monitoring.googleapis.com            Cloud Monitoring API
    oslogin.googleapis.com               Cloud OS Login API
    pubsub.googleapis.com                Cloud Pub/Sub API
    servicemanagement.googleapis.com     Service Management API
    serviceusage.googleapis.com          Service Usage API
    sql-component.googleapis.com         Cloud SQL
    storage-api.googleapis.com           Google Cloud Storage JSON API
    storage-component.googleapis.com     Cloud Storage

Next step

Go to Step 2: Create an organization.