Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify the setCanaryScale of Dynamic Canary Scale #1703

Merged
merged 1 commit into from
Jan 12, 2022
Merged

docs: clarify the setCanaryScale of Dynamic Canary Scale #1703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/features/canary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ match the traffic weight. Some use cases for this:
Setting canary scale is only available when using the canary strategy with a traffic router, since
the basic canary needs to control canary scale in order to approximate canary weight.

To control canary weights during steps, use the `setCanaryScale` step and indicate which scale the
To control canary scales and weights during steps, use the `setCanaryScale` step and indicate which scale the
the canary should use:

* explicit replica count
* explicit weight percentage of total spec.replicas
* to match current canary setWeight
* explicit replica count without changing traffic weight (`replicas`)
* explicit weight percentage of total spec.replicas without changing traffic weight(`weight`)
* to or not to match current canary's `setWeight` step (`matchTrafficWeight: true or false`)

```yaml
spec:
Expand Down Expand Up @@ -120,12 +120,16 @@ spec:
strategy:
canary:
steps:
# 1 canary pod (10% of spec.replicas)
- setCanaryScale:
weight: 10
# 90% of traffic to the 1 canary pod
- setWeight: 90
- pause: {}
```

The above situation is caused by the changed behvaior of `setWeight` after `setCanaryScale`. To reset, set `matchTrafficWeight: true` and the `setWeight` behavior will be restored, i.e., subsequent `setWeight` will create canary replicas matching the traffic weight.

## Dynamic Stable Scale (with Traffic Routing)

!!! important
Expand Down