api icon indicating copy to clipboard operation
api copied to clipboard

Update VirtualService docs with defaults for retry behaviour, remove required attribute on attempts

Open Niksko opened this issue 4 years ago • 12 comments

This updates the documentation for the VirtualService resource to include the default values for the onRetry, attempts and retryRemoteLocalities fields. It also updates the main HTTPRoute docs to include a note that retries are enabled by default, and that the policy defaults to the default values for each field.

Niksko avatar Mar 04 '21 23:03 Niksko

😊 Welcome @Niksko! This is either your first contribution to the Istio api repo, or it's been awhile since you've been here.

You can learn more about the Istio working groups, code of conduct, and contributing guidelines by referring to Contributing to Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Mar 04 '21 23:03 istio-policy-bot

Hi @Niksko. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

istio-testing avatar Mar 04 '21 23:03 istio-testing

lg, can you add default attempts doc. It is 2 by default.

I thought attempts was a required field? Or is the behaviour that if you omit the whole retries field, then you get attempts: 2?

EDIT: Ah, I see, yes, if you omit the retries field you get 2 retries by default. I'll update the docs to mention this.

Niksko avatar Mar 05 '21 06:03 Niksko

Updated to document attempts and retryRemoteLocalities, as well as adding a note that indicates that retries are enabled by default

Niksko avatar Mar 05 '21 06:03 Niksko

I've only updated the proto for v1alpha3. Should I be updating the v1beta1 proto as well/instead?

Niksko avatar Mar 05 '21 06:03 Niksko

/ok-to-test

ericvn avatar Mar 05 '21 15:03 ericvn

Added the cherrypick-1.9 label so this would be cherrypicked back to the release-1.9 branch and changes picked up on istio.io (changes pulled at each patch release so not effective there on merge (preliminary.istio.io should pick up changes in master after a daily job is run))

ericvn avatar Mar 05 '21 15:03 ericvn

Can somebody please add the release-notes-none label (I don't think this needs release notes)

Niksko avatar Mar 08 '21 22:03 Niksko

/retest

Niksko avatar Mar 11 '21 04:03 Niksko

Can you make similar change to virtual service in v1beta1 as well? We need to keep both in sync.

linsun avatar Mar 13 '21 03:03 linsun

Can you make similar change to virtual service in v1beta1 as well? We need to keep both in sync.

@linsun I've updated the docs for v1beta1. Do I also need to remove the 'required' property of the attempts field in v1alpha3?

Niksko avatar Mar 15 '21 06:03 Niksko

@Niksko: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

istio-testing avatar May 26 '21 20:05 istio-testing

🚧 This issue or pull request has been closed due to not having had activity from an Istio team member since 2021-03-13. If you feel this issue or pull request deserves attention, please reopen the issue. Please see this wiki page for more information. Thank you for your contributions.

Created by the issue and PR lifecycle manager.

istio-policy-bot avatar May 15 '24 23:05 istio-policy-bot