[Serverless Knative] Knative Docs - Basics of Traffic Splitting

Posted on Edited on In , , , Views: Word count in article: 5.4k Reading time ≈ 5 mins.

Basics of Traffic Splitting

The last super power 🚀 of Knative Serving we’ll go over in this tutorial is traffic splitting.

What are some common traffic splitting use-cases?

Splitting traffic is useful for a number of very common modern infrastructure needs, such as blue/green deployments - https://martinfowler.com/bliki/BlueGreenDeployment.html and canary deployments - https://martinfowler.com/bliki/CanaryRelease.html. Bringing these industry standards to bear on Kubernetes is as simple as a single CLI command on Knative or YAML tweak, let’s see how!

Creating a new Revision

You may have noticed that when you created your Knative Service you assigned it a revision-name, “world”. If you used kn, when your Service was created Knative returned both a URL and a “latest revision” for your Knative Service. But what happens if you make a change to your Service?

What exactly is a Revision?"

You can think of a Revision - https://knative.dev/docs/serving/#serving-resources as a stateless, autoscaling, snapshot-in-time of application code and configuration.

A new Revision will get created each and every time you make changes to your Knative Service, whether you assign it a name or not. When splitting traffic, Knative splits traffic between different Revisions of your Knative Service.

Instead of TARGET=“World” update the environment variable TARGET on your Knative Service hello to greet “Knative” instead. Name this new revision hello-knative

kn

1
2
3
$ kn service update hello \
    --env TARGET=Knative \
    --revision-name=knative

As before, kn prints out some helpful information to the CLI.

Expected output:

1
2
Service hello created to latest revision 'hello-knative' is available at URL:
http://hello.default.127.0.0.1.nip.io

YAML

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# hello.yaml

---
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: hello
spec:
  template:
    metadata:
      name: hello-knative
    spec:
      containers:
        - image: gcr.io/knative-samples/helloworld-go
          ports:
            - containerPort: 8080
          env:
            - name: TARGET
              value: "Knative"

Once you’ve edited your existing YAML file:

1
$ kubectl apply -f hello.yaml

Expected output:

1
service.serving.knative.dev/hello configured

Note, since we are updating an existing Knative Service hello, the URL doesn’t change, but our new Revision should have the new name hello-knative

Let’s access our Knative Service again on your browser http://hello.default.127.0.0.1.nip.io to see the change, or use curl in your terminal:

1
$ curl http://hello.default.127.0.0.1.nip.io

Expected output:

1
Hello Knative!

Splitting Traffic

You may at this point be wondering, “where did ‘Hello World!’ go?” Remember, Revisions are a stateless snapshot-in-time of application code and configuration, so your “hello-world” Revision is still available to you.

We can easily see a list of our existing revisions with the kn CLI:

kn

1
$ kn revisions list

Expected output:shell

1
2
3
NAME            SERVICE   TRAFFIC   TAGS   GENERATION   AGE   CONDITIONS   READY   REASON
hello-knative   hello     100%             2            30s   3 OK / 4     True    
hello-world     hello                      1            5m    3 OK / 4     True

kubectl

Though the following example doesn’t cover it, you can peak under the hood to Kubernetes to see the revisions as Kubernetes sees them.

1
$ kubectl get revisions

Expected output:

1
2
3
NAME            SERVICE   TRAFFIC   TAGS   GENERATION   AGE   CONDITIONS   READY   REASON
hello-knative   hello     100%             2            30s   3 OK / 4     True    
hello-world     hello                      1            5m    3 OK / 4     True

The column most relevant for our purposes is TRAFFIC. It looks like 100% of traffic is going to our latest Revision (“hello-knative”) and 0% of traffic is going to the Revision we configured earlier (“hello-world”).

When you create a new Revision of a Knative Service, Knative defaults to directing 100% of traffic to this latest Revision. We can change this default behavior by specifying how much traffic we want each of our Revisions to receive.

Lets split traffic between our two Revisions:

Info

@latest will always point to our “latest” Revision which, at the moment, is hello-knative.

kn

1
2
3
$ kn service update hello \
    --traffic hello-world=50 \
    --traffic @latest=50

YAML

Add the following traffic to the bottom of your existing YAML file:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# hello.yaml

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: hello
spec:
  template:
    metadata:
      name: hello-knative
    spec:
      containers:
        - image: gcr.io/knative-samples/helloworld-go
          ports:
            - containerPort: 8080
          env:
            - name: TARGET
              value: "Knative"
  traffic:
  - latestRevision: true
    percent: 50
  - revisionName: hello-world
    percent: 50

Once you’ve edited your existing YAML file:

1
$ kubectl apply -f hello.yaml

Verify traffic split configure correctly by listing the revisions again.

kn

1
$ kn revisions list

kubectl

Though the following example doesn’t cover it, you can peak under the hood to Kubernetes to see the revisions as Kubernetes sees them.

1
$ kubectl get revisions

Expected output:

NAME SERVICE TRAFFIC TAGS GENERATION AGE CONDITIONS READY REASON
hello-knative hello 50% 2 10m 3 OK / 4 True
hello-world hello 50% 1 36m 3 OK / 4 True

kubectl

Access your Knative service on the browser again http://hello.default.127.0.0.1.nip.io, and refresh multiple times to see the different output being served by each Revision.

Similarly, you can curl the Service URL multiple times to see the traffic being split between the Revisions.

1
$ curl http://hello.default.127.0.0.1.nip.io

Expected output:

1
2
3
4
5
$ curl http://hello.default.127.0.0.1.nip.io
Hello Knative!

$ curl http://hello.default.127.0.0.1.nip.io
Hello World!

Congratulations, 🎉 you’ve successfully split traffic between 2 different Revisions of a Knative Service. Up next, Knative Eventing!

Clean Up

You won’t need the hello Service in the Knative Eventing tutorial, so it’s best to clean up before you move forward:

kn

1
$ kn service delete hello

kubectl

1
% kubectl delete -f hello.yaml

References

[1] Traffic Splitting - Knative - https://knative.dev/docs/getting-started/first-traffic-split/

[2] Home - Knative - https://knative.dev/docs/

[3] Installing Guide - https://knative.dev/docs/install/

[4] blue/green deployments - https://martinfowler.com/bliki/BlueGreenDeployment.html

[5] canary deployments - https://martinfowler.com/bliki/CanaryRelease.html

[6] Revision - https://knative.dev/docs/serving/#serving-resources