From bde24d28b7716896eda2bd4b3286d2b3fcb24310 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Mon, 15 Feb 2021 14:03:32 +0200 Subject: [PATCH] Update project description Signed-off-by: Stefan Prodan --- README.md | 10 +++++++--- docs/gitbook/README.md | 31 +++++++++++++++---------------- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 36c70dca..8cd371e1 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,17 @@ Flagger is a progressive delivery tool that automates the release process for ap It reduces the risk of introducing a new software version in production by gradually shifting traffic to the new version while measuring metrics and running conformance tests. -![flagger-overview](https://raw.githubusercontent.com/fluxcd/flagger/main/docs/diagrams/flagger-canary-overview.png) +![flagger-overview](https://raw.githubusercontent.com/fluxcd/flagger/main/docs/diagrams/flagger-overview.png) Flagger implements several deployment strategies (Canary releases, A/B testing, Blue/Green mirroring) -using a service mesh (App Mesh, Istio, Linkerd) or an ingress controller (Contour, Gloo, NGINX, Skipper, Traefik) for traffic routing. -For release analysis, Flagger can query Prometheus, Datadog or CloudWatch +using a service mesh (App Mesh, Istio, Linkerd) +or an ingress controller (Contour, Gloo, NGINX, Skipper, Traefik) for traffic routing. +For release analysis, Flagger can query Prometheus, Datadog, New Relic or CloudWatch and for alerting it uses Slack, MS Teams, Discord and Rocket. +Flagger is a [Cloud Native Computing Foundation](https://cncf.io/) project +and part of [Flux](https://fluxcd.io) family of GitOps tools. + ### Documentation Flagger documentation can be found at [docs.flagger.app](https://docs.flagger.app). diff --git a/docs/gitbook/README.md b/docs/gitbook/README.md index 0fc92f49..0b35a122 100644 --- a/docs/gitbook/README.md +++ b/docs/gitbook/README.md @@ -4,26 +4,25 @@ description: Flagger is a progressive delivery Kubernetes operator # Introduction -[Flagger](https://github.com/fluxcd/flagger) is a **Kubernetes** operator -that automates the promotion of canary deployments using -**Istio**, **Linkerd**, **App Mesh**, **NGINX**, **Skipper**, **Contour**, **Gloo** or **Traefik** -routing for traffic shifting and **Prometheus** metrics for canary analysis. -The canary analysis can be extended with webhooks for running -system integration/acceptance tests, load tests, or any other custom validation. +[Flagger](https://github.com/fluxcd/flagger) is a progressive delivery tool that automates the release +process for applications running on Kubernetes. It reduces the risk of introducing a new software +version in production by gradually shifting traffic to the new version while measuring metrics +and running conformance tests. -Flagger implements a control loop that gradually shifts traffic to the canary -while measuring key performance indicators like HTTP requests success rate, -requests average duration and pods health. -Based on analysis of the **KPIs** a canary is promoted or aborted, -and the analysis result is published to **Slack** or **MS Teams**. +Flagger implements several deployment strategies (Canary releases, A/B testing, Blue/Green mirroring) +using a service mesh (App Mesh, Istio, Linkerd) +or an ingress controller (Contour, Gloo, NGINX, Skipper, Traefik) for traffic routing. +For release analysis, Flagger can query Prometheus, Datadog, New Relic or CloudWatch +and for alerting it uses Slack, MS Teams, Discord and Rocket. -![Flagger overview diagram](https://raw.githubusercontent.com/fluxcd/flagger/main/docs/diagrams/flagger-canary-overview.png) +![Flagger overview diagram](https://raw.githubusercontent.com/fluxcd/flagger/main/docs/diagrams/flagger-overview.png) -Flagger can be configured with Kubernetes custom resources and is compatible with any CI/CD solutions made for Kubernetes. -Since Flagger is declarative and reacts to Kubernetes events, -it can be used in **GitOps** pipelines together with Flux CD or JenkinsX. +Flagger can be configured with Kubernetes custom resources and is compatible with +any CI/CD solutions made for Kubernetes. Since Flagger is declarative and reacts to Kubernetes events, +it can be used in **GitOps** pipelines together with tools like Flux, JenkinsX, Carvel, Argo, etc. -Flagger is a [Cloud Native Computing Foundation](https://cncf.io/) project. +Flagger is a [Cloud Native Computing Foundation](https://cncf.io/) project +and part of [Flux](https://fluxcd.io) family of GitOps tools. ## Getting started