Getting Started Using Istio

This document serves as an introduction to using Cilium to enforce security policies in Kubernetes micro-services managed with Istio. It is a detailed walk-through of getting a single-node Cilium + Istio environment running on your machine.

If you haven’t read the Introduction to Cilium & Hubble yet, we’d encourage you to do that first.

The best way to get help if you get stuck is to ask a question on the Cilium Slack channel. With Cilium contributors across the globe, there is almost always someone available to help.

Setup Cilium

If you have not set up Cilium yet, pick any installation method as described in section Installation to set up Cilium for your Kubernetes environment. If in doubt, pick Getting Started Using Minikube as the simplest way to set up a Kubernetes cluster with Cilium:

  1. minikube start --network-plugin=cni --memory=4096
  2. minikube ssh -- sudo mount bpffs -t bpf /sys/fs/bpf
  3. kubectl create -f https://raw.githubusercontent.com/cilium/cilium/v1.8/install/kubernetes/quick-install.yaml

Note

If running on minikube, you may need to up the memory and CPUs available to the minikube VM from the defaults and/or the instructions provided here for the other GSGs. 5 GB and 4 CPUs should be enough for this GSG (--memory=5120 --cpus=4).

Step 2: Install cilium-istioctl

Note

Make sure that Cilium is running in your cluster before proceeding.

Download the cilium enhanced istioctl version 1.5.9:

Linux

OSX

  1. curl -L https://github.com/cilium/istio/releases/download/1.5.9/cilium-istioctl-1.5.9-linux.tar.gz | tar xz
  1. curl -L https://github.com/cilium/istio/releases/download/1.5.9/cilium-istioctl-1.5.9-osx.tar.gz | tar xz

Note

Cilium integration, as presented in this Getting Started Guide, has been tested with Kubernetes releases 1.14, 1.15, 1.16, 1.17, and 1.18. Note that this does not work with K8s 1.13.

Deploy the default Istio configuration profile onto Kubernetes:

  1. ./cilium-istioctl manifest apply -y

Add a namespace label to instruct Istio to automatically inject Envoy sidecar proxies when you deploy your application later:

  1. kubectl label namespace default istio-injection=enabled

Step 3: Deploy the Bookinfo Application V1

Now that we have Cilium and Istio deployed, we can deploy version v1 of the services of the Istio Bookinfo sample application.

While the upstream Istio Bookinfo Application example for Kubernetes deploys multiple versions of the Bookinfo application at the same time, here we first deploy only the version 1.

The BookInfo application is broken into four separate microservices:

  • productpage. The productpage microservice calls the details and reviews microservices to populate the page.
  • details. The details microservice contains book information.
  • reviews. The reviews microservice contains book reviews. It also calls the ratings microservice.
  • ratings. The ratings microservice contains book ranking information that accompanies a book review.

In this demo, each specific version of each microservice is deployed into Kubernetes using separate YAML files which define:

  • A Kubernetes Service.
  • A Kubernetes Deployment specifying the microservice’s pods, specific to each service version.
  • A Cilium Network Policy limiting the traffic to the microservice, specific to each service version.

../../_images/istio-bookinfo-v1.png

To deploy the application with manual sidecar injection, run:

  1. for service in productpage-service productpage-v1 details-v1 reviews-v1; do \
  2.       kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/bookinfo-${service}.yaml ; done

Check the progress of the deployment (every service should have an AVAILABLE count of 1):

  1. watch "kubectl get deployments"
  2. NAME             READY   UP-TO-DATE   AVAILABLE   AGE
  3. details-v1       1/1     1            1           12s
  4. productpage-v1   1/1     1            1           13s
  5. reviews-v1       1/1     1            1           12s

Create an Istio ingress gateway for the productpage service:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/bookinfo-gateway.yaml

To obtain the URL to the frontend productpage service, run:

  1. export GATEWAY_URL=http://$(minikube ip):$(kubectl -n istio-system get service istio-ingressgateway -o jsonpath='{.spec.ports[?(@.name=="http2")].nodePort}')
  2. export PRODUCTPAGE_URL=${GATEWAY_URL}/productpage
  3. open ${PRODUCTPAGE_URL}

Open that URL in your web browser and check that the application has been successfully deployed. It may take several seconds before all services become accessible in the Istio service mesh, so you may have have to reload the page.

Step 4: Canary and Deploy the Reviews Service V2

We will now deploy version v2 of the reviews service. In addition to providing reviews from readers, reviews v2 queries a new ratings service for book ratings, and displays each rating as 1 to 5 black stars.

As a precaution, we will use Istio’s service routing feature to canary the v2 deployment to prevent breaking the end-to-end application completely if it is faulty.

Before deploying v2, to prevent any traffic from being routed to it for now, we will create this Istio route rules to route 100% of the reviews traffic to v1:

  1. apiVersion: networking.istio.io/v1alpha3
  2. kind: VirtualService
  3. metadata:
  4.   name: reviews
  5. spec:
  6.   hosts:
  7.   - reviews
  8.   http:
  9.   - route:
  10.     - destination:
  11.         host: reviews
  12.         subset: v1
  13.       weight: 100
  14. ---
  15. apiVersion: networking.istio.io/v1alpha3
  16. kind: DestinationRule
  17. metadata:
  18.   name: reviews
  19. spec:
  20.   host: reviews
  21.   trafficPolicy:
  22.     tls:
  23.       mode: ISTIO_MUTUAL
  24.   subsets:
  25.   - name: v1
  26.     labels:
  27.       version: v1
  28.   - name: v2
  29.     labels:
  30.       version: v2

../../_images/istio-bookinfo-reviews-v2-route-to-v1.png

Apply this route rule:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/route-rule-reviews-v1.yaml

Deploy the ratings v1 and reviews v2 services:

  1. for service in ratings-v1 reviews-v2; do \
  2.       kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/bookinfo-${service}.yaml ; done

Check the progress of the deployment (every service should have an AVAILABLE count of 1):

  1. watch "kubectl get deployments"
  2. NAME             READY   UP-TO-DATE   AVAILABLE   AGE
  3. details-v1       1/1     1            1           17m
  4. productpage-v1   1/1     1            1           17m
  5. ratings-v1       1/1     1            1           69s
  6. reviews-v1       1/1     1            1           17m
  7. reviews-v2       1/1     1            1           68s

Check in your web browser that no stars are appearing in the Book Reviews, even after refreshing the page several times. This indicates that all reviews are retrieved from reviews v1 and none from reviews v2.

../../_images/istio-bookinfo-reviews-v1.png

The ratings-v1 CiliumNetworkPolicy explicitly whitelists access to the ratings API only from productpage and reviews v2:

  1. apiVersion: cilium.io/v2
  2. kind: CiliumNetworkPolicy
  3. metadata:
  4.   name: ratings-v1
  5.   namespace: default
  6. specs:
  7.   - endpointSelector:
  8.       matchLabels:
  9.         "k8s:app": ratings
  10.         "k8s:version": v1
  11.     ingress:
  12.     - fromEndpoints:
  13.       - matchLabels:
  14.           "k8s:app": productpage
  15.           "k8s:version": v1
  16.       toPorts:
  17.       - ports:
  18.         - port: "9080"
  19.           protocol: TCP
  20.         rules:
  21.           http:
  22.           - method: GET
  23.             path: "/ratings/[0-9]*"
  24.     - fromEndpoints:
  25.         - matchLabels:
  26.             "k8s:app": reviews
  27.             "k8s:version": v2
  28.       toPorts:
  29.       - ports:
  30.         - port: "9080"
  31.           protocol: TCP
  32.         rules:
  33.           http:
  34.           - method: GET
  35.             path: "/ratings/[0-9]*"

Check that reviews v1 may not be able to access the ratings service, even if it were compromised or suffered from a bug, by running curl from within the pod:

Note

All traffic from reviews v1 to ratings is blocked, so the connection attempt fails after the connection timeout.

  1. export POD_REVIEWS_V1=`kubectl get pods -l app=reviews,version=v1 -o jsonpath='{.items[0].metadata.name}'`
  2. kubectl exec ${POD_REVIEWS_V1} -c istio-proxy -ti -- curl --connect-timeout 5 --fail http://ratings:9080/ratings/0
  3. curl: (28) Connection timed out after 5001 milliseconds
  4. command terminated with exit code 28

Update the Istio route rule to send 50% of reviews traffic to v1 and 50% to v2:

  1. apiVersion: networking.istio.io/v1alpha3
  2. kind: VirtualService
  3. metadata:
  4.   name: reviews
  5. spec:
  6.   hosts:
  7.   - reviews
  8.   http:
  9.   - route:
  10.     - destination:
  11.         host: reviews
  12.         subset: v1
  13.       weight: 50
  14.     - destination:
  15.         host: reviews
  16.         subset: v2
  17.       weight: 50

../../_images/istio-bookinfo-reviews-v2-route-to-v1-and-v2.png

Apply this route rule:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/route-rule-reviews-v1-v2.yaml

Check in your web browser that stars are appearing in the Book Reviews roughly 50% of the time. This may require refreshing the page for a few seconds to observe. Queries to reviews v2 result in reviews containing ratings displayed as black stars:

../../_images/istio-bookinfo-reviews-v2.png

Finally, update the route rule to send 100% of reviews traffic to v2:

  1. apiVersion: networking.istio.io/v1alpha3
  2. kind: VirtualService
  3. metadata:
  4.   name: reviews
  5. spec:
  6.   hosts:
  7.   - reviews
  8.   http:
  9.   - route:
  10.     - destination:
  11.         host: reviews
  12.         subset: v2
  13.       weight: 100

../../_images/istio-bookinfo-reviews-v2-route-to-v2.png

Apply this route rule:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/route-rule-reviews-v2.yaml

Refresh the product page in your web browser several times to verify that stars are now appearing in the Book Reviews on every page refresh. All the reviews are now retrieved from reviews v2 and none from reviews v1.

Step 5: Deploy the Product Page Service V2

We will now deploy version v2 of the productpage service, which brings two changes:

  • It is deployed with a more restrictive CiliumNetworkPolicy, which restricts access to a subset of the HTTP URLs, at Layer-7.
  • It implements a new authentication audit log into Kafka.

../../_images/istio-bookinfo-productpage-v2-kafka.png

The policy for v1 currently allows read access to the full HTTP REST API, under the /api/v1 HTTP URI path:

  • /api/v1/products: Returns the list of books and their details.
  • /api/v1/products/<id>: Returns details about a specific book.
  • /api/v1/products/<id>/reviews: Returns reviews for a specific book.
  • /api/v1/products/<id>/ratings: Returns ratings for a specific book.

Check that the full REST API is currently accessible in v1 and returns valid JSON data:

  1. for APIPATH in /api/v1/products /api/v1/products/0 /api/v1/products/0/reviews /api/v1/products/0/ratings; do echo ; curl -s -S "${GATEWAY_URL}${APIPATH}" ; echo ; done

The output will be similar to this:

  1. [{"descriptionHtml": "<a href=\"https://en.wikipedia.org/wiki/The_Comedy_of_Errors\">Wikipedia Summary</a>: The Comedy of Errors is one of <b>William Shakespeare's</b> early plays. It is his shortest and one of his most farcical comedies, with a major part of the humour coming from slapstick and mistaken identity, in addition to puns and word play.", "id": 0, "title": "The Comedy of Errors"}]
  3. {"publisher": "PublisherA", "language": "English", "author": "William Shakespeare", "id": 0, "ISBN-10": "1234567890", "ISBN-13": "123-1234567890", "year": 1595, "type": "paperback", "pages": 200}
  5. {"reviews": [{"reviewer": "Reviewer1", "rating": {"color": "black", "stars": 5}, "text": "An extremely entertaining play by Shakespeare. The slapstick humour is refreshing!"}, {"reviewer": "Reviewer2", "rating": {"color": "black", "stars": 4}, "text": "Absolutely fun and entertaining. The play lacks thematic depth when compared to other plays by Shakespeare."}], "id": "0"}
  7. {"ratings": {"Reviewer2": 4, "Reviewer1": 5}, "id": 0}

We realized that the REST API to get the book reviews and ratings was meant only for consumption by other internal services, and will be blocked from external clients using the updated Layer-7 CiliumNetworkPolicy in productpage v2, i.e. only the /api/v1/products and /api/v1/products/<id> HTTP URLs will be whitelisted:

  1. apiVersion: cilium.io/v2
  2. kind: CiliumNetworkPolicy
  3. metadata:
  4.   name: productpage-v2
  5.   namespace: default
  6. specs:
  7.   - endpointSelector:
  8.       matchLabels:
  9.         "k8s:app": productpage
  10.         "k8s:version": v2
  11.     ingress:
  12.     - toPorts:
  13.       - ports:
  14.         - port: "9080"
  15.           protocol: TCP
  16.         rules:
  17.           http:
  18.           - method: GET
  19.             path: "/"
  20.           - method: GET
  21.             path: "/index.html"
  22.           - method: POST
  23.             path: "/login"
  24.           - method: GET
  25.             path: "/logout"
  26.           - method: GET
  27.             path: "/productpage"
  28.           - method: GET
  29.             path: "/api/v1/products"
  30.           - method: GET
  31.             path: "/api/v1/products/[0-9]*"
  32. #          - method: GET
  33. #            path: "/api/v1/products/[0-9]*/reviews"
  34. #          - method: GET
  35. #            path: "/api/v1/products/[0-9]*/ratings"

Because productpage v2 sends messages into Kafka, we must first deploy a Kafka broker:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/kafka-v1-destrule.yaml
  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/kafka-v1.yaml

Wait until the kafka-v1-0 pod is ready, i.e. until it has a READY count of 1/1:

  1. watch "kubectl get pods -l app=kafka"
  2. NAME         READY     STATUS    RESTARTS   AGE
  3. kafka-v1-0   1/1       Running   0          21m

Create the authaudit Kafka topic, which will be used by productpage v2:

  1. kubectl exec kafka-v1-0 -c kafka -- bash -c '/opt/kafka_2.11-0.10.1.0/bin/kafka-topics.sh --zookeeper localhost:2181/kafka --create --topic authaudit --partitions 1 --replication-factor 1'

We are now ready to deploy productpage v2.

Create the productpage v2 service and its updated CiliumNetworkPolicy and delete productpage v1:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/bookinfo-productpage-v2.yaml
  1. kubectl delete -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/bookinfo-productpage-v1.yaml

productpage v2 implements an authorization audit logging. On every user login or logout, it produces into Kafka topic authaudit a JSON-formatted message which contains the following information:

  • event: login or logout
  • username
  • client IP address
  • timestamp

To observe the Kafka messages sent by productpage, we will run an additional authaudit-logger service. This service fetches and prints out all messages from the authaudit Kafka topic. Start this service:

  1. kubectl apply -f https://raw.githubusercontent.com/cilium/cilium/v1.8/examples/kubernetes-istio/authaudit-logger-v1.yaml

Check the progress of the deployment (every service should have an AVAILABLE count of 1):

  1. watch "kubectl get deployments"
  2. NAME                  READY   UP-TO-DATE   AVAILABLE   AGE
  3. authaudit-logger-v1   1/1     1            1           41s
  4. details-v1            1/1     1            1           37m
  5. productpage-v2        1/1     1            1           4m47s
  6. ratings-v1            1/1     1            1           20m
  7. reviews-v1            1/1     1            1           37m
  8. reviews-v2            1/1     1            1           20m

Check that the product REST API is still accessible, and that Cilium now denies at Layer-7 any access to the reviews and ratings REST API:

  1. for APIPATH in /api/v1/products /api/v1/products/0 /api/v1/products/0/reviews /api/v1/products/0/ratings; do echo ; curl -s -S "${GATEWAY_URL}${APIPATH}" ; echo ; done

The output will be similar to this:

  1. [{"descriptionHtml": "<a href=\"https://en.wikipedia.org/wiki/The_Comedy_of_Errors\">Wikipedia Summary</a>: The Comedy of Errors is one of <b>William Shakespeare's</b> early plays. It is his shortest and one of his most farcical comedies, with a major part of the humour coming from slapstick and mistaken identity, in addition to puns and word play.", "id": 0, "title": "The Comedy of Errors"}]
  3. {"publisher": "PublisherA", "language": "English", "author": "William Shakespeare", "id": 0, "ISBN-10": "1234567890", "ISBN-13": "123-1234567890", "year": 1595, "type": "paperback", "pages": 200}
  5. Access denied
  8. Access denied

This demonstrated that requests to the /api/v1/products/<id>/reviews and /api/v1/products/<id>/ratings URIs now result in Cilium returning HTTP 403 Forbidden HTTP responses.

Every login and logout on the product page will result in a line in this service’s log. Note that you need to log in/out using the sign in/sign out element on the bookinfo web page. When you do, you can observe these kind of audit logs:

  1. export POD_LOGGER_V1=`kubectl get pods -l app=authaudit-logger,version=v1 -o jsonpath='{.items[0].metadata.name}'`
  1. kubectl logs ${POD_LOGGER_V1} -c authaudit-logger
  2. ...
  3. {"timestamp": "2017-12-04T09:34:24.341668", "remote_addr": "10.15.28.238", "event": "login", "user": "richard"}
  4. {"timestamp": "2017-12-04T09:34:40.943772", "remote_addr": "10.15.28.238", "event": "logout", "user": "richard"}
  5. {"timestamp": "2017-12-04T09:35:03.096497", "remote_addr": "10.15.28.238", "event": "login", "user": "gilfoyle"}
  6. {"timestamp": "2017-12-04T09:35:08.777389", "remote_addr": "10.15.28.238", "event": "logout", "user": "gilfoyle"}

As you can see, the user-identifiable information sent by productpage in every Kafka message is sensitive, so access to this Kafka topic must be protected using Cilium. The CiliumNetworkPolicy configured on the Kafka broker enforces that:

  • only productpage v2 is allowed to produce messages into the authaudit topic;
  • only authaudit-logger can fetch messages from this topic;
  • no service can access any other topic.
  1. apiVersion: "cilium.io/v2"
  2. kind: CiliumNetworkPolicy
  3. metadata:
  4.   name: kafka-authaudit
  5. specs:
  6.   - endpointSelector:
  7.       matchLabels:
  8.         "k8s:app": kafka
  9.     ingress:
  10.     - fromEndpoints:
  11.       - matchLabels:
  12.           "k8s:app": productpage
  13.           "k8s:version": v2
  14.       toPorts:
  15.       - ports:
  16.         - port: "9092"
  17.           protocol: TCP
  18.         rules:
  19.           kafka:
  20.           - apiKey: "produce"
  21.             topic: "authaudit"
  22.           - apiKey: "apiversions"
  23.           - apiKey: "metadata"
  24.           - apiKey: "heartbeat"
  25.     - fromEndpoints:
  26.       - matchLabels:
  27.           app: kafka
  28.     - fromEndpoints:
  29.       - matchLabels:
  30.           "k8s:app": authaudit-logger
  31.       toPorts:
  32.       - ports:
  33.         - port: "9092"
  34.           protocol: TCP
  35.         rules:
  36.           kafka:
  37.           - apiKey: "fetch"
  38.             topic: "authaudit"
  39.           - apiKey: "apiversions"
  40.           - apiKey: "metadata"
  41.           - apiKey: "findcoordinator"
  42.           - apiKey: "joingroup"
  43.           - apiKey: "leavegroup"
  44.           - apiKey: "syncgroup"
  45.           - apiKey: "offsets"
  46.           - apiKey: "offsetcommit"
  47.           - apiKey: "offsetfetch"
  48.           - apiKey: "heartbeat"

Check that Cilium prevents the authaudit-logger service from writing into the authaudit topic (enter a message followed by ENTER, e.g. test message)

Note

Note that the error message may take a short time to appear.

Note

You can terminate the command with a single <CTRL>-d.

  1. kubectl exec ${POD_LOGGER_V1} -c authaudit-logger -ti -- /opt/kafka_2.11-0.10.1.0/bin/kafka-console-producer.sh --broker-list=kafka:9092 --topic=authaudit
  2. test message
  3. [2017-12-07 02:13:47,020] ERROR Error when sending message to topic authaudit with key: null, value: 12 bytes with error: (org.apache.kafka.clients.producer.internals.ErrorLoggingCallback)
  4. org.apache.kafka.common.errors.TopicAuthorizationException: Not authorized to access topics: [authaudit]

This demonstrated that Cilium sent a response with an authorization error for any Produce request from this service.

Create another topic named credit-card-payments, meant to transmit highly-sensitive credit card payment requests:

  1. kubectl exec kafka-v1-0 -c kafka -- bash -c '/opt/kafka_2.11-0.10.1.0/bin/kafka-topics.sh --zookeeper localhost:2181/kafka --create --topic credit-card-payments --partitions 1 --replication-factor 1'

Check that Cilium prevents the authaudit-logger service from fetching messages from this topic:

  1. kubectl exec ${POD_LOGGER_V1} -c authaudit-logger -ti -- /opt/kafka_2.11-0.10.1.0/bin/kafka-console-consumer.sh --bootstrap-server=kafka:9092 --topic=credit-card-payments
  2. [2017-12-07 03:08:54,513] WARN Not authorized to read from topic credit-card-payments. (org.apache.kafka.clients.consumer.internals.Fetcher)
  3. [2017-12-07 03:08:54,517] ERROR Error processing message, terminating consumer process:  (kafka.tools.ConsoleConsumer$)
  4. org.apache.kafka.common.errors.TopicAuthorizationException: Not authorized to access topics: [credit-card-payments]
  5. Processed a total of 0 messages

This demonstrated that Cilium sent a response with an authorization error for any Fetch request from this service for any topic other than authaudit.

Note

At present, the above command may also result in an error message.

Step 6: Clean Up

You have now installed Cilium and Istio, deployed a demo app, and tested both Cilium’s L3-L7 network security policies and Istio’s service route rules. To clean up, run:

  1. minikube delete

After this, you can re-run the tutorial from Step 0.