Ingress Gateways
In a Kubernetes environment, the Kubernetes Ingress Resource1
is used to specify services that should be exposed outside the cluster.
In an Istio service mesh, a better approach (which also works in both Kubernetes and other environments) is to use a
different configuration model, namely Istio Gateway2.
A Gateway
allows Istio features such as monitoring and route rules to be applied to traffic entering the cluster.
This task describes how to configure Istio to expose a service outside of the service mesh using an Istio Gateway
.
Before you begin
Setup Istio by following the instructions in the Installation guide3.
Make sure your current directory is the
istio
directory.
Start the httpbin4 sample.
If you have enabled automatic sidecar injection, deploy the
httpbin
service:Otherwise, you have to manually inject the sidecar before deploying the
httpbin
application:
- Determine the ingress IP and ports as described in the following subsection.
Determining the ingress IP and ports
Execute the following command to determine if your Kubernetes cluster is running in an environment that supports external load balancers:
If the EXTERNAL-IP
value is set, your environment has an external load balancer that you can use for the ingress gateway.
If the EXTERNAL-IP
value is <none>
(or perpetually <pending>
), your environment does not provide an external load balancer for the ingress gateway.
In this case, you can access the gateway using the service’s node port.
Choose the instructions corresponding to your environment:
Follow these instructions if you have determined that your environment has an external load balancer.
Set the ingress IP and ports:
Follow these instructions if you have determined that your environment does not have an external load balancer, so you need to use a node port instead.
Set the ingress ports:
Setting the ingress IP depends on the cluster provider:
GKE:
You need to create firewall rules to allow the TCP traffic to the ingressgateway service’s ports. Run the following commands to allow the traffic for the HTTP port, the secure port (HTTPS) or both:
Minikube:
Docker For Desktop:
Other environments (e.g., IBM Cloud Private etc):
Configuring ingress using an Istio gateway
An ingress Gateway2 describes a load balancer operating at the edge of the mesh that receives incoming HTTP/TCP connections. It configures exposed ports, protocols, etc. but, unlike Kubernetes Ingress Resources1, does not include any traffic routing configuration. Traffic routing for ingress traffic is instead configured using Istio routing rules, exactly in the same way as for internal service requests.
Let’s see how you can configure a Gateway
on port 80 for HTTP traffic.
Create an Istio
Gateway
:Configure routes for traffic entering via the
Gateway
:You have now created a virtual service6 configuration for the
httpbin
service containing two route rules that allow traffic for paths/status
and/delay
.The gateways list specifies that only requests through your
httpbin-gateway
are allowed. All other external requests will be rejected with a 404 response.Access the httpbin service using curl:
Note that you use the
-H
flag to set the Host HTTP header to “httpbin.example.com”. This is needed because your ingressGateway
is configured to handle “httpbin.example.com”, but in your test environment you have no DNS binding for that host and are simply sending your request to the ingress IP.Access any other URL that has not been explicitly exposed. You should see an HTTP 404 error:
Accessing ingress services using a browser
Entering the httpbin
service URL in a browser won’t work because you can’t pass the Host header
to a browser like you did with curl
. In a real world situation, this is not a problem
because you configure the requested host properly and DNS resolvable. Thus, you use the host’s domain name
in the URL, for example, https://httpbin.example.com/status/200
.
To work around this problem for simple tests and demos, use a wildcard *
value for the host in the Gateway
and VirtualService
configurations. For example, if you change your ingress configuration to the following:
You can then use $INGRESS_HOST:$INGRESS_PORT
in the browser URL. For example,
http://$INGRESS_HOST:$INGRESS_PORT/headers
will display all the headers that your browser sends.
Understanding what happened
The Gateway
configuration resources allow external traffic to enter the
Istio service mesh and make the traffic management and policy features of Istio
available for edge services.
In the preceding steps, you created a service inside the service mesh and exposed an HTTP endpoint of the service to external traffic.
Troubleshooting
Inspect the values of the
INGRESS_HOST
andINGRESS_PORT
environment variables. Make sure they have valid values, according to the output of the following commands:Check that you have no other Istio ingress gateways defined on the same port:
Check that you have no Kubernetes Ingress resources defined on the same IP and port:
If you have an external load balancer and it does not work for you, try to access the gateway using its node port.
Cleanup
Delete the Gateway
and VirtualService
configuration, and shutdown the httpbin4 service: