# Traffic Route

This policy lets you configure routing rules for the traffic in the mesh. It supports weighted routing and can be used to implement versioning across services or to support deployment strategies such as blue/green or canary.

Note the following:

  • The configuration must specify the data plane proxies for the routing rules.
  • The spec.destinations field supports only kuma.io/service.
  • All available tags are supported for spec.conf.
  • This is an outbound connection policy. Make sure that your data plane proxy configuration includes the appropriate tags.

Kuma also supports locality aware load balancing.

# Default TrafficRoute

The control plane creates a default TrafficRoute every time a new Mesh is created. The default TrafficRoute enables the traffic between all the services in the mesh.

    # Usage

    Here is a full example of TrafficRoute policy

      Kuma utilizes positive weights in the TrafficRoute policy and not percentages, therefore Kuma does not check if the total adds up to 100. If we want to stop sending traffic to a destination service we change the weight for that service to 0.

      # L4 Traffic Split

      We can use TrafficRoute to split a TCP traffic between services with different tags implementing A/B testing or canary deployments.

      Here is an example of a TrafficRoute that splits the traffic over the two different versions of the application. 90% of the connections from backend_default_svc_80 service will be initiated to redis_default_svc_6379 with tag version: 1.0 and 10% of the connections will be initiated to version: 2.0

        # L4 Traffic Rerouting

        We can use TrafficRoute to fully reroute a TCP traffic to different version of a service or even completely different service.

        Here is an example of a TrafficRoute that redirects the traffic to another-redis_default_svc_6379 when backend_default_svc_80 is trying to consume redis_default_svc_6379.

          # L7 Traffic Split

          We can use TrafficRoute to split an HTTP traffic between services with different tags implementing A/B testing or canary deployments.

          Here is an example of a TrafficRoute that splits the traffic from frontend_default_svc_80 to backend_default_svc_80 between versions, but only on endpoints starting with /api. All other endpoints will go to version: 1.0

            In order to use L7 Traffic Split, we need to mark the destination service with kuma.io/protocol: http.

            # L7 Traffic Modification

            We can use TrafficRoute to modify outgoing requests, by setting new path or changing request and response headers.

            Here is an example of a TrafficRoute that adds x-custom-header with value xyz when frontend_default_svc_80 tries to consume backend_default_svc_80.

              In order to use L7 Traffic Modification, we need to mark the destination service with kuma.io/protocol: http.

              # L7 Traffic Rerouting

              We can use TrafficRoute to modify outgoing requests, by setting new path or changing request and response headers.

              Here is an example of a TrafficRoute that redirect traffic to offers_default_svc_80 when frontend_default_svc_80 is trying to consume backend_default_svc_80 on /offers endpoint.

                In order to use L7 Traffic Rerouting, we need to mark the destination service with kuma.io/protocol: http.

                # Load balancer types

                There are different load balancing algorithms that can be used to determine how traffic is routed to the destinations. By default TrafficRoute uses the roundRobin load balancer, but more options are available:

                • roundRobin is a simple algorithm in which each available upstream host is selected in round robin order.

                  Example:

                  loadBalancer:
                    roundRobin: {}
                  
                  1
                  2
                • leastRequest uses different algorithms depending on whether the hosts have the same or different weights. It has a single configuration field choiceCount, which denotes the number of random healthy hosts from which the host with the fewer active requests will be chosen.

                  Example:

                  loadBalancer:
                    leastRequest:
                      choiceCount: 8
                  
                  1
                  2
                  3
                • ringHash implements consistent hashing to the upstream hosts. It has the following fields:

                  • hashFunction the hash function used to hash the hosts onto the ketama ring. Can be XX_HASH or MURMUR_HASH_2.
                  • minRingSize minimum hash ring size.
                  • maxRingSize maximum hash ring size.

                  Example:

                  loadBalancer:
                    ringHash:
                      hashFunction: "MURMUR_HASH_2"
                      minRingSize: 64
                      maxRingSize: 1024
                  
                  1
                  2
                  3
                  4
                  5
                • random selects a random available host.

                  Example:

                  loadBalancer:
                    random: {}
                  
                  1
                  2
                • maglev implements consistent hashing to upstream hosts

                  Example:

                  loadBalancer:
                    maglev: {}
                  
                  1
                  2
                Last Updated: 11/22/2021, 4:36:48 PM