Skip to content

docs: add fallback feature doc #642

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

yuzisun
Copy link
Contributor

@yuzisun yuzisun commented May 27, 2025

Commit Message
Add provider fallback feature doc.

Signed-off-by: Dan Sun <[email protected]>
@yuzisun yuzisun requested a review from a team as a code owner May 27, 2025 04:02
@yuzisun yuzisun changed the title doc: Add Fallback feature doc docs: Add Fallback feature doc May 27, 2025
@yuzisun yuzisun changed the title docs: Add Fallback feature doc docs: add fallback feature doc May 27, 2025
Signed-off-by: Dan Sun <[email protected]>
splitExternalLocalOriginErrors: false
```

## When to Use Fallback
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider moving this section before the code example.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The motivation can be helpful for a user to see before the example :)

Copy link
Contributor

@kerthcet kerthcet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @yuzisun really clear.

## How Fallback Works

- **Primary and Fallback Backends:** You can specify a prioritized list of backends in your `AIGatewayRoute` using `backendRefs`. The first backend is treated as primary, and subsequent backends are considered fallbacks.
- **Health Checks:** Fallback is triggered based on passive health checks and retry policies, which can be configured using the [`BackendTrafficPolicy`](https://gateway.envoyproxy.io/contributions/design/backend-traffic-policy/) API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth to mention that the the HttpRouter is sharing the same name with the AIGatewayRoute.

@mathetake mathetake added this to the v0.2.0 milestone May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants