Skip to content

Commit a78d273

Browse files
committed
Update Flagger overview diagram
Signed-off-by: Stefan Prodan <[email protected]>
1 parent 07bd356 commit a78d273

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# flagger
1+
# flagger
22

33
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4783/badge)](https://bestpractices.coreinfrastructure.org/projects/4783)
44
[![build](https://github.com/fluxcd/flagger/workflows/build/badge.svg)](https://github.com/fluxcd/flagger/actions)
@@ -13,10 +13,7 @@ by gradually shifting traffic to the new version while measuring metrics and run
1313
![flagger-overview](https://raw.githubusercontent.com/fluxcd/flagger/main/docs/diagrams/flagger-overview.png)
1414

1515
Flagger implements several deployment strategies (Canary releases, A/B testing, Blue/Green mirroring)
16-
using a service mesh (App Mesh, Istio, Linkerd, Open Service Mesh, Kuma)
17-
or an ingress controller (Contour, Gloo, NGINX, Skipper, Traefik) for traffic routing.
18-
For release analysis, Flagger can query Prometheus, Datadog, New Relic, CloudWatch, Dynatrace,
19-
InfluxDB and Stackdriver and for alerting it uses Slack, MS Teams, Discord, Rocket and Google Chat.
16+
and integrates with various Kubernetes ingress controllers, service mesh and monitoring solutions.
2017

2118
Flagger is a [Cloud Native Computing Foundation](https://cncf.io/) project
2219
and part of [Flux](https://fluxcd.io) family of GitOps tools.
@@ -85,7 +82,7 @@ spec:
8582
progressDeadlineSeconds: 60
8683
# HPA reference (optional)
8784
autoscalerRef:
88-
apiVersion: autoscaling/v2beta1
85+
apiVersion: autoscaling/v2beta2
8986
kind: HorizontalPodAutoscaler
9087
name: podinfo
9188
service:
@@ -223,7 +220,13 @@ For more details on how the canary analysis and promotion works please [read the
223220
| Request duration check (L7 metric) | :heavy_minus_sign: | :heavy_minus_sign: |
224221
| Custom metric checks | :heavy_check_mark: | :heavy_check_mark: |
225222
226-
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.
223+
For all [Gateway API](https://gateway-api.sigs.k8s.io/) implementations like
224+
[Contour](https://projectcontour.io/guides/gateway-api/) or
225+
[Istio](https://istio.io/latest/docs/tasks/traffic-management/ingress/gateway-api/)
226+
and [SMI](https://smi-spec.io) compatible service mesh solutions like
227+
[Nginx Service Mesh](https://docs.nginx.com/nginx-service-mesh/),
228+
[Prometheus MetricTemplates](https://docs.flagger.app/usage/metrics#prometheus)
229+
can be used to implement the request success rate and request duration checks.
227230
228231
### Roadmap
229232
@@ -236,17 +239,16 @@ For all [Gateway API](https://gateway-api.sigs.k8s.io/) implementations like [Co
236239
237240
#### Integrations
238241
239-
* Add support for ingress controllers like HAProxy and ALB
242+
* Add support for ingress controllers like HAProxy, ALB and Apache APISIX
240243
241244
### Contributing
242245
243246
Flagger is Apache 2.0 licensed and accepts contributions via GitHub pull requests.
244247
To start contributing please read the [development guide](https://docs.flagger.app/dev/dev-guide).
245248
246-
When submitting bug reports please include as much details as possible:
249+
When submitting bug reports please include as many details as possible:
247250
248251
* which Flagger version
249-
* which Flagger CRD version
250252
* which Kubernetes version
251253
* what configuration (canary, ingress and workloads definitions)
252254
* what happened (Flagger and Proxy logs)

docs/diagrams/flagger-overview.png

5.06 KB
Loading

0 commit comments

Comments
 (0)