Supported versions:
Unsupported versions:
Starting with Apigee hybrid version 1.8, Apigee hybrid uses the Apigee ingress gateway to provide the ingress gateway for hybrid.
You can configure your ingress gateways in your overrides.yaml. For example:
ingressGateways:
- name: INGRESS_NAME
replicaCountMin: REPLICAS_MIN
replicaCountMax: REPLICAS_MAX
resources:
requests:
cpu: CPU_COUNT_REQ
memory: MEMORY_REQ
limits:
cpu: CPU_COUNT_LIMIT
memory: MEMORY_LIMIT
svcAnnotations: # optional.
SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE
svcLoadBalancerIP: SVC_LOAD_BALANCER_IP # optional
ingressGateways:
- name: prod1
replicaCountMin: 2
replicaCountMax: 100
resources:
requests:
cpu: 1
memory: 1Gi
limits:
cpu: 2
memory: 2Gi
svcAnnotations: # optional. See Known issue 243599452.
networking.gke.io/load-balancer-type: "Internal"
svcLoadBalancerIP: 198.252.0.123
See ingressGateways[].name
in the Configuration property reference
ingressGateways[].replicaCountMin and
ingressGateways[].replicaCountMax in the Configuration property reference.
See
ingressGateways[].resources.requests.cpu
and
ingressGateways[].resources.requests.memory
in the Configuration property reference.
See
ingressGateways[].resources.limits.cpu
and
ingressGateways[].resources.limits.memory
in the Configuration property reference.
This is a key-value pair that provides annotations for your default ingress service. Annotations are used by your cloud platform to help configure your hybrid installation, for example setting the loadbalancer type to either internal or external. For example:
ingressGateways:
svcAnnotations:
networking.gke.io/load-balancer-type: "Internal"Annotations vary from platform to platform. Refer to your platform documentation for required and suggested annotations.
SeeingressGateways[].svcAnnotations in the Configuration property reference.ingressGateways[].svcLoadBalancerIP in the Configuration property reference.
Apply changes to the organization scope with apigeectl.
$APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml --org
Some common management tasks for the Apigee ingress gateway:
After upgrading to Apigee hybrid v1.8 and migrating traffic to Apigee ingress gateway, you can stop supplying routing configuration to Anthos Service Mesh.
Update the Apigee controller to stop updating Anthos Service Mesh CR objects in the API server. In your overrides file, set:
ao:
args:
disableIstioConfigInAPIServer: trueApply the configuration changes:
$APIGEECTL_HOME/apigeectl init -f OVERRIDES_FILE
See ao in the
Configuration properties reference for details.
$APIGEECTL_HOME/apigeectl check-ready -f OVERRIDES_FILE
Update the virtualhosts. Every virtual host needs to include the
app selector label with the value app: apigee-ingressgateway. With this
change, Anthos Service Mesh gateway won't be able to read Apigee routing configuration.
Add or replace the selector property in each virtual host as follows:
virtualhosts:
- name: ENV_GROUP
selector:
app: apigee-ingressgateway # required
...
Apply the configuration changes:
$APIGEECTL_HOME/apigeectl apply -f OVERRIDES_FILE --settings virtualhosts
For more information see virtualhosts.selector
in the Configuration property reference.
Update the following properties in your overrides file.
ingressGateways[].replicaCountMaxingressGateways[].replicaCountMin
See ingressGateways in the
Configuration properties reference for details.
Apply the changes with apigeectl apply --org.
Update the following properties in your overrides file.
ingressGateways[].resources.limits.cpuingressGateways[].resources.limits.memoryingressGateways[].resources.requests.cpuingressGateways[].resources.requests.memory
See ingressGateways in the
Configuration properties reference for details.
Apply the changes with apigeectl apply --org.
Update the following properties in your overrides file.
ingressGateways[].svcAnnotationsingressGateways[].svcLoadBalancerIP
See ingressGateways in the
Configuration properties reference for details.
Apply the changes with apigeectl apply --org.
If you create a custom Kubernetes service
for your ingress gateway deployment, you can disable creation of a load balanceer on the default
Kubernetes service. Update the
ingressGateways[].svcType
property to ClusterIP in your overrides file. For example:
ingressGateways:
- name: my-ingress-gateway
replicaCountMin: 2
replicaCountMax: 10
svcType: ClusterIP
Apply the changes with apigeectl apply --org.
See Configuring TLS and mTLS on the ingress gateway.
See Enable non-SNI and HTTP clients.
In the overrides.yaml file you can add multiple ingress gateways. The
ingressGateways configuration property is an array. For more information, see
ingressGateways in the
Configuration properties reference.
For example:
ingressGateways: - name: fruit replicaCountMin: 2 replicaCountMax: 10 - name: meat replicaCountMin: 2 replicaCountMax: 10
Apply the changes with apigeectl apply --org.
You can target a labeled Apigee ingress gateway to a specific virtual host in your overrides file.
This configuration specifies the ingress gateway where Apigee will apply the virtual host's configuration. In
the following example, the virtual host spam-vh is configured to use
the ingress gateway labeled meat and the other two virtual hosts use
the fruit ingress gateway. The ingress gateways must be properly labeled, as explained in
Installing additional Anthos Service Mesh gateways.
virtualhosts:
- name: spam-vh
sslCertPath: cert-spam.crt
sslKeyPath: cert-spam.key
selector:
app: apigee-ingressgateway
ingress_name: meat
- name: banana-vh
sslCertPath: cert-banana.crt
sslKeyPath: cert-banana.key
selector:
app: apigee-ingressgateway
ingress_name: fruit
- name: plum-vh
sslCertPath: cert-plum.crt
sslKeyPath: cert-plum.key
selector:
app: apigee-ingressgateway
ingress_name: fruit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-07-23 UTC.