Service Mesh Interface (SMI)

SMI Traffic Split

Traffic Split defines the `TrafficSplit` resource, which allows users to incrementally direct percentages of traffic between various services. It is the canonical SMI primitive for canary deployments, blue/green rollouts, and A/B testing across a mesh.

SMI Traffic Split is one of 4 APIs that Service Mesh Interface (SMI) publishes on the APIs.io network.

This API exposes 1 JSON Schema definition.

Tagged areas include Traffic Management, Traffic Splitting, Canary, Blue Green, and Progressive Delivery. The published artifact set on APIs.io includes sample payloads and 1 JSON Schema.

Documentation GitHub

Examples

https://raw.githubusercontent.com/api-evangelist/service-mesh-interface/refs/heads/main/./examples/traffic-split-example.yaml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/service-mesh-interface/refs/heads/main/./json-schema/traffic-split-schema.json

Other Resources

https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-split/v1alpha4/traffic-split.md

API entry from apis.yml

name: SMI Traffic Split
description: 'Traffic Split defines the `TrafficSplit` resource, which allows users to incrementally

  direct percentages of traffic between various services. It is the canonical SMI

  primitive for canary deployments, blue/green rollouts, and A/B testing across a mesh.

  '
humanURL: https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-split/v1alpha4/traffic-split.md
aid: smi-traffic-split
tags:
- Traffic Management
- Traffic Splitting
- Canary
- Blue Green
- Progressive Delivery
- Kubernetes CRD
- SMI
properties:
- type: APIVersion
  name: split.smi-spec.io/v1alpha4
- type: Kind
  name: TrafficSplit
- type: Specification
  url: https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-split/v1alpha4/traffic-split.md
- type: JSONSchema
  url: ./json-schema/traffic-split-schema.json
- type: Example
  url: ./examples/traffic-split-example.yaml