From b4b1a36abaf27e5209a530925b66bca7844c0690 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Wed, 19 Dec 2018 13:45:12 +0000 Subject: [PATCH] GitBook: [master] 8 pages modified --- docs/gitbook/README.md | 2 +- docs/gitbook/SUMMARY.md | 4 ++-- docs/gitbook/how-it-works.md | 4 ---- docs/gitbook/install/installing-flagger.md | 6 +----- docs/gitbook/install/installing-grafana.md | 6 +----- docs/gitbook/usage/alerting.md | 4 ---- docs/gitbook/usage/monitoring.md | 4 ---- docs/gitbook/usage/progressive-delivery.md | 4 ---- 8 files changed, 5 insertions(+), 29 deletions(-) diff --git a/docs/gitbook/README.md b/docs/gitbook/README.md index ed72f551..6808dd36 100644 --- a/docs/gitbook/README.md +++ b/docs/gitbook/README.md @@ -4,7 +4,7 @@ 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](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**. diff --git a/docs/gitbook/SUMMARY.md b/docs/gitbook/SUMMARY.md index c0d5fe03..5c9196f9 100644 --- a/docs/gitbook/SUMMARY.md +++ b/docs/gitbook/SUMMARY.md @@ -5,8 +5,8 @@ ## Install -* [Installing Flagger](install/installing-flagger.md) -* [Installing Grafana](install/installing-grafana.md) +* [Install Flagger](install/installing-flagger.md) +* [Install Grafana](install/installing-grafana.md) ## Usage diff --git a/docs/gitbook/how-it-works.md b/docs/gitbook/how-it-works.md index e1fe8afe..beabd7a5 100644 --- a/docs/gitbook/how-it-works.md +++ b/docs/gitbook/how-it-works.md @@ -1,7 +1,3 @@ ---- -description: Automated canary deployment process ---- - # How it works [Flagger](https://github.com/stefanprodan/flagger) takes a Kubernetes deployment and optionally a horizontal pod autoscaler \(HPA\) and creates a series of objects \(Kubernetes deployments, ClusterIP services and Istio virtual services\) to drive the canary analysis and promotion. diff --git a/docs/gitbook/install/installing-flagger.md b/docs/gitbook/install/installing-flagger.md index 9b40b2c5..394dbfc4 100644 --- a/docs/gitbook/install/installing-flagger.md +++ b/docs/gitbook/install/installing-flagger.md @@ -1,8 +1,4 @@ ---- -description: Helm setup instructions ---- - -# Installing Flagger +# Install Flagger Before installing Flagger make sure you have [Istio](https://istio.io/docs/setup/kubernetes/helm-install/) running with Prometheus enabled. If you are new to Istio you can follow this GKE guide [Istio service mesh walk-through](https://github.com/stefanprodan/istio-gke). diff --git a/docs/gitbook/install/installing-grafana.md b/docs/gitbook/install/installing-grafana.md index ee272cfe..9fc9a69b 100644 --- a/docs/gitbook/install/installing-grafana.md +++ b/docs/gitbook/install/installing-grafana.md @@ -1,8 +1,4 @@ ---- -description: Helm setup instructions ---- - -# Installing Grafana +# Install Grafana Flagger comes with a Grafana dashboard made for monitoring the canary analysis. diff --git a/docs/gitbook/usage/alerting.md b/docs/gitbook/usage/alerting.md index 7fd0e290..a18f94ff 100644 --- a/docs/gitbook/usage/alerting.md +++ b/docs/gitbook/usage/alerting.md @@ -1,7 +1,3 @@ ---- -description: Slack & Alertmanager ---- - # Alerting ### Slack diff --git a/docs/gitbook/usage/monitoring.md b/docs/gitbook/usage/monitoring.md index 04f5d89a..1fe0fb7b 100644 --- a/docs/gitbook/usage/monitoring.md +++ b/docs/gitbook/usage/monitoring.md @@ -1,7 +1,3 @@ ---- -description: Metrics & Logging ---- - # Monitoring ### Grafana diff --git a/docs/gitbook/usage/progressive-delivery.md b/docs/gitbook/usage/progressive-delivery.md index 62de2ede..30d5832e 100644 --- a/docs/gitbook/usage/progressive-delivery.md +++ b/docs/gitbook/usage/progressive-delivery.md @@ -1,7 +1,3 @@ ---- -description: 'Automated canary analysis, promotions and rollbacks walkthrough' ---- - # Canary Deployments This guide shows you how to use Istio and Flagger to automate canary deployments.