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.

This topic explains how to enable non-SNI clients, HTTP clients, and a combination of both for use with Apigee hybrid.

This configuration works for both Apigee ingress gateway and Anthos Service Mesh.

How to configure a non-SNI client

This section explains how to enable support for non-SNI (Server Name Indication) clients in Apigee hybrid. A non-SNI client uses port 443 and is required if you want to integrate hybrid runtime instances with GoogleCloud Load Balancing or for clients that do not support SNI.

1. Create an ApigeeRoute custom resource definition (CRD). Be sure thatenableNonSniClient is set totrue:

   apiVersion:apigee.cloud.google.com/v1alpha1kind:ApigeeRoutemetadata:name:ROUTE_NAMEnamespace:apigeespec:hostnames:-"*"ports:-number:443protocol:HTTPStls:credentialName:CREDENTIAL_NAMEmode:SIMPLE#optionalminProtocolVersion:TLS_AUTOselector:app:APP_NAMEenableNonSniClient:true

   Where:

   • ROUTE_NAME is the name you give to the CRD.
   • CREDENTIAL_NAME is the name of a Kubernetes Secret deployed to the cluster that contains TLS credentials for your virtualhost. You can find the credential name with the followingkubectl Command:

     kubectl -n apigee get ApigeeRoutes -o=yaml | grep credentialName

   • APP_NAME Identifies the type of ingress gateway:
     • apigee-ingressgateway for Apigee ingress gateway.
     • istio-ingressgateway for Anthos Service Mesh.
   • hostnames must be set to the wildcard"*".Note:Do not create two ApigeeRoute objects with a wildcard"*" hostname.
2. Open your overrides file and make the change described in the next step.
3. For each environment group, add the ApigeeRoute name to theadditionalGateways property. For example:

   virtualhosts:- name: default    sslCertPath: ./certs/fullchain.pem    sslKeyPath: ./certs/privkey.pem    additionalGateways: ["route_name"]

4. Save the CRD file. For example:ApigeeRoute.yaml
5. Apply the CRD to the cluster:

   kubectl apply -f ApigeeRoute.yaml -n apigee

6. Apply the change tovirtualhosts:

   $APIGEECTL_HOME/apigeectl apply -foverrides.yaml --settings virtualhosts --env$ENVIRONMENT

Usage notes

• What happens if the cluster has more than one org?

  Since the ingress is at the cluster level for a given port (443), and there can only be one key/cert pair for the ApigeeRoute CRD, all orgs must share the same key/cert pair.

• What happens if the cluster has more than one environment group. Will it work if the virtual hosts share the same key/cert pair?

  All hostnames across all environment groups must use the same key/cert pair.

• Why are we creating an ApigeeRoute instead of Gateway?

  ApigeeRoutes can be validated by Apigee; however,Gateway (the Istio CRD) cannot be. Technically, even Gateway can work, but we can prevent potential configuration mistakes (through a validation webhook).

Enable HTTP clients

This section explains support for HTTP clients for use with Apigee hybrid.

Note: We do not recommend enabling port 80. All transmission, especially API traffic, should be over TLS (1.2 or higher).

1. Create an ApigeeRoute custom resource definition (CRD). For example:

   apiVersion:apigee.cloud.google.com/v1alpha1kind:ApigeeRoutemetadata:name:route_namenamespace:apigeespec:hostnames:-"*"ports:-number:80protocol:HTTPselector:app:istio-ingressgatewayenableNonSniClient:true

   Where:

   • route_name is the name you give to the CRD.
   • hostnames must be set to the wildcard "*".Note:Do not create two ApigeeRoute objects with a wildcard "*" hostname.
2. Open your overrides file and make the change described in the next step.
3. For each environment group, add the ApigeeRoute name to theadditionalGateways property. For example:

   virtualhosts:- name: default    sslCertPath: ./certs/fullchain.pem    sslKeyPath: ./certs/privkey.pem    additionalGateways: ["route_name"]

4. Save the CRD file. For example:ApigeeRoute.yaml
5. Apply the CRD to the cluster:

   kubectl apply -f ApigeeRoute.yaml -n apigee

6. Apply the change tovirtualhosts:

   $APIGEECTL_HOME/apigeectl apply -foverrides.yaml --settings virtualhosts --env$ENVIRONMENT

Enable support for both non-SNI and HTTP clients

This section explains how to enableboth non-SNI (port 443) and HTTP (port 80) clients for use with Apigee hybrid.

Note: We do not recommend enabling port 80. All transmission, especially API traffic, should be over TLS (1.2 or higher).

1. Create an ApigeeRoute custom resource definition (CRD). For example:

   apiVersion:apigee.cloud.google.com/v1alpha1kind:ApigeeRoutemetadata:name:route_namenamespace:apigeespec:hostnames:-"*"ports:-number:443protocol:HTTPStls:credentialName:credential_namemode:SIMPLE#optionalminProtocolVersion:TLS_AUTO-number:80protocol:HTTPselector:app:istio-ingressgatewayenableNonSniClient:true

   Where:

   • route_name is the name you give to the CRD.
   • hostname must be set to the wildcard "*".Note:Do not create two ApigeeRoute objects with a wildcard "*" hostname.
   • credential_name is the name of a Kubernetes Secret deployed to the cluster that contains TLS credentials for your virtualhost. You can find the credential name with the followingkubectl Command:

     kubectl -n apigee get ApigeeRoutes -o=yaml | grep credentialName

2. Open your overrides file and make the change described in the next step.
3. For each environment group, add the ApigeeRoute name to theadditionalGateways property. For example:

   virtualhosts:- name: default    sslCertPath: ./certs/fullchain.pem    sslKeyPath: ./certs/privkey.pem    additionalGateways: ["route_name"]

4. Save the CRD file. For example:ApigeeRoute.yaml
5. Apply the CRD to the cluster:

   kubectl apply -f ApigeeRoute.yaml -n apigee

6. Apply the change tovirtualhosts:

   $APIGEECTL_HOME/apigeectl apply -foverrides.yaml --settings virtualhosts --env$ENVIRONMENT