From e5e5cbd2d6f6ca57602d179a30745a0cae5f0481 Mon Sep 17 00:00:00 2001 From: Bishal Thapa Date: Tue, 17 Sep 2024 10:34:14 +0100 Subject: [PATCH] Improve Documentation for Scaledown on Aborted Rollout MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Improves understanding of how scaling down behaves depending on different configurations. • Canary with traffic routing + setCanaryScale does not scales down immediately when `abortScaleDownDelaySeconds = 0`. • Canary with traffic routing + setCanaryScale scales down after some delay of N second `abortScaleDownDelaySeconds = N`. Signed-off-by: Bishal Thapa --- docs/features/scaledown-aborted-rs.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/features/scaledown-aborted-rs.md b/docs/features/scaledown-aborted-rs.md index 40740fce64..7905263b28 100644 --- a/docs/features/scaledown-aborted-rs.md +++ b/docs/features/scaledown-aborted-rs.md @@ -6,13 +6,15 @@ The following table summarizes the behavior under combinations of rollout strate `abortScaleDownDelaySeconds = nil` is the default, which means in v1.1 across all rollout strategies, the new replicaset is scaled down in 30 seconds on abort by default. -| strategy | v1.0 behavior | abortScaleDownDelaySeconds | v1.1 behavior | -|--------------------------------------------:|:-----------------------------:|:--------------------------:|:-----------------------------:| -| blue-green | does not scale down | nil | scales down after 30 seconds | -| blue-green | does not scale down | 0 | does not scale down | -| blue-green | does not scale down | N | scales down after N seconds | -| basic canary | rolling update back to stable | N/A | rolling update back to stable | -| canary w/ traffic routing | scales down immediately | nil | scales down after 30 seconds | -| canary w/ traffic routing | scales down immediately | 0 | does not scale down | -| canary w/ traffic routing | scales down immediately | N | scales down after N seconds | -| canary w/ traffic routing + setCanaryScale | does not scale down (bug) | * | should behave like canary w/ traffic routing | +| strategy | v1.0 behavior | abortScaleDownDelaySeconds | v1.1 behavior | +|--------------------------------------------:|:-----------------------------:|:--------------------------:|:---------------------------------------------:| +| blue-green | does not scale down | nil | scales down after 30 seconds | +| blue-green | does not scale down | 0 | does not scale down | +| blue-green | does not scale down | N | scales down after N seconds | +| basic canary | rolling update back to stable | N/A | rolling update back to stable | +| canary w/ traffic routing | scales down immediately | nil | scales down after 30 seconds | +| canary w/ traffic routing | scales down immediately | 0 | scales down immediately | +| canary w/ traffic routing | scales down immediately | N | scales down immediately | +| canary w/ traffic routing + setCanaryScale | scales down immediately | 0 | does not scale down | +| canary w/ traffic routing + setCanaryScale | scales down immediately | N | scales down after N seconds | +| canary w/ traffic routing + setCanaryScale | does not scale down (bug) | * | should behave like canary w/ traffic routing |