tractor/docs/guide
Gud Boi 4d10282c1f Document TIPC-over-`wg`, add a handoff doc
Anticipating gh #502 — TIPC over a WireGuard mesh as our go-to
multihost tpt deployment — plus a cold-start handoff for whoever
(or whatever) picks this up next.

The wg deats, both verified locally,
- a wg iface is L3/`tun` (`POINTOPOINT,NOARP`, `link/none`, no
  L2 addr) so TIPC's `eth` media **cannot** bind it; the udp
  bearer is *mandatory* over wg, not merely an alternative.
  Also its ~1420 MTU sits under ethernet's 1500.
- the composed deployment maddr is
  `/ip4/<pub>/udp/51820/wg/u<key>/tipc/<stype>/<inst>/<scope>`.
  XXX note the tipc segment has NO locative part unlike tcp's
  inner `/ip4/../tcp/..` — a service name is
  location-independent, so wg carries routing and tipc carries
  identity. That's the argument for one `/tipc` proto w/ a
  structured value in the #498 spec proposal.

XXX ALSO correcting a premise: TIPC is **not** unencrypted. It
ships AES-GCM crypto (`tipc node set key`, linux 5.9+) w/
cluster/master/per-node keys + rekeying. Those keys are
symmetric+pre-shared tho, so wg is still preferred for
public-key identity, NAT traversal, and one overlay every tpt
can share.

`01_tipc_HANDOFF.md` is deliberately provider-neutral: env
setup, the hard-won kernel facts table, the two closed design
decisions (+why), what landed, the pre-land TODOs and the repo's
working conventions.

(this patch was generated in some part by `claude-code` using `claude-opus-5` (`anthropic`))
2026-09-01 20:00:29 -04:00
..
asyncio.rst Expose stream subscriber lag policy 2026-08-27 21:18:00 -04:00
cancellation.rst Clarify owned-child hard-reap docs 2026-08-25 15:56:38 -04:00
clustering.rst Clarify `to_actor.run()` ownership 2026-08-21 15:03:34 -04:00
context.rst Clarify `to_actor.run()` ownership 2026-08-21 15:03:34 -04:00
debugging.rst Write the big boi docs content tree 2026-06-28 13:29:01 -04:00
discovery.rst Move network APIs to lazy `tractor.net` 2026-09-01 18:10:53 -04:00
index.rst Add a `tipc` guide page, roster it in the docs 2026-09-01 20:00:29 -04:00
msging.rst Correct typed-msg validation docs 2026-08-29 20:07:06 -04:00
parallelism.rst Showcase `to_actor.run()` across docs 2026-08-21 15:03:34 -04:00
rpc.rst Polish `to_actor` examples and references 2026-08-25 15:20:34 -04:00
spawning.rst Correct `to_actor.run()` target guidance 2026-08-21 15:03:35 -04:00
streaming.rst Reject concurrent `BroadcastReceiver.receive()` calls 2026-08-27 22:11:55 -04:00
testing.rst Make UDS reaping platform-aware 2026-08-14 10:36:27 -04:00
tipc.rst Document TIPC-over-`wg`, add a handoff doc 2026-09-01 20:00:29 -04:00