> [!CAUTION]
> 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, see [Supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions).

<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.8 (unsupported)</button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/managing-ingress.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/managing-ingress.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/managing-ingress.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/managing-ingress.md.txt)
- [List of supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions)
- Unsupported versions:
- [v1.13](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/managing-ingress.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/managing-ingress.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/managing-ingress.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/managing-ingress.md.txt)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/managing-ingress.md.txt)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/managing-ingress.md.txt)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/managing-ingress.html)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/managing-ingress.html)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/managing-ingress.html)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/managing-ingress.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/managing-ingress.html)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/managing-ingress.html)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/managing-ingress.html)


Starting with Apigee hybrid version 1.8, Apigee hybrid uses the Apigee ingress gateway to provide
the ingress gateway for hybrid.

## Configuring Apigee ingress gateway

You can configure your ingress gateways in your `overrides.yaml`. For example:

### Syntax

```
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
```

### Example

```
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 
```

- <var translate="no">INGRESS_NAME</var> is the name of the ingress gateway deployment. This can be any name that meets the following requirements:
  - Have a maximum length of 17 characters
  - Contain only lowercase alphanumeric characters, '-' or '.'
  - Start with an alphanumeric character
  - End with an alphanumeric character


  See [`ingressGateways[].name`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-name)
  in the Configuration property reference
- <var translate="no">REPLICAS_MIN</var> and <var translate="no">REPLICAS_MAX</var> The minimum and maximum replica counts for Apigee ingress gateway in your installation. See [`ingressGateways[].replicaCountMin`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-replicacountmin) and [`ingressGateways[].replicaCountMax`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-replicacountmax) in the Configuration property reference.
- <var translate="no">CPU_COUNT_REQ</var> and <var translate="no">MEMORY_REQ</var> The CPU and memory request for each replica of Apigee ingress gateway in your installation.

  > [!NOTE]
  > Set these properties if you have previously set them for your Anthos Service Mesh ingress gateway, for example in your `overlay.yaml` file.


  See
  [`ingressGateways[].resources.requests.cpu`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-resources-requests-cpu)
  and
  [`ingressGateways[].resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-resources-requests-memory)
  in the Configuration property reference.
- <var translate="no">CPU_COUNT_LIMIT</var> and <var translate="no">MEMORY_LIMIT</var> The maximum CPU and memory limits for each replica of Apigee ingress gateway in your installation.

  > [!NOTE]
  > Set these properties if you have previously set them for your Anthos Service Mesh ingress gateway, for example in your `overlay.yaml` file.


  See
  [`ingressGateways[].resources.limits.cpu`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-resources-limits-cpu)
  and
  [`ingressGateways[].resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-resources-limits-memory)
  in the Configuration property reference.
- <var translate="no">SVC_ANNOTATIONS_KEY</var> <var translate="no">SVC_ANNOTATIONS_VALUE</var> (optional):

  > [!NOTE]
  > **Note:** The `ingressGateways[].svcAnnotations` field in `overrides.yaml` is not working as expected. See [Known issue 243599452](https://docs.cloud.google.com/apigee/docs/release/known-issues.md.txt#243599452)


  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.

  > [!NOTE]
  > **Note:** You do not need to set `Annotations` here if you are creating your own Kubernetes service for ingress gateway deployment as documented in [Expose Apigee ingress gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-expose-apigee-ingress.md.txt).

  See [`ingressGateways[].svcAnnotations`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-svcannotations) in the Configuration property reference.
- <var translate="no">SVC_LOAD_BALANCER_IP</var> (optional). On platforms that support specifying the load balancer IP address, the load balancer will be created with this IP address. On platforms that do not allow you to specify the load balancer IP address, this property is ignored.

  > [!CAUTION]
  > **Caution:** Make sure not to specify the same IP address as the current istio-ingressgateway. This could cause problems while that service is still on the cluster.

  > [!NOTE]
  > **Note:** You do not need to set `LoadBalancerIP` if you are creating your own Kubernetes service for ingress gateway deployment as documented in [Expose Apigee ingress gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-expose-apigee-ingress.md.txt).

  See [`ingressGateways[].svcLoadBalancerIP`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-svcloadbalancerip) in the Configuration property reference.

### Apply the Apigee ingress gateway configuration


Apply changes to the organization scope with `apigeectl`.

```
$APIGEECTL_HOME/apigeectl apply -f overrides/overrides.yaml --org
```

## Management tasks

Some common management tasks for the Apigee ingress gateway:

### Stop supplying configuration to ASM


After upgrading to Apigee hybrid v1.8 and migrating traffic to Apigee ingress gateway, you can stop
supplying routing configuration to Anthos Service Mesh.

1.
   Update the Apigee controller to stop updating Anthos Service Mesh CR objects in the API server.
   In your overrides file, set:

   ```
   ao:
     args:
       disableIstioConfigInAPIServer: true
   ```
2. Apply the configuration changes:

```
$APIGEECTL_HOME/apigeectl init -f OVERRIDES_FILE
```
3. See [`ao`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ao) in the Configuration properties reference for details.
4. Check the status of the deployment with the following command, because the previous command restarted the controller:

   ```
   $APIGEECTL_HOME/apigeectl check-ready -f OVERRIDES_FILE
   ```
5.
   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`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#virtualhosts-selector)
   in the Configuration property reference.

### Scaling Apigee ingress gateway:


Update the following properties in your overrides file.

- `ingressGateways[].replicaCountMax`
- `ingressGateways[].replicaCountMin`


See [`ingressGateways`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways) in the
Configuration properties reference for details.


Apply the changes with `apigeectl apply --org`.

### Updating resource allocation


Update the following properties in your overrides file.

- `ingressGateways[].resources.limits.cpu`
- `ingressGateways[].resources.limits.memory`
- `ingressGateways[].resources.requests.cpu`
- `ingressGateways[].resources.requests.memory`


See [`ingressGateways`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways) in the
Configuration properties reference for details.


Apply the changes with `apigeectl apply --org`.

### Updating the Apigee ingress gateway service


Update the following properties in your overrides file.

- `ingressGateways[].svcAnnotations`
- `ingressGateways[].svcLoadBalancerIP`


See [`ingressGateways`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways) in the
Configuration properties reference for details.


Apply the changes with `apigeectl apply --org`.

### Disable the load balancer for the default Apigee ingress gateway service:


If you create a [custom Kubernetes service](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-expose-apigee-ingress.md.txt#customservice)
for your ingress gateway deployment, you can disable creation of a load balanceer on the default
Kubernetes service. Update the
[`ingressGateways[].svcType`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#ingressgateways-svctype)
property to `ClusterIP` in your overrides file. For example:

```
ingressGateways:
  - name: my-ingress-gateway
    replicaCountMin: 2
    replicaCountMax: 10
    svcType: ClusterIP
```

<br />


Apply the changes with `apigeectl apply --org`.

### Configure TLS and mTLS


See [Configuring TLS and mTLS on the ingress gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/ingress-tls.md.txt).

### Enabling non-SNI clients


See [Enable non-SNI and HTTP clients](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/enable-non-sni.md.txt).

### Installing additional Apigee ingress gateways


In the `overrides.yaml` file you can add multiple ingress gateways. The
`ingressGateways` configuration property is an array. For more information, see
[ingressGateways](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#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`.

### Targeting an Apigee ingress to a virtual host

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](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/managing-ingress.md.txt#installing).

> [!NOTE]
> **Note:** You must specify both the `selector:app` and `selector:ingress_name` properties to properly apply an ingress gateway to a virtual host.

```
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

    
```

## FAQ


How does this work with my existing Anthos Service Mesh/Istio installation in another namespace?
:
    As long as Apigee is installed in a dedicated namespace - Apigee ingress gateway can be run
    alongside an already existing Anthos Service Mesh/Istio installation in the cluster. Apigee ingress gateway
    doesn't store any configuration in apiserver hence there won't be any conflict.


Who is responsible for upgrading Apigee ingress gateway components?
:
    Upgrade of Apigee ingress gateway components is taken care of by Apigee and happens during regular
    hybrid upgrades and patch releases.


How do I expose port 80 in Apigee ingress gateway?
:
    Port 80 is not supported by Apigee ingress gateway. If you are migrating from Anthos Service Mesh to
    Apigee ingress gateway, and followed the instructions in
    [the
    community post](https://www.googlecloudcommunity.com/gc/Cloud-Product-Articles/Apigee-hybrid-ingress-Three-different-options-to-expose-your/ta-p/79149) to enable Port 80, it will not work with Apigee Ingress gateway.