From be96a1147965d748a5e6c158fe186adf383df28d Mon Sep 17 00:00:00 2001
From: stefanprodan <stefan.prodan@gmail.com>
Date: Mon, 18 May 2020 11:07:40 +0300
Subject: [PATCH] Add promotion step weight to docs

---
 docs/gitbook/usage/deployment-strategies.md | 9 ++++++++-
 docs/gitbook/usage/how-it-works.md          | 3 +++
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/docs/gitbook/usage/deployment-strategies.md b/docs/gitbook/usage/deployment-strategies.md
index 05cc4fd5..e6781e52 100644
--- a/docs/gitbook/usage/deployment-strategies.md
+++ b/docs/gitbook/usage/deployment-strategies.md
@@ -43,13 +43,16 @@ Spec:
     # canary increment step
     # percentage (0-100)
     stepWeight: 2
+    # promotion increment step (default 100)
+    # percentage (0-100)
+    stepWeightPromotion: 100
   # deploy straight to production without
   # the metrics and webhook checks
   skipAnalysis: false
 ```
 
 The above analysis, if it succeeds, will run for 25 minutes while validating the HTTP metrics and webhooks every minute.
-You can determine the minimum time that it takes to validate and promote a canary deployment using this formula:
+You can determine the minimum time it takes to validate and promote a canary deployment using this formula:
 
 ```
 interval * (maxWeight / stepWeight)
@@ -61,6 +64,10 @@ And the time it takes for a canary to be rollback when the metrics or webhook ch
 interval * threshold 
 ```
 
+When `stepWeightPromotion` is specified, the promotion phase happens in stages,
+the traffic is routed back to the primary pods in a progressive manner,
+the primary weight is increased until it reaches 100%.
+
 In emergency cases, you may want to skip the analysis phase and ship changes directly to production. 
 At any time you can set the `spec.skipAnalysis: true`. 
 When skip analysis is enabled, Flagger checks if the canary deployment is healthy and 
diff --git a/docs/gitbook/usage/how-it-works.md b/docs/gitbook/usage/how-it-works.md
index 5d215c07..4aa1719d 100644
--- a/docs/gitbook/usage/how-it-works.md
+++ b/docs/gitbook/usage/how-it-works.md
@@ -311,6 +311,9 @@ Spec:
     # canary increment step
     # percentage (0-100)
     stepWeight:
+    # promotion increment step
+    # percentage (0-100)
+    stepWeightPromotion:
     # total number of iterations
     # used for A/B Testing and Blue/Green
     iterations: