oxidecomputer / oxidecomputer/omicron
Want PRBS API for switch ports
Open
Nobody has claimed this yet.
api
enhancement
Good for new hires
networking
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
Putting switch ports into a pseudorandom binary sequence (PRBS) mode is a helpful analysis and debugging tool. This capability is available in dendrite, but has not been plumbed up to the main API.
Example usage is here.
The API should allow users to
- Set the PRBS mode for a switch link
- Query the current PRBS mode of a switch link
- Get PRBS counters for a switch link
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked dendrite example and tracing how switch-link APIs are exposed in Omicron. Define and implement API support for setting and querying a link's PRBS mode and retrieving its PRBS counters. Done means all three operations are available through the main API and behave consistently with dendrite.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100