oxidecomputer / oxidecomputer/omicron

RSS networking configuration is easy to get wrong

Open
#9,369 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

When setting up a BGP configuration involving VLANs there are a few places to supply VLAN ids

  • The peer: means that routes that are learned through the peer have a VLAN tag applied
  • The address: means a VLAN device is created for the address to live on, so the subnet route associated with that address is tagged. This means the peer connection is on a tagged VLAN segment.

For simple (most?) deployments, the BGP control plane traffic (peering traffic) and learned routes are on the same VLAN. However it is valid for these to be different:

  • BGP control plane may be untagged and data plane may be tagged or vice versa.
  • BGP control plane and data plane may be on different VLANs.
  • Different peers may be on different VLANs which may be coupled or distinct from their BGP control plane traffic.

This makes writing useful validators hard to do. To solve that we should update our RSS configuration interface to be explicit about whether BGP control plane and data plane VLANs are coupled. Either users provide a single VLAN per peer/address combination for a coupled configuration, or they explicitly specify things are decoupled.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the RSS configuration interface and its validation logic. Read the peer and address VLAN semantics described here, then determine how the interface can explicitly represent coupled versus decoupled BGP control-plane and data-plane VLANs. Done means the configuration makes that relationship explicit and supports the listed valid combinations.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend-api-design, networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.