Skip to content

docs(operational): Layer 0 integration with ssh-proxy - #20

Open
David Mireles (louzt) wants to merge 1 commit into
mainfrom
docs/layer0-integration
Open

docs(operational): Layer 0 integration with ssh-proxy#20
David Mireles (louzt) wants to merge 1 commit into
mainfrom
docs/layer0-integration

Conversation

@louzt

@louzt louzt commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites as a generic OSS deployment guide
replacing operator-specific infrastructure references with universally applicable
SnapPipe deployment topologies.

Scope boundary

  • Adds: generic topologies, embedded relay example, configuration reference
  • Does not change: any code, API, tests, or binary behavior
  • Removes: private ssh-proxy/5-tier references, private gist links

Files

  • : full rewrite, public content
  • : new — ignores
  • : new — internal agent guide (gitignored)

Validation

cargo clippy --locked --all-targets -- -D warnings  # green
cargo fmt --all  # applied

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The deployment guide adds a “Layer 0: SnapPipe-gated QUIC” subsection describing relay handshake validation, stream forwarding, failure handling, the five-tier fallback path, and the TLS-Direct bypass case study.

Changes

Deployment documentation

Layer / File(s) Summary
Document Layer 0 QUIC flow
docs/OPERATIONAL-DEPLOYMENT.md
Adds the VPS run_listener relay to the five-tier fallback stack, documents stream 0 ticket and trust validation, forwards streams 1..N after success, closes failed connections, and links to the TLS-Direct bypass case study.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the documentation change about Layer 0 integration with the ssh-proxy fallback chain.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/layer0-integration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/OPERATIONAL-DEPLOYMENT.md`:
- Around line 173-176: The description of run_listener in the deployment docs
implies the SnapPipe ticket handshake on stream 0 happens before the QUIC
connection is accepted, which is misleading. Update the wording around
run_listener in OPERATIONAL-DEPLOYMENT.md to state that it accepts the QUIC
connection first, then validates the SnapPipe ticket on stream 0 before
forwarding streams 1..N. Keep the reference to run_listener and the Layer 0
fallback role, but remove any phrasing that suggests the stream-0 handshake is
already completed before connection acceptance.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b3ef321a-e51a-44df-8181-0dc110c08872

📥 Commits

Reviewing files that changed from the base of the PR and between ad3df11 and b21e962.

📒 Files selected for processing (1)
  • docs/OPERATIONAL-DEPLOYMENT.md

Comment thread docs/OPERATIONAL-DEPLOYMENT.md Outdated
- Replaces operator-specific infra (ssh-proxy, 5-tier, private gists)
  with generic deployment topologies any SnapPipe user can follow
- Adds minimal embedded relay example (run_listener usage)
- Adds docs/.gitignore to gitignore agents.md (private agent guide)
- Adds docs/agents.md (internal context, gitignored)

This file is public; no operator-specific details.
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.

1 participant