oxidecomputer / oxidecomputer/omicron

Clarify the usage and philosphy behind using `rack_id` and `switch_location` for association of switch port configurations

Open
#3,066 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently we are using rack_id and switch_location fields for determining where a port lives. There seems to still be a bit of uncertainty with this approach, so maybe we should clarify our intentions with using these with clear documentation, or reconsider their usage (if warranted). Maybe this Issue can be used for a more focused discussion.

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

The issue names the rack_id and switch_location fields but no files or tests. Start by locating their current uses and document the intended association of switch port configurations, or record a decided change in usage. Done means the project has an agreed, clearly documented approach.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.