Deploy Hybrid to your cluster

Use the Apigee Hybrid command line interface apigeectl to apply the overrides you configured to your cluster:

  1. Add the CLI executable apigeectl to your PATH. The apigeectl executable is in the root directory of the Hybrid installer download directory. For example:
    cd apigee-hybrid-setup
    export PATH=$PATH:$PWD
  2. If you're on GKE, be sure to fetch your cluster credentials before you run apigeectl. See the section below Fetch credentials for GKE.
  3. Execute the following command:
    apigeectl apply -v beta2

    The pods running Hybrid services in your runtime cluster may take a several minutes to start up and achieve the Ready state.

    If you get an error, see Troubleshooting.

  4. To check the status of your deployment, use the following kubectl command:
    kubectl get pods -n your_namespace

    Repeat this step until the pods are all running.

    The STATUS column for each pod shows Running or Completed when the pods are started. The READY column shows when each instance of a pod container is ready. For example, a READY status of 2/2 means both containers are ready. If you see 0/2 or 1/2, you need to wait a little longer for them to full intialize.

    The following apigeectl command also tells you when all of the pod containers are ready:

    apigeectl check-ready -v beta2

    When hybrid has deployed and all pods are running, apigeectl check-ready returns the following output:

    All containers ready in namespace 'your_namespace'
  5. Go to the next step, Add the MART IP to your org.

(GKE only) Fetch credentials for GKE

If you are on GKE, you need to fetch your cluster credentials. Cluster credentials let you manage your Google Kubernetes Engine (GKE) cluster with kubectl from a local terminal window.

  1. Get your gcloud container credentials:
    gcloud container clusters get-credentials cluster_name --region region_name \
        --project project_id


    • cluster_name is the name of the Kubernetes cluster you created.
    • region_name is the region where your cluster is located. If you set up a zonal cluster, use the parameter --zone zone_name instead of --region.
    • project_id is your GCP project ID.

      For example:

      gcloud container clusters get-credentials my-cluster --region us-central1 \
              --project my-project
  2. Execute the following command exactly as shown:
    kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin \
        --user=$(gcloud config get-value core/account)

    This command grants cluster admin permissions to the current user.


This section describes a common issue that you might encounter when you try to install hybrid.

Next Step

1 2 3 4 5 6 7 8 9 10 NEXT: 11: MART IP