Skip to content

docs(adr): 1248 follow stock upstream NetBird and WireGuard, with a departures and watch list - #952

Merged
dlf-dds merged 1 commit into
mainfrom
docs/upstream-netbird-wireguard-watch
Nov 15, 2026
Merged

dlf-dds merged 1 commit into
mainfrom
docs/upstream-netbird-wireguard-watch

Conversation

@dlf-dds

@dlf-dds dlf-dds commented Nov 15, 2026

Copy link
Copy Markdown
Contributor

What this adds

  • ADR 1248 (Proposed): goat runs stock upstream NetBird and WireGuard wherever it can. Each departure (a patch in ops/netbird/patches/, goat-relay, the federated signal server, the Jetson WireGuard modules) is recorded with the upstream change that retires it. Upstream performance and functionality work is watched in one list; adopting any item is its own later decision. goat-relay follows upstream wire-protocol changes, and an upstream change that lowers transport protection is carried only as an option.
  • docs/design/upstream-netbird-wireguard-watch.md: the departures goat carries today and the watch list, one row per upstream item: the experimental feature/relay-ebpf branch, client socket buffers ([client] Size relay data-path socket buffers for throughput netbirdio/netbird#6774), the relay liveness change and the relay protocol description goat proposes upstream (Upstream to NetBird: the relay protocol description and the liveness fix, and track the experimental eBPF relay branch #950), Rosenpass deprecation and the ML-KEM alternative ([client] Mark Rosenpass as deprecated netbirdio/netbird#8372, #7098), WireGuard in Jetson kernels, and FIPS validation of WireGuard. The goat-owners team reviews it; it is updated in the pull request that moves NETBIRD_REF, in pull requests that change goat-relay-protocol, and when a linked upstream item changes state.
  • Links from ADR 0709's Related row and from docs/design/netbird-relay-wire-protocol.md; ADR 1248's row in docs/adr/INDEX.md rendered with ops/release/adr_index.py write.

No existing ADR states this rule across NetBird and WireGuard; ADR 0301, 1134 D6 and 0858 apply it to single components, so this is a new ADR that builds on them.

Refs #950, #949.

Checks run locally

adr_index.py check and --self-test, check-adr-status-vocabulary.py, check-adr-number-uniqueness.sh, check-adr-index-complete.sh, check-adr-index-status-agrees.sh, check-adr-status-vs-code.sh, check-doc-links.py, check-doc-code-citations.sh: all pass.

…epartures and watch list

Signed-off-by: dlf-dds <dene.farrell.gov@gmail.com>
@dlf-dds
dlf-dds requested a review from a team as a code owner November 15, 2026 22:26
@dlf-dds
dlf-dds merged commit 8959d47 into main Nov 15, 2026
49 checks passed
@dlf-dds
dlf-dds deleted the docs/upstream-netbird-wireguard-watch branch November 15, 2026 22:30
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