Skip to content

docs(iii-directory): add worker microVM service-exposure skill - #659

Open
anthonyiscoding wants to merge 1 commit into
mainfrom
add/worker-vm-service-skill
Open

docs(iii-directory): add worker microVM service-exposure skill#659
anthonyiscoding wants to merge 1 commit into
mainfrom
add/worker-vm-service-skill

Conversation

@anthonyiscoding

@anthonyiscoding anthonyiscoding commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Adds the microVM service-exposure how-to as a skill leaf on iii-directory, verbatim as supplied.

How iii-directory supports this (native, no code change):

  • .github/scripts/build_skills_payload.py walks <worker>/skills/**/*.md and publishes every non-overview leaf as skills/<rel>.md.
  • iii-directory/src/sources/registry.rs strips the leading skills/ segment on download, so the file lands at <skills_folder>/iii-directory/worker-microvm-service.md.
  • Readable as skill id iii-directory/worker-microvm-service via directory::skills::get; title / type come from the frontmatter the doc already carries.

Verified locally: build_skills_payload.py --worker iii-directory emits ['SKILL.md', 'skills/worker-microvm-service.md'].

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added guidance for exposing HTTP and WebSocket services from worker microVMs.
    • Documented runtime behavior, networking constraints, loopback limitations, health checks, and outbound connectivity.
    • Added instructions for guest-initiated tunneling, connection handling, retries, and diagnostics.
    • Documented how to embed worker UI assets in the console, including scripts, styles, pages, forms, and renderers.

Ships the verified microVM networking map, the guest-initiated tunnel
pattern for reaching an in-VM HTTP/WebSocket service from a browser, and
the console injectable-UI contract, as a skill leaf under
iii-directory/skills/ (published as skills/worker-microvm-service.md,
read as skill id iii-directory/worker-microvm-service).

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
workers Ready Ready Preview Jul 31, 2026 6:04pm
workers-tech-spec Ready Ready Preview Jul 31, 2026 6:04pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

skill-check — worker

0 verified, 51 skipped (no docs/).

Layer Result
structure
vale
ai
render

Four for four. Nicely done.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ebcba485-9673-4f0e-8576-0d1cdc72f88d

📥 Commits

Reviewing files that changed from the base of the PR and between 8f14fa7 and 7708023.

📒 Files selected for processing (1)
  • iii-directory/skills/worker-microvm-service.md

📝 Walkthrough

Walkthrough

The new guide documents services inside libkrun worker microVMs. It covers runtime boundaries, egress-only networking, guest-initiated HTTP/WebSocket tunnels, host relay bootstrapping, diagnostics, and console UI injection.

Changes

Worker microVM service integration

Layer / File(s) Summary
Runtime and networking model
iii-directory/skills/worker-microvm-service.md
Documents microVM detection, guest filesystem and runtime boundaries, supported network routes, loopback limitations, and health-check behavior.
Tunnel and relay operation
iii-directory/skills/worker-microvm-service.md
Defines authenticated pooled tunnels for HTTP and WebSocket traffic, host byte-pumping, retries, health probes, and relay installation through worker shell functions.
Diagnostics and console integration
iii-directory/skills/worker-microvm-service.md
Adds debugging commands and documents injectable console scripts, styles, pages, configuration forms, triggers, and rendering constraints.

Estimated code review effort: 2 (Simple) | ~10 minutes

Sequence Diagram(s)

sequenceDiagram
  participant GuestService
  participant TunnelSocket
  participant HostRelay
  participant HostLoopback
  GuestService->>TunnelSocket: Open authenticated pooled connection
  TunnelSocket->>HostRelay: Handoff HTTP or WebSocket traffic
  HostRelay->>HostLoopback: Pump bytes to host service
  HostLoopback-->>HostRelay: Return service response
  HostRelay-->>GuestService: Relay response through tunnel
Loading

Poem

I’m a rabbit in a microVM nest,
Tunneling bytes from east to west.
Relay boots, health checks glow,
Console pages hop in tow.
HTTP and WebSockets now flow best!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the added documentation for exposing services from worker microVMs.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Fix failing CI checks
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add/worker-vm-service-skill

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.

@anthonyiscoding anthonyiscoding added the no-ticket PR deliberately has no Linear ticket (bump/typo/CI-only) label Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-ticket PR deliberately has no Linear ticket (bump/typo/CI-only)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant