Merge pull request fluxcd#765 from kdorosh/gloo_route_tables

A/B testing support for Gloo Edge ingress controller
mayankshah1607 · Feb 20, 2021 · 19196db · 19196db
1 parent 63b217f
commit 19196db
Show file tree

Hide file tree

Showing 32 changed files with 842 additions and 457 deletions.
diff --git a/README.md b/README.md
@@ -201,7 +201,7 @@ For more details on how the canary analysis and promotion works please [read the
 | Feature | Contour | Gloo | NGINX | Skipper | Traefik |
 | ------------------------------------------ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
 | Canary deployments (weighted traffic) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
+| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
 | Blue/Green deployments (traffic switch) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | Webhooks (acceptance/load testing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | Manual gating (approve/pause/resume) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

diff --git a/artifacts/flagger/account.yaml b/artifacts/flagger/account.yaml
@@ -153,8 +153,19 @@ rules:
  resources:
  - upstreams
  - upstreams/finalizers
- - upstreamgroups
- - upstreamgroups/finalizers
+ verbs:
+ - get
+ - list
+ - watch
+ - create
+ - update
+ - patch
+ - delete
+ - apiGroups:
+ - gateway.solo.io
+ resources:
+ - routetables
+ - routetables/finalizers
  verbs:
  - get
  - list

diff --git a/charts/flagger/templates/rbac.yaml b/charts/flagger/templates/rbac.yaml
@@ -149,8 +149,19 @@ rules:
  resources:
  - upstreams
  - upstreams/finalizers
- - upstreamgroups
- - upstreamgroups/finalizers
+ verbs:
+ - get
+ - list
+ - watch
+ - create
+ - update
+ - patch
+ - delete
+ - apiGroups:
+ - gateway.solo.io
+ resources:
+ - routetables
+ - routetables/finalizers
  verbs:
  - get
  - list

diff --git a/docs/gitbook/tutorials/gloo-progressive-delivery.md b/docs/gitbook/tutorials/gloo-progressive-delivery.md
@@ -1,12 +1,15 @@
 # Gloo Canary Deployments
 
-This guide shows you how to use the [Gloo](https://gloo.solo.io/) ingress controller and Flagger to automate canary deployments.
+This guide shows you how to use the [Gloo Edge](https://gloo.solo.io/) ingress controller and Flagger to automate canary deployments.
 
 ![Flagger Gloo Ingress Controller](https://raw.githubusercontent.com/weaveworks/flagger/master/docs/diagrams/flagger-gloo-overview.png)
 
 ## Prerequisites
 
-Flagger requires a Kubernetes cluster **v1.11** or newer and Gloo ingress **1.3.5** or newer.
+This guide was written for Flagger version **1.5.0** or higher. Prior versions of Flagger used Gloo upstream groups to handle
+canaries, but newer versions of Flagger use Gloo route tables to handle canaries as well as A/B testing.
+
+Flagger requires a Kubernetes cluster **v1.11** or newer and Gloo Edge ingress **1.6.0** or newer.
 
 Install Gloo with Helm v3:
 
@@ -30,7 +33,7 @@ helm upgrade -i flagger flagger/flagger \
 
 ## Bootstrap
 
-Flagger takes a Kubernetes deployment and optionally a horizontal pod autoscaler \(HPA\), then creates a series of objects \(Kubernetes deployments, ClusterIP services and Gloo upstream groups\). These objects expose the application outside the cluster and drive the canary analysis and promotion.
+Flagger takes a Kubernetes deployment and optionally a horizontal pod autoscaler \(HPA\), then creates a series of objects \(Kubernetes deployments, ClusterIP services and Gloo route tables groups\). These objects expose the application outside the cluster and drive the canary analysis and promotion.
 
 Create a test namespace:
 
@@ -50,7 +53,7 @@ Deploy the load testing service to generate traffic during the canary analysis:
 kubectl -n test apply -k github.com/weaveworks/flagger//kustomize/tester
 ```
 
-Create an virtual service definition that references an upstream group that will be generated by Flagger \(replace `app.example.com` with your own domain\):
+Create a virtual service definition that references a route table that will be generated by Flagger \(replace `app.example.com` with your own domain\):
 
 ```yaml
 apiVersion: gateway.solo.io/v1
@@ -65,8 +68,8 @@ spec:
  routes:
  - matchers:
  - prefix: /
- routeAction:
- upstreamGroup:
+ delegateAction:
+ ref:
  name: podinfo
  namespace: test
 ```
@@ -165,7 +168,7 @@ horizontalpodautoscaler.autoscaling/podinfo-primary
 service/podinfo
 service/podinfo-canary
 service/podinfo-primary
-upstreamgroups.gloo.solo.io/podinfo
+routetables.gateway.solo.io/podinfo
 ```
 
 When the bootstrap finishes Flagger will set the canary status to initialized:
@@ -247,13 +250,13 @@ podinfod=stefanprodan/podinfo:3.1.2
 Generate HTTP 500 errors:
 
 ```bash
-watch curl -H 'Host: app.example.com' http://gateway-proxy-v2.gloo-system/status/500
+watch curl -H 'Host: app.example.com' http://gateway-proxy.gloo-system/status/500
 ```
 
 Generate high latency:
 
 ```bash
-watch curl -H 'Host: app.example.com' http://gateway-proxy-v2.gloo-system/delay/2
+watch curl -H 'Host: app.example.com' http://gateway-proxy.gloo-system/delay/2
 ```
 
 When the number of failed checks reaches the canary analysis threshold, the traffic is routed back to the primary, the canary is scaled to zero and the rollout is marked as failed.
@@ -345,7 +348,7 @@ podinfod=stefanprodan/podinfo:3.1.3
 Generate 404s:
 
 ```bash
-watch curl -H 'Host: app.example.com' http://gateway-proxy.gloo-system/status/400
+watch curl -H 'Host: app.example.com' http://gateway-proxy.gloo-system/status/404
 ```
 
 Watch Flagger logs:

diff --git a/docs/gitbook/usage/deployment-strategies.md b/docs/gitbook/usage/deployment-strategies.md
@@ -3,11 +3,11 @@
 Flagger can run automated application analysis, promotion and rollback for the following deployment strategies:
 
 * **Canary Release** \(progressive traffic shifting\)
- * Istio, Linkerd, App Mesh, NGINX, Skipper, Contour, Gloo, Traefik
+ * Istio, Linkerd, App Mesh, NGINX, Skipper, Contour, Gloo Edge, Traefik
 * **A/B Testing** \(HTTP headers and cookies traffic routing\)
- * Istio, App Mesh, NGINX, Contour
+ * Istio, App Mesh, NGINX, Contour, Gloo Edge
 * **Blue/Green** \(traffic switching\)
- * Kubernetes CNI, Istio, Linkerd, App Mesh, NGINX, Contour, Gloo
+ * Kubernetes CNI, Istio, Linkerd, App Mesh, NGINX, Contour, Gloo Edge
 * **Blue/Green Mirroring** \(traffic shadowing\)
  * Istio
 

diff --git a/kustomize/base/flagger/rbac.yaml b/kustomize/base/flagger/rbac.yaml
@@ -143,8 +143,19 @@ rules:
  resources:
  - upstreams
  - upstreams/finalizers
- - upstreamgroups
- - upstreamgroups/finalizers
+ verbs:
+ - get
+ - list
+ - watch
+ - create
+ - update
+ - patch
+ - delete
+ - apiGroups:
+ - gateway.solo.io
+ resources:
+ - routetables
+ - routetables/finalizers
  verbs:
  - get
  - list

diff --git a/pkg/apis/gloo/register.go b/pkg/apis/gloo/register.go
@@ -1,5 +1,5 @@
 package gloo
 
 const (
- GroupName = "gloo.solo.io"
+ GroupName = "gateway.solo.io"
 )
diff --git a/pkg/apis/gloo/v1/doc.go b/pkg/apis/gloo/v1/doc.go
@@ -1,5 +1,5 @@
 // +k8s:deepcopy-gen=package
 
 // Package v1 is the v1 version of the API.
-// +groupName=gloo.solo.io
+// +groupName=gateway.solo.io
 package v1
diff --git a/pkg/apis/gloo/v1/register.go b/pkg/apis/gloo/v1/register.go
@@ -28,8 +28,8 @@ var (
 // Adds the list of known types to Scheme.
 func addKnownTypes(scheme *runtime.Scheme) error {
  scheme.AddKnownTypes(SchemeGroupVersion,
- &UpstreamGroup{},
- &UpstreamGroupList{},
+ &RouteTable{},
+ &RouteTableList{},
  )
  metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
  return nil

diff --git a/pkg/apis/gloo/v1/types.go b/pkg/apis/gloo/v1/types.go
@@ -7,15 +7,48 @@ import (
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
-// UpstreamGroup is a specification for a Gloo UpstreamGroup resource
-type UpstreamGroup struct {
+// RouteTable is a specification for a Gloo RouteTable resource
+type RouteTable struct {
  metav1.TypeMeta `json:",inline"`
  metav1.ObjectMeta `json:"metadata,omitempty"`
 
- Spec UpstreamGroupSpec `json:"spec"`
+ Spec RouteTableSpec `json:"spec"`
 }
 
-type UpstreamGroupSpec struct {
+type RouteTableSpec struct {
+ Routes []Route `json:"routes,omitempty"`
+}
+
+type Route struct {
+ Matchers []Matcher `json:"matchers,omitempty"`
+ Action RouteAction `json:"routeAction,omitempty"`
+ InheritablePathMatchers bool `json:"inheritablePathMatchers,omitempty"`
+}
+
+type Matcher struct {
+ Headers []HeaderMatcher `json:"headers,omitempty"`
+ QueryParameterMatchers []QueryParameterMatcher `json:"queryParameters,omitempty"`
+ Methods []string `json:"methods,omitempty"`
+}
+
+type HeaderMatcher struct {
+ Name string `json:"name,omitempty"`
+ Value string `json:"value,omitempty"`
+ Regex bool `json:"regex,omitempty"`
+ InvertMatch bool `json:"invertMatch,omitempty"`
+}
+
+type QueryParameterMatcher struct {
+ Name string `json:"name,omitempty"`
+ Value string `json:"value,omitempty"`
+ Regex bool `json:"regex,omitempty"`
+}
+
+type RouteAction struct {
+ Destination MultiDestination `json:"multi,omitempty"`
+}
+
+type MultiDestination struct {
  Destinations []WeightedDestination `json:"destinations,omitempty"`
 }
 
@@ -40,10 +73,10 @@ type ResourceRef struct {
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
-// UpstreamGroupList is a list of UpstreamGroup resources
-type UpstreamGroupList struct {
+// RouteTableList is a list of RouteTable resources
+type RouteTableList struct {
  metav1.TypeMeta `json:",inline"`
  metav1.ListMeta `json:"metadata"`
 
- Items []UpstreamGroup `json:"items"`
+ Items []RouteTable `json:"items"`
 }