From 978f7256a8ecb01492c09cebbed85487ab75e720 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Wed, 19 Dec 2018 10:08:59 +0000 Subject: [PATCH] GitBook: [master] 2 pages modified --- docs/gitbook/README.md | 16 ++++++++++++++++ docs/gitbook/SUMMARY.md | 4 ++++ 2 files changed, 20 insertions(+) create mode 100644 docs/gitbook/README.md create mode 100644 docs/gitbook/SUMMARY.md diff --git a/docs/gitbook/README.md b/docs/gitbook/README.md new file mode 100644 index 00000000..487a9b8a --- /dev/null +++ b/docs/gitbook/README.md @@ -0,0 +1,16 @@ +--- +description: Flagger is an Istio progressive delivery Kubernetes operator +--- + +# Introduction + +[Flagger](https://github.com/stefanprodan/flagger) is a **Kubernetes** operator that automates the promotion of canary deployments using **Istio** routing for traffic shifting and **Prometheus** metrics for canary analysis. + +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 the **KPIs** analysis a canary is promoted or aborted and the analysis result is published to **Slack**. + +Flagger takes a Kubernetes deployment and creates a series of objects \(Kubernetes [deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/), ClusterIP [services](https://kubernetes.io/docs/concepts/services-networking/service/) and Istio [virtual services](https://istio.io/docs/reference/config/istio.networking.v1alpha3/#VirtualService)\) to drive the canary analysis and promotion. + +![flagger-overview](https://raw.githubusercontent.com/stefanprodan/flagger/master/docs/diagrams/flagger-overview.png) + + + diff --git a/docs/gitbook/SUMMARY.md b/docs/gitbook/SUMMARY.md new file mode 100644 index 00000000..bb7bfd61 --- /dev/null +++ b/docs/gitbook/SUMMARY.md @@ -0,0 +1,4 @@ +# Table of contents + +* [Introduction](README.md) +