move relevant docs from RFDs 48, 61 into Omicron #6206
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Tagging myself to fix the RFD links. |
Collaborator
Author
|
Got a +1 on the control plane call today so I'm going to land this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RFDs 48 and 61 are some of the earliest ones to talk about the control plane in depth. They have a lot of really important information that's still true, as well as a bunch of stuff that's not that relevant or only of historical interest.
Since the architecture is something that evolves over time, I think it makes more sense for this documentation to live here, with the software, rather than in those RFDs. If folks agree and we decide to land this, I will update RFDs 48 and 61 with a big comment at the top explaining that the document is historical, some information is still accurate, but the canonical system documentation lives here in the Omicron repo.
Edit: to be clear, much of the content here is lifted directly from RFDs 48 and 61. I have also edited it where it made sense, added new stuff, etc.
Edit 2: part of the purpose here is a place to put general design principles that come up a lot in chat and reviews but aren't really documented anywhere. I started writing some of those in section 4 of the new doc.
I'm thinking it'd be nice if this were a first step towards a better organized Omicron Engineering Guide, maybe as an asciidoc book or something like the Cargo book.