diff --git a/docs/gitbook/README.md b/docs/gitbook/README.md index d0388d49..3712e7bd 100644 --- a/docs/gitbook/README.md +++ b/docs/gitbook/README.md @@ -10,5 +10,5 @@ Flagger implements a control loop that gradually shifts traffic to the canary wh ![flagger-overview](https://raw.githubusercontent.com/stefanprodan/flagger/master/docs/diagrams/flagger-overview.png) -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 can be configured with Kubernetes custom resources \(canaries.flagger.app kind\) 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 Weave Flux or JenkinsX. diff --git a/docs/gitbook/SUMMARY.md b/docs/gitbook/SUMMARY.md index 29e24ea2..4a84b93f 100644 --- a/docs/gitbook/SUMMARY.md +++ b/docs/gitbook/SUMMARY.md @@ -10,7 +10,7 @@ ## Usage -* [Progressive Delivery](usage/progressive-delivery.md) +* [Canary Deployments](usage/progressive-delivery.md) * [Monitoring](usage/monitoring.md) * [Alerting](usage/alerting.md) diff --git a/docs/gitbook/how-it-works.md b/docs/gitbook/how-it-works.md index 4d244c56..e1fe8afe 100644 --- a/docs/gitbook/how-it-works.md +++ b/docs/gitbook/how-it-works.md @@ -1,5 +1,5 @@ --- -description: Automated canary deployments process +description: Automated canary deployment process --- # How it works @@ -10,7 +10,7 @@ description: Automated canary deployments process ### Canary Custom Resource -For a deployment named _**podinfo**_, a canary promotion can be defined using Flagger's custom resource: +For a deployment named _podinfo_, a canary promotion can be defined using Flagger's custom resource: ```yaml apiVersion: flagger.app/v1alpha1 @@ -102,9 +102,9 @@ You can change the canary analysis _max weight_ and the _step weight_ percentage ### Canary Analisys - The canary analysis is using the following promql queries: + The canary analysis is using the following Prometheus queries: -_HTTP requests success rate percentage_ +**HTTP requests success rate percentage** ```javascript sum( @@ -129,7 +129,7 @@ sum( ) ``` -_HTTP requests milliseconds duration P99_ +**HTTP requests milliseconds duration P99** ```javascript histogram_quantile(0.99, diff --git a/docs/gitbook/usage/progressive-delivery.md b/docs/gitbook/usage/progressive-delivery.md index e9dd0a69..62de2ede 100644 --- a/docs/gitbook/usage/progressive-delivery.md +++ b/docs/gitbook/usage/progressive-delivery.md @@ -2,7 +2,7 @@ description: 'Automated canary analysis, promotions and rollbacks walkthrough' --- -# Progressive Delivery +# Canary Deployments This guide shows you how to use Istio and Flagger to automate canary deployments.