Merge pull request #1108 from aryan9600/aryan9600/gateway-api

Add Gateway API as a provider

.gitbook.yaml

@@ -15,3 +15,4 @@ redirects:
  usage/traefik-progressive-delivery: tutorials/traefik-progressive-delivery.md
  usage/osm-progressive-delivery: tutorials/osm-progressive-delivery.md
  usage/kuma-progressive-delivery: tutorials/kuma-progressive-delivery.md
+ usage/gatewayapi-progressive-delivery: tutorials/gatewayapi-progressive-delivery.md

.github/workflows/e2e.yaml

@@ -31,6 +31,7 @@ jobs:
  - gloo
  - skipper
  - kubernetes
+ - gatewayapi
  steps:
  - name: Checkout
  uses: actions/checkout@v2

README.md

@@ -184,21 +184,17 @@ For more details on how the canary analysis and promotion works please [read the
 
 **Service Mesh**
 
-| Feature | App Mesh | Istio | Linkerd | Kuma | OSM | SMI | Kubernetes CNI |
-|--------------------------------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|
-| Canary deployments (weighted traffic) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: |
-| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: | :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: | :heavy_check_mark: | :heavy_check_mark: |
-| Blue/Green deployments (traffic mirroring) | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
-| Webhooks (acceptance/load testing) | :heavy_check_mark: | :heavy_check_mark: | :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: | :heavy_check_mark: | :heavy_check_mark: |
-| Request success rate check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
-| Request duration check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
-| Custom metric checks | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-
-For other SMI compatible service mesh solutions like Consul Connect or Nginx Service Mesh,
-[Prometheus MetricTemplates](https://docs.flagger.app/usage/metrics#prometheus) can be used to implement
-the request success rate and request duration checks.
+| Feature | App Mesh | Istio | Linkerd | Kuma | OSM | Kubernetes CNI |
+|--------------------------------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|
+| Canary deployments (weighted traffic) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: |
+| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :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: | :heavy_check_mark: |
+| Blue/Green deployments (traffic mirroring) | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
+| Webhooks (acceptance/load testing) | :heavy_check_mark: | :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: | :heavy_check_mark: |
+| Request success rate check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: |
+| Request duration check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: |
+| Custom metric checks | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 
 **Ingress**
 
@@ -213,6 +209,22 @@ the request success rate and request duration checks.
 | Request duration check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_check_mark: | :heavy_check_mark: |
 | Custom metric checks | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 
+**Networking Interface**
+
+| Feature | Gateway API | SMI |
+|-----------------------------------------------|--------------------|--------------------|
+| Canary deployments (weighted traffic) | :heavy_check_mark: | :heavy_check_mark: |
+| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_minus_sign: |
+| Blue/Green deployments (traffic switch) | :heavy_check_mark: | :heavy_check_mark: |
+| Blue/Green deployments (traffic mirrroring) | :heavy_minus_sign: | :heavy_minus_sign: |
+| Webhooks (acceptance/load testing) | :heavy_check_mark: | :heavy_check_mark: |
+| Manual gating (approve/pause/resume) | :heavy_check_mark: | :heavy_check_mark: |
+| Request success rate check (L7 metric) | :heavy_minus_sign: | :heavy_minus_sign: |
+| Request duration check (L7 metric) | :heavy_minus_sign: | :heavy_minus_sign: |
+| Custom metric checks | :heavy_check_mark: | :heavy_check_mark: |
+
+For all [Gateway API](https://gateway-api.sigs.k8s.io/) implementations like [Contour](https://projectcontour.io/guides/gateway-api/), [Istio](https://istio.io/latest/docs/tasks/traffic-management/ingress/gateway-api/) and [SMI](https://smi-spec.io) compatible service mesh solutions like [Consul Connect](https://www.consul.io/docs/connect) or [Nginx Service Mesh](https://docs.nginx.com/nginx-service-mesh/), [Prometheus MetricTemplates](https://docs.flagger.app/usage/metrics#prometheus) can be used to implement the request success rate and request duration checks.
+
 ### Roadmap
 
 #### [GitOps Toolkit](https:/fluxcd/flux2) compatibility
@@ -224,7 +236,6 @@ the request success rate and request duration checks.
 
 #### Integrations
 
-* Add support for Kubernetes [Ingress v2](https:/kubernetes-sigs/service-apis)
 * Add support for ingress controllers like HAProxy and ALB
 * Add support for metrics providers like InfluxDB, Stackdriver, SignalFX
 

artifacts/flagger/account.yaml

@@ -187,6 +187,32 @@ rules:
  - update
  - patch
  - delete
+ - apiGroups:
+ - kuma.io
+ resources:
+ - trafficroutes
+ - trafficroutes/finalizers
+ verbs:
+ - get
+ - list
+ - watch
+ - create
+ - update
+ - patch
+ - delete
+ - apiGroups:
+ - gateway.networking.k8s.io
+ resources:
+ - httproutes
+ - httproutes/finalizers
+ verbs:
+ - get
+ - list
+ - watch
+ - create
+ - update
+ - patch
+ - delete
  - nonResourceURLs:
  - /version
  verbs:

artifacts/flagger/crd.yaml

@@ -495,6 +495,40 @@ spec:
  type: array
  items:
  type: string
+ gatewayRefs:
+ description: The list of parent Gateways for a HTTPRoute
+ maxItems: 32
+ type: array
+ items:
+ required:
+ - name
+ type: object
+ properties:
+ group:
+ default: gateway.networking.k8s.io
+ maxLength: 253
+ pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+ type: string
+ kind:
+ default: Gateway
+ maxLength: 63
+ minLength: 1
+ pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
+ type: string
+ name:
+ maxLength: 253
+ minLength: 1
+ type: string
+ namespace:
+ maxLength: 63
+ minLength: 1
+ pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+ type: string
+ sectionName:
+ maxLength: 253
+ minLength: 1
+ pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+ type: string
  corsPolicy:
  description: Istio Cross-Origin Resource Sharing policy (CORS)
  type: object

charts/flagger/crds/crd.yaml

@@ -495,6 +495,40 @@ spec:
  type: array
  items:
  type: string
+ gatewayRefs:
+ description: The list of parent Gateways for a HTTPRoute
+ maxItems: 32
+ type: array
+ items:
+ required:
+ - name
+ type: object
+ properties:
+ group:
+ default: gateway.networking.k8s.io
+ maxLength: 253
+ pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+ type: string
+ kind:
+ default: Gateway
+ maxLength: 63
+ minLength: 1
+ pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
+ type: string
+ name:
+ maxLength: 253
+ minLength: 1
+ type: string
+ namespace:
+ maxLength: 63
+ minLength: 1
+ pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+ type: string
+ sectionName:
+ maxLength: 253
+ minLength: 1
+ pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+ type: string
  corsPolicy:
  description: Istio Cross-Origin Resource Sharing policy (CORS)
  type: object

charts/flagger/templates/rbac.yaml

@@ -208,6 +208,19 @@ rules:
  - update
  - patch
  - delete
+ - apiGroups:
+ - gateway.networking.k8s.io
+ resources:
+ - httproutes
+ - httproutes/finalizers
+ verbs:
+ - get
+ - list
+ - watch
+ - create
+ - update
+ - patch
+ - delete
  - nonResourceURLs:
  - /version
  verbs:

docs/gitbook/SUMMARY.md

@@ -32,6 +32,7 @@
 * [Traefik Canary Deployments](tutorials/traefik-progressive-delivery.md)
 * [Open Service Mesh Deployments](tutorials/osm-progressive-delivery.md)
 * [Kuma Canary Deployments](tutorials/kuma-progressive-delivery.md)
+* [Gateway API Canary Deployments](tutorials/gatewayapi-progressive-delivery.md)
 * [Blue/Green Deployments](tutorials/kubernetes-blue-green.md)
 * [Canary analysis with Prometheus Operator](tutorials/prometheus-operator.md)
 * [Zero downtime deployments](tutorials/zero-downtime-deployments.md)

docs/gitbook/faq.md

@@ -495,6 +495,33 @@ histogram_quantile(0.99,
 The analysis can be extended with metrics provided by Prometheus, Datadog, AWS CloudWatch, New Relic and Graphite.
 For more details on how custom metrics can be used, please read the [metrics docs](usage/metrics.md).
 
+#### Istio Gateway API
+
+If you're using Istio with Gateway API, the Prometheus query needs to include `reporter="source"`. For example, to calculate HTTP requests error percentage, the query would be:
+
+```javascript
+100 - sum(
+ rate(
+ istio_requests_total{
+ reporter="source",
+ destination_workload_namespace=~"$namespace",
+ destination_workload=~"$workload",
+ response_code!~"5.*"
+ }[$interval]
+ )
+)
+/
+sum(
+ rate(
+ istio_requests_total{
+ reporter="source",
+ destination_workload_namespace=~"$namespace",
+ destination_workload=~"$workload"
+ }[$interval]
+ )
+) * 100
+```
+
 ## Istio routing
 
 #### How does Flagger interact with Istio?