Step 8: Install hybrid runtime

You are currently viewing version 1.8 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

Apply the configuration to the cluster

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

  1. Be sure that you are in thehybrid-base-directory/hybrid-files directory.
    cd $HYBRID_FILES
    Note: Because the overrides file specifies service account files using paths relative to yourhybrid-base-directory/hybrid-files directory, you must execute the commands from within that directory.
  2. Verify thatkubectl 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 | grep \*
  3. ForAnthos on bare metal,AWS on GKE,EKS, andGKE on prem platforms only, Verify that theKUBECONFIG variable is set using the following command.
    echo ${KUBECONFIG}
  4. Do adry run initialization. Doing a dry run lets you check for any errors before any changes are made to the cluster. Execute theinit command with the--dry-run flag as follows:
    ${APIGEECTL_HOME}/apigeectl init -f overrides/overrides.yaml --dry-run=client
    Note: Apigee hybrid 1.8 supportskubectl version 1.21 and newer. If you are installing an older version of hybrid and usingkubectl version 1.8 or older the syntax for the--dry-run flag will be--dry-run=true. You will need to update yourkubectl to version 1.21 or newer before installing Apigee hybrid 1.8.
  5. If there are no errors, execute theinit command as follows:
    ${APIGEECTL_HOME}/apigeectl init -f overrides/overrides.yaml

    Theinit command installs theApigee deployment services Apigee Deployment Controller and Apigee Admission Webhook.

  6. 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 apigee

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

  7. Do adry run install. Execute theapply command with the--dry-run flag.
    ${APIGEECTL_HOME}/apigeectl apply -f overrides/overrides.yaml --dry-run=client
  8. 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
  9. 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.

Congratulations!

You've successfully installed and configured the Apigee hybrid runtime plane. Now it's time to connect it to the outside world.

12345678(NEXT) Step 9: Expose Apigee ingress10

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-18 UTC.