Step 5: Install hybrid runtime

Enable synchronizer access

To enable synchronizer access:

  1. Create a Google Cloud service account and add the Apigee Organization Admin role to it. This service account will be used to authenticate an API call that you will make in a later step. An easy way to create the service account is through the GCP console. For instructions, see Creating and managing service accounts in the GCP documentation.

    For example, the following gcloud commands will create the service account and assign the Apigee Organization Admin to it:

    1. Create the account:
      gcloud iam service-accounts create apigee-org-admin \

      Where apigee-org-admin is the name of the service account you are creating. "apigee-org-admin" is recommended for this tutorial.

    2. Assign the Apigee Org Admin role to the service account:
      gcloud projects add-iam-policy-binding $PROJECT_ID \
          --member="serviceAccount:apigee-org-admin@$" \


      • $PROJECT_ID is the name of your Google Cloud project that you created in Step 2: Create a Google Cloud project.
      • apigee-org-admin is the name of the service account you just created.
      • roles/apigee.admin is the Apigee Org Admin role.
  2. Download the service account key to your system. Use the following command to make download the key into your service-accounts/ directory. For more information see the instructions in Creating service account keys in the GCP documentation.
    1. Make sure you are in the /hybrid-base-directory/hybrid-files/ directory.
    2. Download the key:
      gcloud iam service-accounts keys create ./service-accounts/$PROJECT_ID-apigee-org-admin.json \
        --iam-account apigee-org-admin@$

      The output should look something like:

      created key [a0b1c2d3e4f5a0b1c2d3e4f5a0b1c2d3e4f5a0b1] of type [json] as [./service-accounts/hybrid-
      example-apigee-org-admin.json] for []
  3. Verify the path to the Apigee Org Admin service account key with the following command:
    ls service-accounts/*admin*

    The result should look something like the following:

  4. Create an ORG_ADMIN_ACCOUNT environment variable with the name of the key file. For example:
    export ORG_ADMIN_ACCOUNT="hybrid-example-2-apigee-org-admin.json"
  5. Execute the following commands to get a token:
    export TOKEN=$(gcloud auth application-default print-access-token)
  6. Get the email address for your apigee-synchronizer service account with the following command:
    gcloud iam service-accounts list --filter "apigee-synchronizer"

    If it matches the pattern apigee-synchronizer$, you can use that pattern in the next step.

  7. Call the setSyncAuthorization API to enable the required permissions for Synchronizer using the following command:
    curl -X POST -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type:application/json" \
      "$ORG_NAME:setSyncAuthorization" \
       -d '{"identities":["'"serviceAccount:apigee-synchronizer@$"'"]}'


    • $ORG_NAME: The name of your hybrid organization.
    • apigee-synchronizer$ The email address of the apigee-syncnronizer service account.
  8. To verify that the service account was set, use the following command to call the API to get a list of service accounts:
    curl -X POST -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type:application/json" \
      "$ORG_NAME:getSyncAuthorization" \
       -d ''

    The output looks similar to the following:


Apply the configuration to the cluster

Use the following steps to install Apigee hybrid into your cluster:

  1. Be sure that you are in the hybrid-base-directory/hybrid-files directory.
  2. Verify that kubectl is set to the correct context using the following command. The current context should be set to the cluster to which you are deploying Apigee hybrid.
    kubectl config get-contexts
  3. Do a dry run initialization. Execute the init command with the --dry-run flag. Doing a dry run lets you check for any errors before any changes are made to the cluster.

    In hybrid version 1.3, the syntax of the --dry-run flag depends on the version of kubectl you are running. Check the version of kubectl with the following command:

    kubectl version

    kubectl version 1.17 and older:

    $APIGEECTL_HOME/apigeectl init -f overrides/overrides.yaml --dry-run=true

    kubectl version 1.18 and newer:

    $APIGEECTL_HOME/apigeectl init -f overrides/overrides.yaml --dry-run=client
  4. If there are no errors, execute the init command as follows:
    $APIGEECTL_HOME/apigeectl init -f overrides/overrides.yaml

    The init command installs the Apigee deployment services Apigee Deployment Controller and Apigee Admission Webhook.

  5. To check the status of the deployment, you can use the following commands:
    $APIGEECTL_HOME/apigeectl check-ready -f overrides/overrides.yaml
    kubectl get pods -n apigee-system
    kubectl get pods -n istio-system

    When the pods are ready, go to the next step.

  6. Do a dry run install. Execute the apply command with the --dry-run flag.

    kubectl version 1.17 and older:

    $APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml --dry-run=true

    kubectl version 1.18 and newer:

    $APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml --dry-run=client
  7. If there are no errors, you can apply the Apigee-specific runtime components to the cluster with the following command:
    $APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml
  8. To check the status of the deployment, run the following command:
    $APIGEECTL_HOME/apigeectl check-ready -f overrides/overrides.yaml

    Repeat this step until the pods are all ready. The pods may take several minutes to start up.

Enable Apigee Connect

Apigee Connect manages communication between the Apigee management plane and MART in the runtime plane. For more information see Using Apigee Connect.

To enable Apigee Connect, do the following steps:

  1. On the command line, get your gcloud authentication credentials, as the following example shows:

    TOKEN=$(gcloud auth print-access-token)

    To check that your token was populated, use echo, as the following example shows:

    echo $TOKEN

    This should display your token as an encoded string.

    For more information, see gcloud command-line tool overview.

  2. Use the following command to see if Apigee Connect is enabled for your organization.
    curl -H "Authorization: Bearer $TOKEN" \

    Where $ORG_NAME is the ID of your organization.

    If the output contains the following:

          "name" : "features.mart.connect.enabled",
          "value" : "true"

    Apigee Connect is enabled and you can skip the rest of this section.

  3. Enable Apigee Connect with the following command:
    curl -H "Authorization: Bearer $TOKEN" -X PUT \
      -H "Content-Type: application/json" \
      -d '{
        "name" : "'"$ORG_NAME"'",
        "properties" : {
          "property" : [ {
            "name" : "features.hybrid.enabled",
            "value" : "true"
          }, {
            "name" : "features.mart.connect.enabled",
            "value" : "true"
          } ]
      }' \

    If the output contains the following properties, Apigee Connect was successfully enabled:

            "name": "features.mart.connect.enabled",
            "value": "true"
            "name": "features.hybrid.enabled",
            "value": "true"

    The output should look something like the following:

      "name": "hybrid-example-2",
      "createdAt": "1594409699772",
      "lastModifiedAt": "1594776283697",
      "environments": [
      "properties": {
        "property": [
            "name": "features.mart.connect.enabled",
            "value": "true"
            "name": "features.hybrid.enabled",
            "value": "true"
      "analyticsRegion": "us-central1",
      "runtimeType": "HYBRID",
      "subscriptionType": "TRIAL"