Backport of Document how numRetries can't be set to 0 into release/1.14.x (#16168)

* backport of commit 55e197fad7

* backport of commit 1a6cf311c5

---------

Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com>
pull/16174/head
hc-github-team-consul-core 2023-02-06 11:20:30 -06:00 committed by GitHub
parent 6ca8b7491d
commit e8606d2028
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions

View File

@ -704,9 +704,11 @@ spec:
},
{
name: 'NumRetries',
type: 'int: 0',
description:
'The number of times to retry the request when a retryable result occurs.',
type: 'int: 1',
description: {
hcl: 'The number of times to retry the request when a retryable result occurs. You cannot set the value to `0`. To disable retries, unset all other retry settings (`RetryOnConnectFailure`, `RetryOn`, `RetryOnStatusCodes`)',
yaml: 'The number of times to retry the request when a retryable result occurs. You cannot set the value to `0`. To disable retries, unset all other retry settings (`retryOnConnectFailure`, `retryOn`, `retryOnStatusCodes`)',
}
},
{
name: 'RetryOnConnectFailure',