Step 3: Enable APIs

To use Apigee hybrid, you must enable the following APIs for the project in the Google Cloud Console:

  • 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 MART service in the runtime plane.
  • Cloud DNS API: Used for communication with external processes.
  • Cloud Pub/Sub API: Required for quota to operate.
  • Cloud Resource Manager API: Used by hybrid to validate service accounts.
  • Compute Engine API: Used for cluster management (GKE-based clusters only).
  • Kubernetes Engine API: Enable if you plan to use Google Kubernetes Engine (GKE), or GKE on-prem (Anthos) on-prem for your hybrid runtime installation.

Enable the required APIs for your Google Cloud project:

You can use the CLI or the Google Cloud Console UI to enable the APIs.

Google Cloud UI

To enable the APIs using the UI, perform the following steps:

  1. Open the Google Cloud Console and log in with the account you created in Step 1: Create a Google Cloud account.
  2. Select the project that you created in Step 2: Create a Google Cloud project.
  3. Enable the Apigee API as follows:
    1. From the Navigation menu, select APIs & Services > Library.

      Navigation menu highlighted

      APIs & Services > Library option

    2. In the API Library view search for "Apigee".

      API library search box

      Google Cloud displays a list of APIs matching "Apigee"

    3. Locate the Apigee API service and click it.
    4. Apigee API service option

    5. In the Apigee API view click Enable.

      Google Cloud enables the Apigee API for your Google Cloud project.

  4. Enable the Apigee Connect API:
    1. In the API Library view, search for "Apigee Connect".
    2. Locate the Apigee Connect API and enable it.

      Google Cloud enables the Apigee Connect API for your Google Cloud project.

  5. Enable the Cloud DNS API:
    1. In the API Library view, search for "Cloud DNS API".
    2. Locate the Cloud DNS API and enable it.

      Google Cloud enables the Cloud DNS API for your Google Cloud project.

  6. Enable the Cloud Pub/Sub API:
    1. In the API Library view, search for "Cloud Pub/Sub API".
    2. Locate the Cloud Pub/Sub API and enable it.

      Google Cloud enables the Cloud Pub/Sub API for your Google Cloud project.

  7. Enable the Cloud Resource Manager API:
    1. In the API Library view, search for "Cloud Resource Manager".
    2. Locate the Cloud Resource Manager and enable it.

      Google Cloud enables the Cloud Resource Manager API for your Google Cloud project.

  8. (GKE-based clusters only) Enable the Compute Engine API:
    1. In the API Library view, search for "Compute Engine".
    2. Locate the Compute Engine API and enable it.

      Google Cloud enables the Compute Engine API for your Google Cloud project.

  9. (GKE-based clusters only) Enable the Google Kubernetes Engine API:
    1. In the API Library view, search for "Google Kubernetes Engine".
    2. Locate the Google Kubernetes API and enable it.

      Google Cloud enables the Google Kubernetes API for your Google Cloud project.

  10. To confirm that you have enabled the APIs, select APIs & Services > Dashboard.

    The APIs you just added are displayed in the list of enabled APIs:

    • Apigee API
    • Apigee Connect API
    • Cloud DNS API
    • Cloud Pub/Sub API
    • Cloud Resource Manager API
    • Compute Engine API
    • Kubernetes Engine API

gcloud CLI

To enable the APIs using the CLI, perform the following steps:

  1. Open a terminal window on the device you are using to manage Apigee.
  2. Be sure you have gcloud installed in your local shell by running the following command. The gcloud tool provides the primary command-line interface for Cloud.
    gcloud -h

    If you do not have gcloud installed, install the Cloud SDK.

  3. Make sure you have the PROJECT_ID variable defined with the ID of the project you created in Step 2: Create a Google Cloud project:
    echo $PROJECT_ID

    If it is not, define the PROJECT_ID environment variable with the following command:

    export PROJECT_ID=your_project_id
    Project ID name with trailing period
  4. 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 \
        dns.googleapis.com \
        pubsub.googleapis.com \
        cloudresourcemanager.googleapis.com \
        compute.googleapis.com \
        container.googleapis.com --project $PROJECT_ID
    

    GKE on-prem

    If you will be running your clusters in GKE on-prem (Anthos), enable the APIs with the following command:

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

    AKS

    If you will be running your clusters in Azure Kubernetes Service (AKS), enable the APIs with the following command:

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

    GKE on AWS

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

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

    EKS

    If you will be running your clusters in Amazon EKS, enable the APIs with the following command:

    gcloud services enable \
        apigee.googleapis.com \
        apigeeconnect.googleapis.com \
        dns.googleapis.com \
        pubsub.googleapis.com \
        cloudresourcemanager.googleapis.com  --project $PROJECT_ID
    
  5. Verify that all APIs are enabled using the following command:
    gcloud services list

    The following is returned:

    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
    computescanning.googleapis.com       Compute Scanning 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
    dns.googleapis.com                   Cloud DNS 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

For more information about enabling APIs in the Google Cloud Console, see Enabling an API in your Google Cloud project in the Cloud documentation.

Next step

1 2 3 (NEXT) Step 4: Create an organization 5 6