From c8f050230d6eed1dd7e50b99cf4f09fd82165708 Mon Sep 17 00:00:00 2001 From: Kenta Nakase Date: Thu, 29 Sep 2022 03:21:08 +0900 Subject: [PATCH] Fix description about baseline-and-canary-replicas (#241) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8bab8a720..5061f3ada 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Following are the key capabilities of this action: Used to compute the number of replicas of '-baseline' and '-canary' variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating '-baseline' and '-canary'.

For example, if Deployment hello-world was found in the input manifest file with 'replicas: 4' and if 'strategy: canary' and 'percentage: 25' are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The '-baseline' variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the '-canary' variant is created with the image and tag corresponding to the new changes being deployed - baseline-and-canary-replicas

(Optional and relevant only if traffic-split-method is canary) + baseline-and-canary-replicas

(Optional and relevant only if strategy is canary and traffic-split-method is smi) The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action

    strategy: canary
    trafficSplitMethod: smi
    percentage: 20
    baselineAndCanaryReplicas: 1

In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.