oxidecomputer / oxidecomputer/omicron
Want versioned crate for Omicron networking types
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
In #10101 and #10070 (and others), we ran into issues trying to both version some networking types in omicron-common, and also pull those out of common entirely to slim things down. In #10101 at least, the issue was a circular dependency between those crates and illumos-utils. That latter is the point that we convert from Omicron types into OPTE types for firewall rules, and we can't easily pull out all the types because of the details of that conversion.
We probably want a new, versioned types crate for networking specifically. It might be hard to keep this from ballooning into a new omicron-common, but at least it will be versioned.
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 issues #10101 and #10070, then trace the dependencies among omicron-common, illumos-utils, and the OPTE conversion point. Define the scope of a versioned networking-types crate, ensuring the circular dependency is avoided and omicron-common can be slimmed without losing the required type conversions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- networking
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100