Quick Start with Google Kubernetes Engine

Quick Start instructions to install and run Istio in Google Kubernetes Engine (GKE) using Google Cloud Deployment Manager.

This Quick Start creates a new GKE zonal cluster, installs the current release version of Istio and then deploys the Bookinfo sample application. It uses Deployment Manager to automate the steps detailed in the Istio on Kubernetes setup guide for Kubernetes Engine

Prerequisites

  • This sample requires a valid Google Cloud Platform project with billing enabled. If you are not an existing GCP user, you may be able to enroll for a $300 US Free Trial credit.

  • Ensure that the Google Kubernetes Engine API is enabled for your project (also found by navigating to “APIs & Services” -> “Dashboard” in the navigation bar). If you do not see “API enabled”, then you may enable the API by clicking the “Enable this API” button.

  • You must install and configure the gcloud command line tool and include the kubectl component (gcloud components install kubectl). If you don’t want to install the gcloud client on your own machine, you can use gcloud via Google Cloud Shell to perform the same tasks.

  • Warning You must set your default compute service account to include:

    • roles/container.admin (Kubernetes Engine Admin)
    • Editor (on by default)

To set this up, navigate to the IAM section of the Cloud Console as shown below and find your default GCE/GKE service account in the following form: projectNumber-compute@developer.gserviceaccount.com: by default it should just have the Editor role. Then in the Roles drop-down list for that account, find the Kubernetes Engine group and select the role Kubernetes Engine Admin. The Roles listing for your account will change to Multiple.

GKE-IAM Service
GKE-IAM Service

Then add the Kubernetes Engine Admin role:

GKE-IAM Role
GKE-IAM Role

Setup

Launch Deployment Manager

  1. Once you have an account and project enabled, click the following link to open the Deployment Manager.

    Istio GKE Deployment Manager

    We recommend that you leave the default settings as the rest of this tutorial shows how to access the installed features. By default the tool creates a GKE alpha cluster with the specified settings, then installs the Istio control plane, the Bookinfo sample app, Grafana with Prometheus, ServiceGraph, and Tracing. You’ll find out more about how to access all of these below. This script will enable Istio auto-injection on the default namespace only.

  2. Click Deploy:

    GKE-Istio Launcher
    GKE-Istio Launcher

Wait until Istio is fully deployed. Note that this can take up to five minutes.

Bootstrap gcloud

Once deployment is complete, do the following on the workstation where you’ve installed gcloud:

  1. Bootstrap kubectl for the cluster you just created and confirm the cluster is running and Istio is enabled

    $ gcloud container clusters list
    NAME           LOCATION       MASTER_VERSION  MASTER_IP      MACHINE_TYPE   NODE_VERSION  NUM_NODES  STATUS
    istio-cluster  us-central1-a  1.9.7-gke.1     35.232.222.60  n1-standard-2  1.9.7-gke.1   4          RUNNING
    

    In this case, the cluster name is istio-cluster

  2. Now acquire the credentials for this cluster

    $ gcloud container clusters get-credentials istio-cluster --zone=us-central1-a
    

Verify installation

Verify Istio is installed in its own namespace

$ kubectl get deployments,ing -n istio-system
NAME                              DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
deploy/grafana                    1         1         1            1           4m
deploy/istio-citadel              1         1         1            1           4m
deploy/istio-egressgateway        1         1         1            1           4m
deploy/istio-ingress              1         1         1            1           4m
deploy/istio-ingressgateway       1         1         1            1           4m
deploy/istio-pilot                1         1         1            1           4m
deploy/istio-policy               1         1         1            1           4m
deploy/istio-sidecar-injector     1         1         1            1           4m
deploy/istio-statsd-prom-bridge   1         1         1            1           4m
deploy/istio-telemetry            1         1         1            1           4m
deploy/prometheus                 1         1         1            1           4m
deploy/servicegraph               1         1         1            1           4m

Now confirm that the Bookinfo sample application is also installed:

$ kubectl get deployments,ing
NAME                    DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
deploy/details-v1       1         1         1            1           7m
deploy/productpage-v1   1         1         1            1           7m
deploy/ratings-v1       1         1         1            1           7m
deploy/reviews-v1       1         1         1            1           7m
deploy/reviews-v2       1         1         1            1           7m
deploy/reviews-v3       1         1         1            1           7m

Now get the istio-ingressgateway IP:

$ kubectl get svc istio-ingressgateway -n istio-system
NAME                   TYPE           CLUSTER-IP      EXTERNAL-IP    PORT(S)                                      AGE
istio-ingressgateway   LoadBalancer   10.59.251.109   35.194.26.85   80:31380/TCP,443:31390/TCP,31400:31400/TCP   6m

Note down the IP and Port assigned to Bookinfo product page. (in the example above, its 35.202.120.89:80.

You can also view the installation using the *Kubernetes Engine -> Workloads section on the Cloud Console:

GKE-Workloads
GKE-Workloads

Access the Bookinfo sample

  1. Set up an environment variable for Bookinfo’s external IP address:

    $ export GATEWAY_URL=$(kubectl -n istio-system get service istio-ingressgateway -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
    
    $ echo $GATEWAY_URL
    
  2. Verify you can access the Bookinfo http://${GATEWAY_URL}/productpage:

    Bookinfo
    Bookinfo
  3. Now send some traffic to it:

    $ for i in {1..100}; do curl -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/productpage; done
    

Verify installed Istio plugins

Once you have verified that the Istio control plane and sample application are working, try accessing the installed Istio plugins.

If you are using Cloud Shell rather than the installed gcloud client, you can port forward and proxy using its Web Preview feature. For example, to access Grafana from Cloud Shell, change the kubectl port mapping from 3000:3000 to 8080:3000. You can simultaneously preview four other consoles via Web Preview proxied on ranges 8080 to 8084.

Grafana

Set up a tunnel to Grafana:

$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=grafana -o jsonpath='{.items[0].metadata.name}') 3000:3000 &

then

http://localhost:3000/dashboard/db/istio-dashboard

You should see some statistics for the requests you sent earlier.

Grafana
Grafana

For more details about using Grafana, see About the Grafana Add-on.

Prometheus

Prometheus is installed with Grafana. You can view Istio and application metrics using the console as follows:

$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 &

View the console at:

http://localhost:9090/graph
Prometheus
Prometheus

For more details, see About the Prometheus Add-on.

ServiceGraph

Set up a tunnel to ServiceGraph:

$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=servicegraph -o jsonpath='{.items[0].metadata.name}') 8088:8088 &

You should see the Bookinfo service topology at

http://localhost:8088/dotviz
ServiceGraph
ServiceGraph

For more details, see About the ServiceGraph Add-on.

Tracing

Set up a tunnel to the tracing dashboard:

$ kubectl port-forward -n istio-system $(kubectl get pod -n istio-system -l app=jaeger -o jsonpath='{.items[0].metadata.name}') 16686:16686 &

You should see the trace statistics sent earlier on http://localhost:16686

Tracing Dashboard
Tracing Dashboard

For more details on tracing see Understanding what happened.

What’s next

You can further explore the Bookinfo app and Istio functionality by following any of the tutorials in the Guides section. However, to do this you need to install istioctl to interact with Istio. You can either install it directly on our workstation or within Cloud Shell.

Uninstalling

  1. Navigate to the Deployments section of the Cloud Console at https://console.cloud.google.com/deployments

  2. Select the deployment and click Delete.

  3. Deployment Manager will remove all the deployed GKE artifacts - however, items such as Ingress and LoadBalancers will remain. You can delete those artifacts by again going to the cloud console under Network Services -> LoadBalancers