internals documentation with diagrams #14750
Merged
Conversation
This file contains 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
This changeset adds new architecture internals documents to the contributing guide. These are intentionally here and not on the public-facing website because the material is not required for operators and includes a lot of diagrams that we can cheaply maintain with mermaid syntax but would involve art assets to have up on the main site that would become quickly out of date as code changes happen and be extremely expensive to maintain. However, these should be suitable to use as points of conversation with expert end users. Included: * A description of Evaluation triggers and expected counts, with examples. * A description of Evaluation states and implicit states. This is taken from an internal document in our team wiki. * A description of how writing the State Store works. This is taken from a diagram I put together a few months ago for internal education purposes. * A description of Evaluation lifecycle, from registration to running Allocations. This is mostly lifted from @lgfa29's amazing mega-diagram, but broken into digestible chunks and without multi-region deployments, which I'd like to cover in a future doc. Also includes adding Deployments to our public-facing glossary.
This was referenced Sep 29, 2022
tgross
added
theme/docs
lgfa29
approved these changes
Sep 29, 2022
Comment on lines
152
to
153
| Note right of workerFSM: Schedulers run on all servers | ||
| Note right of workerFSM: So this may query the leader state store directly |
There was a problem hiding this comment.
I tried to make these fit into the yellow box using <br /> but Mermaid is not having it 😅
There was a problem hiding this comment.
Yeah it's... imperfect. 😁
schmichael
reviewed
Sep 30, 2022
Co-authored-by: Luiz Aoqui <[email protected]> Co-authored-by: Michael Schurter <[email protected]>
shoenig
reviewed
Sep 30, 2022
Co-authored-by: Seth Hoenig <[email protected]>
|
(@mikenomitch I originally flagged you for review but really that was intended to be informational as we've got some field folks anticipating these docs, I'll remove you as a reviewer but just FYI 😀 ) |
schmichael
reviewed
Sep 30, 2022
tgross
force-pushed
the
docs-deployments-and-evals
branch
from
16eaea4 to
e6b4cb2
Compare
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #13731
Fixes #13468
Fixes #8588
This changeset adds new architecture internals documents to the contributing guide. These are intentionally here and not on the public-facing website because the material is not required for operators and includes a lot of diagrams that we can cheaply maintain with mermaid syntax but would involve art assets to have up on the main site that would become quickly out of date as code changes happen and be extremely expensive to maintain. However, these should be suitable to use as points of conversation with expert end users.
Included:
Also includes adding Deployments to our public-facing glossary. (preview)