docs: add architecture diagrams (resource model, activation, lifecycle)#245
Open
Frederick F. Kautz IV (fkautz) wants to merge 2 commits into
Open
docs: add architecture diagrams (resource model, activation, lifecycle)#245Frederick F. Kautz IV (fkautz) wants to merge 2 commits into
Frederick F. Kautz IV (fkautz) wants to merge 2 commits into
Conversation
Add the sequence, class, and state diagrams to architecture.md, where people look for diagrams when modifying the system. Each lands in the section whose prose already describes it: the resource model under API Resource Models, and the activation flow and lifecycle state machine under Actor Lifecycle. This is the companion to agent-substrate#200, which drops the same diagrams from the glossary to keep it a plain list of terms (per review feedback). Every diagram claim was verified against the current implementation. The activation note no longer implies idle-triggered suspend, since SuspendActor is an explicit call with no idle-detection mechanism.
| } | ||
| } | ||
|
|
||
| namespace ControlPlaneRecords { |
Collaborator
There was a problem hiding this comment.
Maybe ate-apiserver instead of ControlPlaneRecords and kube-apiserver instead of KubernetesObjects?
Contributor
Author
There was a problem hiding this comment.
Good idea, done.
Rename the class-diagram namespaces from the abstract categories (KubernetesObjects / ControlPlaneRecords) to the servers that actually own the records: kube-apiserver (ActorTemplate/WorkerPool CRDs, Deployment, WorkerPod) and ate-api-server (Actor/Worker, the proto records persisted in Redis). Per review feedback on agent-substrate#245. Uses the hyphenated ate-api-server to match the deployed Service and Deployment, the client dial address, and the rest of this doc, rather than the ate-apiserver spelling that only appears in an install flag.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds three Mermaid diagrams to
docs/architecture.md, each placed in the section whose prose already describes it:These diagrams previously lived in the glossary. This PR is the companion to #200, which slims the glossary back to a plain list of terms per review feedback; the diagrams move here, where people look when modifying the system, rather than being dropped.
Docs only; no code changes.