feat(*): support SMI traffic split v1alpha4

+ updates OSM to support SMI Traffic Split v1alpha4 which includes HTTPRouteGroup support enabling scenarios such as A/B testing and routing based on HTTP attributes * resolves openservicemesh#2759 * resolves openservicemesh#2368 Signed-off-by: Michelle Noorali <minooral@microsoft.com>
michelleN · Mar 16, 2021 · 1dc89e8 · 1dc89e8
1 parent 77dd57d
commit 1dc89e8
Show file tree

Hide file tree

Showing 32 changed files with 79 additions and 59 deletions.
diff --git a/DESIGN.md b/DESIGN.md
@@ -145,7 +145,7 @@ spec:
 
 ---
 
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-traffic-split
@@ -190,7 +190,7 @@ This certificate's Common Name leverages the DNS-1123 standard with the followin
 ### (E) Policy
 The policy component referenced in the diagram above (E) is any [SMI Spec resource](https://github.com/deislabs/smi-spec#service-mesh-interface) referencing the [service (C)](#c-service). For instance, `TrafficSplit`, referencing a services `bookstore`, and `bookstore-v1`:
 ```yaml
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-traffic-split

diff --git a/README.md b/README.md
@@ -138,5 +138,5 @@ This software is covered under the Apache 2.0 license. You can read the license
 
 [1]: https://en.wikipedia.org/wiki/Service_mesh
 [2]: https://github.com/servicemeshinterface/smi-spec/blob/master/SPEC_LATEST_STABLE.md
-[3]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha2/traffic-split.md
+[3]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha4/traffic-split.md
 [4]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-access/v1alpha3/traffic-access.md
diff --git a/charts/osm/crds/split.yaml b/charts/osm/crds/split.yaml
@@ -20,7 +20,6 @@ metadata:
  name: trafficsplits.split.smi-spec.io
 spec:
  group: split.smi-spec.io
- version: v1alpha2
  scope: Namespaced
  names:
  kind: TrafficSplit
@@ -29,10 +28,20 @@ spec:
  - ts
  plural: trafficsplits
  singular: trafficsplit
+ version: v1alpha4
  versions:
- - name: v1alpha2
- served: true
- storage: true
+ - name: v1alpha4
+ served: true
+ storage: true
+ - name: v1alpha3
+ served: false
+ storage: false
+ - name: v1alpha2
+ served: false
+ storage: false
+ - name: v1alpha1
+ served: false
+ storage: false
  additionalPrinterColumns:
  - name: Service
  type: string
@@ -50,6 +59,21 @@ spec:
  service:
  description: The apex service of this split.
  type: string
+ matches:
+ description: The HTTP route groups that this traffic split should match.
+ type: array
+ items:
+ type: object
+ required: ['kind', 'name']
+ properties:
+ kind:
+ description: Kind of the matching group.
+ type: string
+ enum:
+ - HTTPRouteGroup
+ name:
+ description: Name of the matching group.
+ type: string
  backends:
  description: The backend services of this split.
  type: array
@@ -62,4 +86,4 @@ spec:
  type: string
  weight:
  description: Traffic weight value of this backend.
- type: number
+ type: number
diff --git a/demo/deploy-traffic-split.sh b/demo/deploy-traffic-split.sh
@@ -6,19 +6,16 @@ set -aueo pipefail
 source .env
 
 kubectl apply -f - <<EOF
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-split
  namespace: "$BOOKSTORE_NAMESPACE"
 spec:
  service: bookstore
  backends:
-
  - service: bookstore-v1
  weight: 50
  - service: bookstore-v2
  weight: 50
-
-
 EOF
diff --git a/docs/content/docs/design_concepts/components_desc.md b/docs/content/docs/design_concepts/components_desc.md
@@ -79,7 +79,7 @@ spec:
  app: bookstore
 
 ---
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-traffic-split
@@ -131,7 +131,7 @@ This certificate's Common Name leverages the DNS-1123 standard with the followin
 The policy component referenced in the diagram above (E) is any [SMI Spec resource](https://github.com/deislabs/smi-spec#service-mesh-interface) referencing the [service (C)](#c-service). For instance, `TrafficSplit`, referencing a services `bookstore`, and `bookstore-v1`:
 
 ```yaml
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-traffic-split

diff --git a/docs/content/docs/getting_started/_index.md b/docs/content/docs/getting_started/_index.md
@@ -21,7 +21,7 @@ OSM runs an Envoy based control plane on Kubernetes, can be configured with SMI
 
 ## Features
 
-1. Easily and transparently configure [traffic shifting](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha2/traffic-split.md) for deployments
+1. Easily and transparently configure [traffic shifting](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha4/traffic-split.md) for deployments
 1. Secure service to service communication by [enabling mTLS](https://github.com/openservicemesh/osm/blob/main/docs/patterns/certificates.md)
 1. Define and execute fine grained [access control](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-access/v1alpha3/traffic-access.md) policies for services
 1. [Observability](https://github.com/openservicemesh/osm/blob/main/docs/patterns/observability/README.md) and insights into application metrics for debugging and monitoring services
@@ -42,5 +42,5 @@ OSM is under active development and is NOT ready for production workloads.
 | :---------------------- | :-----------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------: |
 | Traffic Access Control | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-access/v1alpha3/traffic-access.md) | |
 | Traffic Specs | [v1alpha4](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-specs/v1alpha4/traffic-specs.md) | |
-| Traffic Split | [v1alpha2](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha2/traffic-split.md) | |
+| Traffic Split | [v1alpha4](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha4/traffic-split.md) | |
 | Traffic Metrics | [v1alpha1](https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-metrics/v1alpha1/traffic-metrics.md) | 🚧 **In Progress** [#379](https://github.com/openservicemesh/osm/issues/379) 🚧 |
diff --git a/docs/content/docs/install/manual_demo/_index.md b/docs/content/docs/install/manual_demo/_index.md
@@ -395,4 +395,4 @@ For more details about uninstalling OSM, see the [uninstallation guide](../unins
 
 [1]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-access/v1alpha2/traffic-access.md
 [2]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-specs/v1alpha4/traffic-specs.md
-[3]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha2/traffic-split.md
+[3]: https://github.com/servicemeshinterface/smi-spec/blob/v0.6.0/apis/traffic-split/v1alpha4/traffic-split.md
diff --git a/docs/content/docs/troubleshooting/upgrade.md b/docs/content/docs/troubleshooting/upgrade.md
@@ -11,7 +11,7 @@ If the [upgrade CRD guide](../upgrade_guide.md##crd-upgrades) was not followed,
 
 The OSM controller will then crash with errors similar to this:
 ```
-reflector.go:178] pkg/mod/k8s.io/client-go@v0.18.6/tools/cache/reflector.go:125: Failed to list *v1alpha2.TrafficTarget: the server could not find the requested resource (get traffictargets.access.smi-spec.io)
+reflector.go:178] pkg/mod/k8s.io/client-go@v0.18.6/tools/cache/reflector.go:125: Failed to list *v1alpha4.TrafficTarget: the server could not find the requested resource (get traffictargets.access.smi-spec.io)
 ```
 To resolve these errors:
 1. Checkout the correct release branch of the [repo](https://github.com/openservicemesh/osm) and run the following commands from the root. 

diff --git a/docs/example/manifests/split/traffic-split-50-50.yaml b/docs/example/manifests/split/traffic-split-50-50.yaml
@@ -1,4 +1,4 @@
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-split

diff --git a/docs/example/manifests/split/traffic-split-v1.yaml b/docs/example/manifests/split/traffic-split-v1.yaml
@@ -1,4 +1,4 @@
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-split

diff --git a/docs/example/manifests/split/traffic-split-v2.yaml b/docs/example/manifests/split/traffic-split-v2.yaml
@@ -1,4 +1,4 @@
-apiVersion: split.smi-spec.io/v1alpha2
+apiVersion: split.smi-spec.io/v1alpha4
 kind: TrafficSplit
 metadata:
  name: bookstore-split

diff --git a/pkg/catalog/debugger.go b/pkg/catalog/debugger.go
@@ -5,7 +5,7 @@ import (
 
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
 
  "github.com/openservicemesh/osm/pkg/certificate"
  "github.com/openservicemesh/osm/pkg/envoy"

diff --git a/pkg/catalog/helpers_test.go b/pkg/catalog/helpers_test.go
@@ -7,7 +7,7 @@ import (
  "github.com/golang/mock/gomock"
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  specs "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  testclient "k8s.io/client-go/kubernetes/fake"

diff --git a/pkg/catalog/inbound_traffic_policies_test.go b/pkg/catalog/inbound_traffic_policies_test.go
@@ -9,7 +9,7 @@ import (
  "github.com/golang/mock/gomock"
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  tassert "github.com/stretchr/testify/assert"
  corev1 "k8s.io/api/core/v1"
  v1 "k8s.io/apimachinery/pkg/apis/meta/v1"

diff --git a/pkg/catalog/mock_catalog_generated.go b/pkg/catalog/mock_catalog_generated.go
diff --git a/pkg/catalog/outbound_traffic_policies_test.go b/pkg/catalog/outbound_traffic_policies_test.go
@@ -7,8 +7,7 @@ import (
  "github.com/golang/mock/gomock"
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
- v1alpha2 "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  tassert "github.com/stretchr/testify/assert"
  corev1 "k8s.io/api/core/v1"
  v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -377,9 +376,9 @@ func TestListOutboundTrafficPoliciesForTrafficSplits(t *testing.T) {
  ObjectMeta: v1.ObjectMeta{
  Namespace: tests.Namespace,
  },
- Spec: v1alpha2.TrafficSplitSpec{
+ Spec: split.TrafficSplitSpec{
  Service: tests.BookstoreApexServiceName + "." + tests.Namespace,
- Backends: []v1alpha2.TrafficSplitBackend{
+ Backends: []split.TrafficSplitBackend{
  {
  Service: tests.BookstoreV1ServiceName,
  Weight: tests.Weight90,

diff --git a/pkg/catalog/service_test.go b/pkg/catalog/service_test.go
@@ -6,7 +6,7 @@ import (
 
  "github.com/golang/mock/gomock"
  "github.com/pkg/errors"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  tassert "github.com/stretchr/testify/assert"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

diff --git a/pkg/catalog/types.go b/pkg/catalog/types.go
@@ -11,7 +11,7 @@ import (
  "github.com/google/uuid"
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  "k8s.io/client-go/kubernetes"
 
  "github.com/openservicemesh/osm/pkg/certificate"

diff --git a/pkg/debugger/mock_debugger_generated.go b/pkg/debugger/mock_debugger_generated.go
diff --git a/pkg/debugger/policy.go b/pkg/debugger/policy.go
@@ -7,7 +7,7 @@ import (
 
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
 
  "github.com/openservicemesh/osm/pkg/service"
 )

diff --git a/pkg/debugger/policy_test.go b/pkg/debugger/policy_test.go
@@ -7,7 +7,7 @@ import (
  "github.com/golang/mock/gomock"
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  tassert "github.com/stretchr/testify/assert"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
@@ -49,6 +49,6 @@ func TestGetSMIPolicies(t *testing.T) {
  responseRecorder := httptest.NewRecorder()
  smiPoliciesHandler.ServeHTTP(responseRecorder, nil)
  actualResponseBody := responseRecorder.Body.String()
- expectedResponseBody := `{"traffic_splits":[{"metadata":{"name":"bar","namespace":"foo","creationTimestamp":null},"spec":{}}],"service_accounts":[{"Namespace":"default","Name":"bookbuyer"}],"route_groups":[{"kind":"HTTPRouteGroup","apiVersion":"specs.smi-spec.io/v1alpha4","metadata":{"name":"bookstore-service-routes","namespace":"default","creationTimestamp":null},"spec":{"matches":[{"name":"buy-books","methods":["GET"],"pathRegex":"/buy","headers":[{"user-agent":"test-UA"}]},{"name":"sell-books","methods":["GET"],"pathRegex":"/sell","headers":[{"user-agent":"test-UA"}]},{"name":"allow-everything-on-header","headers":[{"user-agent":"test-UA"}]}]}}],"traffic_targets":[{"kind":"TrafficTarget","apiVersion":"access.smi-spec.io/v1alpha3","metadata":{"name":"bookbuyer-access-bookstore","namespace":"default","creationTimestamp":null},"spec":{"destination":{"kind":"ServiceAccount","name":"bookstore","namespace":"default"},"sources":[{"kind":"ServiceAccount","name":"bookbuyer","namespace":"default"}],"rules":[{"kind":"HTTPRouteGroup","name":"bookstore-service-routes","matches":["buy-books","sell-books"]}]}}]}`
+ expectedResponseBody := `{"traffic_splits":[{"metadata":{"name":"bar","namespace":"foo","creationTimestamp":null},"spec":{"service":"","backends":null}}],"service_accounts":[{"Namespace":"default","Name":"bookbuyer"}],"route_groups":[{"kind":"HTTPRouteGroup","apiVersion":"specs.smi-spec.io/v1alpha4","metadata":{"name":"bookstore-service-routes","namespace":"default","creationTimestamp":null},"spec":{"matches":[{"name":"buy-books","methods":["GET"],"pathRegex":"/buy","headers":[{"user-agent":"test-UA"}]},{"name":"sell-books","methods":["GET"],"pathRegex":"/sell","headers":[{"user-agent":"test-UA"}]},{"name":"allow-everything-on-header","headers":[{"user-agent":"test-UA"}]}]}}],"traffic_targets":[{"kind":"TrafficTarget","apiVersion":"access.smi-spec.io/v1alpha3","metadata":{"name":"bookbuyer-access-bookstore","namespace":"default","creationTimestamp":null},"spec":{"destination":{"kind":"ServiceAccount","name":"bookstore","namespace":"default"},"sources":[{"kind":"ServiceAccount","name":"bookbuyer","namespace":"default"}],"rules":[{"kind":"HTTPRouteGroup","name":"bookstore-service-routes","matches":["buy-books","sell-books"]}]}}]}`
  assert.Equal(expectedResponseBody, actualResponseBody, "Actual value did not match expectations:\n%s", actualResponseBody)
 }
diff --git a/pkg/debugger/types.go b/pkg/debugger/types.go
@@ -6,7 +6,7 @@ import (
 
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  "k8s.io/client-go/kubernetes"
  "k8s.io/client-go/rest"
 

diff --git a/pkg/envoy/lds/inmesh_test.go b/pkg/envoy/lds/inmesh_test.go
@@ -13,7 +13,7 @@ import (
  xds_tcp_proxy "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/network/tcp_proxy/v3"
  "github.com/envoyproxy/go-control-plane/pkg/wellknown"
  "github.com/golang/protobuf/ptypes"
- smiSplit "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ smiSplit "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  "google.golang.org/protobuf/types/known/wrapperspb"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 

diff --git a/pkg/envoy/rds/response_test.go b/pkg/envoy/rds/response_test.go
@@ -12,7 +12,7 @@ import (
  "github.com/google/uuid"
  access "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/access/v1alpha3"
  spec "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/specs/v1alpha4"
- split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha2"
+ split "github.com/servicemeshinterface/smi-sdk-go/pkg/apis/split/v1alpha4"
  tassert "github.com/stretchr/testify/assert"
  v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/client-go/kubernetes"