Set up the Istio Gateway

The gateway to each cluster can have its own port or load balancer, which is unrelated to a service mesh. By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster.

You can use the Nginx Ingress controller with or without Istio installed. If this is the only gateway to your cluster, Istio will be able to route traffic from service to service, but Istio will not be able to receive traffic from outside the cluster.

To allow Istio to receive external traffic, you need to enable Istio's gateway, which works as a north-south proxy for external traffic. When you enable the Istio gateway, the result is that your cluster will have two Ingresses.

You will also need to set up a Kubernetes gateway for your services. This Kubernetes resource points to Istio's implementation of the ingress gateway to the cluster.

You can route traffic into the service mesh with a load balancer or use Istio's NodePort gateway. This section describes how to set up the NodePort gateway.

For more information on the Istio gateway, refer to the Istio documentation.

Enable an Istio Gateway

The ingress gateway is a Kubernetes service that will be deployed in your cluster. The Istio Gateway allows for more extensive customization and flexibility.

1. Click ☰ > Cluster Management.
2. Go to the cluster that you created and click Explore.
3. In the left navigation bar, click Istio > Gateways.
4. Click Create from Yaml.
5. Paste your Istio Gateway yaml, or Read from File.
6. Click Create.

Result: The gateway is deployed, and will now route traffic with applied rules.

Example Istio Gateway

We add the BookInfo app deployments in services when going through the Workloads example. Next we add an Istio Gateway so that the app is accessible from outside your cluster.

1. Click ☰ > Cluster Management.
2. Go to the cluster that you created and click Explore.
3. In the left navigation bar, click Istio > Gateways.
4. Click Create from Yaml.
5. Copy and paste the Gateway yaml provided below.
6. Click Create.

apiVersion: networking.istio.io/v1alpha3
kind: Gateway
metadata:
  name: bookinfo-gateway
spec:
  selector:
    istio: ingressgateway # use istio default controller
  servers:
  - port:
      number: 80
      name: http
      protocol: HTTP
    hosts:
    - "*"
---

Then to deploy the VirtualService that provides the traffic routing for the Gateway:

1. Click ☰ > Cluster Management.
2. Go to the cluster that you created and click Explore.
3. In the left navigation bar, click Istio > VirtualServices.
4. Copy and paste the VirtualService yaml provided below.
5. Click Create.

apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
  name: bookinfo
spec:
  hosts:
  - "*"
  gateways:
  - bookinfo-gateway
  http:
  - match:
    - uri:
        exact: /productpage
    - uri:
        prefix: /static
    - uri:
        exact: /login
    - uri:
        exact: /logout
    - uri:
        prefix: /api/v1/products
    route:
    - destination:
        host: productpage
        port:
          number: 9080

Result: You have configured your gateway resource so that Istio can receive traffic from outside the cluster.

Confirm that the resource exists by running:

kubectl get gateway -A

The result should be something like this:

NAME               AGE
bookinfo-gateway   64m

Access the ProductPage Service from a Web Browser

To test and see if the BookInfo app deployed correctly, the app can be viewed a web browser using the Istio controller IP and port, combined with the request name specified in your Kubernetes gateway resource:

http://<IP of Istio controller>:<Port of istio controller>/productpage

To get the ingress gateway URL and port,

1. Click ☰ > Cluster Management.
2. Go to the cluster that you created and click Explore.
3. In the left navigation bar, click Workload.
4. Scroll down to the istio-system namespace.
5. Within istio-system, there is a workload named istio-ingressgateway. Under the name of this workload, you should see links, such as 80/tcp.
6. Click one of those links. This should show you the URL of the ingress gateway in your web browser. Append /productpage to the URL.

Result: You should see the BookInfo app in the web browser.

For help inspecting the Istio controller URL and ports, try the commands the Istio documentation.

Troubleshooting

The official Istio documentation suggests kubectl commands to inspect the correct ingress host and ingress port for external requests.

Confirming that the Kubernetes Gateway Matches Istio's Ingress Controller

You can try the steps in this section to make sure the Kubernetes gateway is configured properly.

In the gateway resource, the selector refers to Istio's default ingress controller by its label, in which the key of the label is istio and the value is ingressgateway. To make sure the label is appropriate for the gateway, do the following:

1. Click ☰ > Cluster Management.
2. Go to the cluster that you created and click Explore.
3. In the left navigation bar, click Workload.
4. Scroll down to the istio-system namespace.
5. Within istio-system, there is a workload named istio-ingressgateway. Click the name of this workload and go to the Labels and Annotations section. You should see that it has the key istio and the value ingressgateway. This confirms that the selector in the Gateway resource matches Istio's default ingress controller.

Next: Set up Istio's Components for Traffic Management