Canary upgrades doc : same namespace appeared several times into a schema.

blackpegaz commented 8 months ago

Is this the right place to submit this?

[X] This is not a security vulnerability or a crashing bug
[X] This is not a question about how to use Istio

Bug Description

Hi,

Into the Stable revision labels section, this schema shows the same namespace name (app-ns-2) tree times.

In this case, does the namespace app-ns-3 use the tag prod-canary or has it already been relabelled to use the tag prod-stable ?

Doc page : Canary Upgrades

Regards

Benjamin

Version

Current

Additional Information

No response

hanxiaop commented 8 months ago

In this case, does the namespace app-ns-3 use the tag prod-canary or has it already been relabelled to use the tag prod-stable ?

It has been relabelled to prod-stable as you can see there's a command to overwrite the webhook:

istioctl tag set prod-stable --revision 1-20-2 --overwrite

hanxiaop commented 8 months ago

BTW I think the pic in the doc needs to be fixed, I'll transfer the issue.

windsonsea commented 8 months ago

/assign To fix the image in doc

blackpegaz commented 8 months ago

In this case, does the namespace app-ns-3 use the tag prod-canary or has it already been relabelled to use the tag prod-stable ?

It has been relabelled to prod-stable as you can see there's a command to overwrite the webhook:
istioctl tag set prod-stable --revision 1-20-2 --overwrite

Thank you @hanxiaop. I read this information previously.

From my user perspective this part of the documentation gives a technical explanation on why and how to use "Stable revision labels" in a canary upgrade context, but, when I read it for the first time, I asked myself:

Is it possible to let the app workload points to the prod-canary tag at this step ?
When to remove the prod-canary tag ?
What is the best practice ?

Regarding helm canary upgrade, trying and testing step by step helped me to understand the solution.

In the below schema the prod-canary tag still exists at step 3 to show a possible situation. Personally, I choose to delete this tag as soon as the canary upgrade is finished.

istio-canary-upgrade-nonofficial-14528

istio / istio.io