Step 9: Install hybrid runtime Stay organized with collections Save and categorize content based on your preferences.
Apply the configuration to the cluster
Use the following steps to install Apigee hybrid into your cluster:
- Be sure that you are in the
hybrid-base-directory/hybrid-filesdirectory. - Verify that
kubectlis 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 \*
- ForAnthos on bare metal,AWS on GKE,EKS, andGKE on prem platforms only, Verify that the
KUBECONFIGvariable is set using the following command.echo $KUBECONFIG
- Do adry run initialization. Execute the
initcommand with the--dry-runflag. Doing a dry run lets you check for any errors before any changes are made to the cluster.In hybrid version 1.5.10, the syntax of the
--dry-runflag depends on the version ofkubectlyou are running. Check the version ofkubectlwith the following command:kubectl version
kubectlversion 1.17 and older:$APIGEECTL_HOME/apigeectl init -f overrides/overrides.yaml --dry-run=true
kubectlversion 1.18 and newer:$APIGEECTL_HOME/apigeectl init -f overrides/overrides.yaml --dry-run=client
- If there are no errors, execute the
initcommand as follows:$APIGEECTL_HOME/apigeectl init -f overrides/overrides.yaml
The
initcommand installs theApigee deployment services Apigee Deployment Controller and Apigee Admission Webhook. - 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.
- Do adry run install. Execute the
applycommand with the--dry-runflag.kubectlversion 1.17 and older:$APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml --dry-run=true
kubectlversion 1.18 and newer:$APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml --dry-run=client
- 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
- 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.
You've successfully installed Apigee hybrid. You are now ready to test it.
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-19 UTC.