Skip to content

Commit

Permalink
Update retry docs. (#1708)
Browse files Browse the repository at this point in the history
* Update retry docs.

Fixes #1694

Signed-off-by: Flynn <[email protected]>

* Include 64KiB limit.

Signed-off-by: Flynn <[email protected]>

* Link to retry blog post.

Signed-off-by: Flynn <[email protected]>

---------

Signed-off-by: Flynn <[email protected]>
  • Loading branch information
kflynn authored Nov 20, 2023
1 parent 6bddca9 commit a611443
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 10 deletions.
11 changes: 9 additions & 2 deletions linkerd.io/content/2-edge/tasks/configuring-retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ for a tutorial of how to configure retries.

## Retries

For routes that are idempotent and don't have bodies, you can edit the service
profile and add `isRetryable` to the retryable route:
For routes that are idempotent, you can edit the service profile and add
`isRetryable` to the retryable route:

```yaml
spec:
Expand All @@ -47,6 +47,13 @@ spec:
isRetryable: true ### ADD THIS LINE ###
```
Retries are supported for _all_ idempotent requests, whatever verb they use,
and [whether or not they have a body]. In particular, this mean that gRPC
requests can be retried. However, requests will not be retried if the body
exceeds 64KiB.
[whether or not they have a body]:../../../2021/10/26/how-linkerd-retries-http-requests-with-bodies/
## Retry Budgets
A retry budget is a mechanism that limits the number of retries that can be
Expand Down
11 changes: 9 additions & 2 deletions linkerd.io/content/2.11/tasks/configuring-retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ for a tutorial of how to configure retries.

## Retries

For routes that are idempotent and don't have bodies, you can edit the service
profile and add `isRetryable` to the retryable route:
For routes that are idempotent, you can edit the service profile and add
`isRetryable` to the retryable route:

```yaml
spec:
Expand All @@ -39,6 +39,13 @@ spec:
isRetryable: true ### ADD THIS LINE ###
```
Retries are supported for _all_ idempotent requests, whatever verb they use,
and [whether or not they have a body]. In particular, this mean that gRPC
requests can be retried. However, requests will not be retried if the body
exceeds 64KiB.
[whether or not they have a body]:../../../2021/10/26/how-linkerd-retries-http-requests-with-bodies/
## Retry Budgets
A retry budget is a mechanism that limits the number of retries that can be
Expand Down
11 changes: 9 additions & 2 deletions linkerd.io/content/2.12/tasks/configuring-retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ for a tutorial of how to configure retries.

## Retries

For routes that are idempotent and don't have bodies, you can edit the service
profile and add `isRetryable` to the retryable route:
For routes that are idempotent, you can edit the service profile and add
`isRetryable` to the retryable route:

```yaml
spec:
Expand All @@ -47,6 +47,13 @@ spec:
isRetryable: true ### ADD THIS LINE ###
```
Retries are supported for _all_ idempotent requests, whatever verb they use,
and [whether or not they have a body]. In particular, this mean that gRPC
requests can be retried. However, requests will not be retried if the body
exceeds 64KiB.
[whether or not they have a body]:../../../2021/10/26/how-linkerd-retries-http-requests-with-bodies/
## Retry Budgets
A retry budget is a mechanism that limits the number of retries that can be
Expand Down
11 changes: 9 additions & 2 deletions linkerd.io/content/2.13/tasks/configuring-retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ for a tutorial of how to configure retries.

## Retries

For routes that are idempotent and don't have bodies, you can edit the service
profile and add `isRetryable` to the retryable route:
For routes that are idempotent, you can edit the service profile and add
`isRetryable` to the retryable route:

```yaml
spec:
Expand All @@ -47,6 +47,13 @@ spec:
isRetryable: true ### ADD THIS LINE ###
```
Retries are supported for _all_ idempotent requests, whatever verb they use,
and [whether or not they have a body]. In particular, this mean that gRPC
requests can be retried. However, requests will not be retried if the body
exceeds 64KiB.
[whether or not they have a body]:../../../2021/10/26/how-linkerd-retries-http-requests-with-bodies/
## Retry Budgets
A retry budget is a mechanism that limits the number of retries that can be
Expand Down
11 changes: 9 additions & 2 deletions linkerd.io/content/2.14/tasks/configuring-retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ for a tutorial of how to configure retries.

## Retries

For routes that are idempotent and don't have bodies, you can edit the service
profile and add `isRetryable` to the retryable route:
For routes that are idempotent, you can edit the service profile and add
`isRetryable` to the retryable route:

```yaml
spec:
Expand All @@ -47,6 +47,13 @@ spec:
isRetryable: true ### ADD THIS LINE ###
```
Retries are supported for _all_ idempotent requests, whatever verb they use,
and [whether or not they have a body]. In particular, this mean that gRPC
requests can be retried. However, requests will not be retried if the body
exceeds 64KiB.
[whether or not they have a body]:../../../2021/10/26/how-linkerd-retries-http-requests-with-bodies/
## Retry Budgets
A retry budget is a mechanism that limits the number of retries that can be
Expand Down

0 comments on commit a611443

Please sign in to comment.