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.

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

Improve MeshRetry docs and add missing MeshHTTPRoute targetRef #2110

Open
bartsmykla opened this issue Dec 4, 2024 · 0 comments
Open

Improve MeshRetry docs and add missing MeshHTTPRoute targetRef #2110

bartsmykla opened this issue Dec 4, 2024 · 0 comments
Labels
kind/docs About docs kind/improvement Improvement on an existing feature triage/accepted The issue was reviewed and is complete enough to start working on it

Comments

@bartsmykla
Copy link
Contributor

bartsmykla commented Dec 4, 2024

Description

The retryOn section in the MeshRetry docs is hard to understand. It’s not clear what each option means or how they work together. For example, when I tried to check if 503 responses were covered, I had to look at the Envoy docs because our docs didn’t help. The explanation about combining status codes (5xx, 429) and methods (HttpMethodGet) was confusing and made it seem like they couldn’t be used together.

Also, add MeshHTTPRoute should be added to the supported top level targetRefs

Suggested Fix

Update the retryOn section in the MeshRetry docs to clearly explain what each option does and how they can be combined.

Example Policy

type: MeshRetry
mesh: default
name: retry-policy
spec:
  targetRef:
    kind: Mesh
  to:
  - targetRef:
      kind: MeshService
      name: service-name
    default:
      http:
        retryOn:
        - Reset
        - ConnectFailure
        - HttpMethodGet
@bartsmykla bartsmykla added triage/pending This issue will be looked at on the next triage meeting kind/docs About docs kind/improvement Improvement on an existing feature labels Dec 4, 2024
@lukidzi lukidzi added triage/accepted The issue was reviewed and is complete enough to start working on it and removed triage/pending This issue will be looked at on the next triage meeting labels Dec 9, 2024
@kumahq kumahq deleted a comment from lukidzi Dec 10, 2024
@bartsmykla bartsmykla changed the title Improve MeshRetry docs to clarify the retryOn section Improve MeshRetry docs and add missing MeshHTTPRoute targetRef Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs About docs kind/improvement Improvement on an existing feature triage/accepted The issue was reviewed and is complete enough to start working on it
Projects
None yet
Development

No branches or pull requests

2 participants