Forward-merge release/0.6 into main#508
Merged
Merged
Conversation
#### Overview Provide one canonical, versioned setup and validation guide for the experimental Switchyard integration in NeMo Relay 0.6.0. The guide makes the external Decision API boundary explicit and presents the release-specific setup in one place. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Expand the existing Fern Switchyard overview with a plain-language introduction, architecture diagram, component ownership table, exact prerequisites, and sibling checkout layout. - Add a copyable build and real-service E2E workflow pinned to Switchyard commit `8f9db9a6a47f848cdff1d262276ba25a8ae9cbc8`, including the expected weak/strong/strong routing sequence. - Document the E2E ports, health checks, ATOF-informed routing behavior, configuration boundary, and common preflight or startup failures. - Keep the configuration page as the exhaustive option reference while adding the NeMo Relay 0.6 external-service warning and versioned source links. - Point the Switchyard crate and example READMEs to the canonical Fern guide. Validation: - `just docs` - `just docs-linkcheck` - Focused pre-commit checks for all four changed files, including external link validation - All-files pre-commit checks with the three attribution generators skipped; all remaining hooks passed - Pinned real-service E2E: `real Switchyard E2E passed: ['provider/weak', 'provider/strong', 'provider/strong']` - Missing checkout, mismatched commit, Relay readiness timeout, and preserved-log failure paths The all-files Rust attribution generator rewrites the release branch's checked-in `ATTRIBUTIONS-Rust.md` despite no Cargo or lockfile changes. That unrelated generated drift is excluded from this documentation-only PR. Breaking changes: none. #### Where should the reviewer start? Start with `docs/configure-plugins/switchyard/about.mdx`, especially the NeMo Relay 0.6 architecture boundary, copyable compatibility workflow, and troubleshooting table. Then review the narrower cross-links in the configuration page and two READMEs. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: [RELAY-515](https://linear.app/nvidia/issue/RELAY-515) ## Summary by CodeRabbit - **Documentation** - Updated Switchyard integration guidance for NeMo Relay 0.6.0’s service-based Decision API workflow. - Expanded the architecture overview, setup/build steps, and configuration/validation requirements. - Improved compatibility testing instructions, including expected smoke-test output and health/readiness expectations. - Added troubleshooting details for common failures like service readiness issues and port conflicts, with updated log references. - Refreshed integration example and resource links to the 0.6 release. Authors: - Bryan Bednarski (https://github.com/bbednarski9) Approvers: - Will Killian (https://github.com/willkill07) URL: #503
Author
|
SUCCESS - forward-merge complete. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Forward-merge triggered by push to release/0.6 that creates a PR to keep main up-to-date. If this PR is unable to be immediately merged due to conflicts, it will remain open for the team to manually merge. See forward-merger docs for more info.