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 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 API Library 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. If you do not see the API Library page, select APIs & Services > Library from the Navigation menu.

      Navigation menu highlighted

    2. Make sure the correct project is selected.

      Google Cloud Platform project selector

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

      API library search box

      Google Cloud displays a list of APIs matching "Apigee"

    4. Locate the Apigee API service and click it.

      5. Apigee API service option

    5. In the Apigee API view click Enable.

      Google Cloud enables the Apigee API for your Google Cloud project. Repeat these steps to enable additional APIs.

  4. Enable the Apigee Connect API.
  5. Enable the Cloud Pub/Sub API.
  6. Enable the Cloud Resource Manager API.
  7. (GKE-based clusters only) Enable the Google Kubernetes Engine API.
  8. (GKE-based and OpenShift-based clusters only) Enable the Compute Engine API.
  9. (OpenShift-based clusters only) Enable these APIs:
    • Google Cloud APIs
    • Cloud DNS API
    • Identity and Access Management (IAM) API
    • IAM Service Account Credentials API
    • Service Management API
    • Service Usage API
    • Google Cloud Storage JSON API
    • Cloud Storage
  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.

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 \ 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
  5. 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: 

    NAMETITLEapigee.googleapis.comApigeeAPIapigeeconnect.googleapis.comApigeeConnectAPIbigquery.googleapis.comBigQueryAPIbigquery.googleapis.comBigQueryAPIbigquerystorage.googleapis.comBigQueryStorageAPIcloudapis.googleapis.comGoogleCloudAPIsclouddebugger.googleapis.comCloudDebuggerAPIcloudresourcemanager.googleapis.comCloudResourceManagerAPIcloudtrace.googleapis.comCloudTraceAPIcompute.googleapis.comComputeEngineAPIcontainer.googleapis.comKubernetesEngineAPIcontaineranalysis.googleapis.comContainerAnalysisAPIcontainerregistry.googleapis.comContainerRegistryAPIdatastore.googleapis.comCloudDatastoreAPIiam.googleapis.comIdentityandAccessManagement(IAM)APIiamcredentials.googleapis.comIAMServiceAccountCredentialsAPIlogging.googleapis.comCloudLoggingAPImonitoring.googleapis.comCloudMonitoringAPIoslogin.googleapis.comCloudOSLoginAPIpubsub.googleapis.comCloudPub/SubAPIservicemanagement.googleapis.comServiceManagementAPIserviceusage.googleapis.comServiceUsageAPIsql-component.googleapis.comCloudSQLstorage-api.googleapis.comGoogleCloudStorageJSONAPIstorage-component.googleapis.comCloudStorage

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

123(NEXT) Step 4: Create an organization5