From 90bccf748be7486bdb855cb56cf8751344eba065 Mon Sep 17 00:00:00 2001 From: robq99 Date: Wed, 18 Nov 2020 10:09:04 +0100 Subject: [PATCH] fix: rollout weights moved to canary doc --- docs/gitbook/tutorials/rollout-weights.md | 38 --------------------- docs/gitbook/usage/deployment-strategies.md | 37 ++++++++++++++++++++ 2 files changed, 37 insertions(+), 38 deletions(-) delete mode 100644 docs/gitbook/tutorials/rollout-weights.md diff --git a/docs/gitbook/tutorials/rollout-weights.md b/docs/gitbook/tutorials/rollout-weights.md deleted file mode 100644 index fd38876c..00000000 --- a/docs/gitbook/tutorials/rollout-weights.md +++ /dev/null @@ -1,38 +0,0 @@ -# Linkerd Rollout Weights - -This guide shows you how to use weights in Flagger to have more fine-grained rollouts. - -By default Flagger allows to use linear promotion metrics, with the start value, the step and maximum weight value in 0 to 100 range. - -Example: -```yaml -canary: - analysis: - promotion: - maxWeight: 50 - stepWeight: 20 -``` -This configuration performs analysis starting from 20, increasing by 20 until weight goes above 50. -We would have steps (canary weight : primary weight): -* 20 (20 : 80) -* 40 (40 : 60) -* 60 (60 : 40) -* promotion - -In order to enable non-linear promotion a new parameters were introduced: -* `stepWeights` - determines the ordered array of weights, which shall be used during canary promotion. - -Example: -```yaml -canary: - analysis: - promotion: - stepWeights: [1, 2, 10, 80] -``` -This configuration performs analysis starting from 1, going through `stepWeights` values till 800. -We would have steps (canary weight : primary weight): -* 1 (1 : 99) -* 2 (2 : 98) -* 10 (10 : 90) -* 80 (80 : 20) -* promotion diff --git a/docs/gitbook/usage/deployment-strategies.md b/docs/gitbook/usage/deployment-strategies.md index 80af7348..fdbadf1d 100644 --- a/docs/gitbook/usage/deployment-strategies.md +++ b/docs/gitbook/usage/deployment-strategies.md @@ -116,6 +116,43 @@ Gated canary promotion stages: * send notification with the canary analysis result * wait for the canary deployment to be updated and start over +#### Rollout Weights + +By default Flagger uses linear weight values for the promotion, with the start value, the step and the maximum weight value in 0 to 100 range. + +Example: +```yaml +canary: + analysis: + promotion: + maxWeight: 50 + stepWeight: 20 +``` +This configuration performs analysis starting from 20, increasing by 20 until weight goes above 50. +We would have steps (canary weight : primary weight): +* 20 (20 : 80) +* 40 (40 : 60) +* 60 (60 : 40) +* promotion + +In order to enable non-linear promotion a new parameter was introduced: +* `stepWeights` - determines the ordered array of weights, which shall be used during canary promotion. + +Example: +```yaml +canary: + analysis: + promotion: + stepWeights: [1, 2, 10, 80] +``` +This configuration performs analysis starting from 1, going through `stepWeights` values till 80. +We would have steps (canary weight : primary weight): +* 1 (1 : 99) +* 2 (2 : 98) +* 10 (10 : 90) +* 80 (20 : 60) +* promotion + ### A/B Testing For frontend applications that require session affinity you should use HTTP headers or cookies match conditions