-
Notifications
You must be signed in to change notification settings - Fork 99
docs: add a glossary of core terms #200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Frederick F. Kautz IV (fkautz)
wants to merge
2
commits into
agent-substrate:main
Choose a base branch
from
fkautz:docs/glossary
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+88
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # Agent Substrate Glossary | ||
|
|
||
| This document defines the core terms used across Agent Substrate. | ||
|
|
||
| For how the pieces fit together, see the [Architecture](architecture.md) and | ||
| [API Guide](api-guide.md). | ||
|
|
||
| ## Resources (declarative, Kubernetes CRDs) | ||
|
|
||
| - **ActorTemplate**: the definition of an actor "class": the container image(s) | ||
| and snapshot configuration. Creating an `ActorTemplate` triggers creation of | ||
| a [Golden Snapshot](#snapshots). It is treated as immutable: you create a new | ||
| template for a new version rather than editing an existing one. It is | ||
| analogous to a Pod template, but for a checkpointable workload. | ||
|
|
||
| - **WorkerPool**: declares warm compute capacity, a fleet of pre-started worker | ||
| pods. It is reconciled into a Kubernetes `Deployment` by the | ||
| [atecontroller](#components). | ||
|
|
||
| ## Records (dynamic state, in the control-plane store) | ||
|
|
||
| These are not Kubernetes objects; they live in the control-plane database | ||
| because they change too frequently for etcd. | ||
|
|
||
| - **Actor**: a single instance derived from an `ActorTemplate`, identified by a | ||
| DNS-1123 actor ID. It is the unit that is suspended and resumed, and it moves | ||
| between workers over its lifetime. An Actor record tracks its lifecycle | ||
| status and snapshot references. | ||
|
|
||
| - **Worker**: a record representing one worker pod in a `WorkerPool`. A Worker | ||
| hosts at most one Actor at a time; many Actors are multiplexed across a pool | ||
| over time. | ||
|
|
||
| ## Components | ||
|
|
||
| - **ate-api-server** (binary `ateapi`): the control plane. It owns the Actor | ||
| lifecycle, schedules Actors onto Workers, and coordinates their snapshots, | ||
| all backed by the state store. The `kubectl-ate` CLI talks to it. | ||
|
|
||
| - **atecontroller**: the Kubernetes controller that reconciles the CRDs (for | ||
| example, it turns a `WorkerPool` into a `Deployment`). | ||
|
|
||
| - **atelet**: the node-level supervisor, run as a DaemonSet. It pulls images, | ||
| assembles OCI bundles, drives the sandbox lifecycle on the node via ateom, | ||
| and streams snapshots to and from snapshot storage. | ||
|
|
||
| - **ateom**: the coordinator that runs inside each worker pod and drives the | ||
| sandbox runtime on behalf of atelet. This decouples the physical pod | ||
| lifecycle from the sandboxed agent process. | ||
|
|
||
| - **atenet**: the networking stack. It provides a DNS server for actor | ||
| resolution and a router that resumes suspended Actors on demand and routes | ||
| traffic to the right worker pod. | ||
|
|
||
| - **podcertcontroller**: issues short-lived pod certificates that components | ||
| use as their TLS identity to authenticate connections to one another | ||
| (mutual TLS). | ||
|
|
||
| - **kubectl-ate**: a `kubectl` plugin CLI for managing the Actor lifecycle and | ||
| listing Workers. | ||
|
|
||
| ## Lifecycle | ||
|
|
||
| - **Suspend**: hibernate a running Actor by checkpointing it to a snapshot and | ||
| freeing its Worker. | ||
|
|
||
| - **Resume**: activate a suspended Actor by restoring it onto a Worker. The | ||
| common path restores from a snapshot rather than cold-booting. | ||
|
|
||
| ## Snapshots | ||
|
|
||
| - **Golden Snapshot**: the initial checkpoint captured once, when an | ||
| `ActorTemplate` is created, from a temporary "golden" boot of the workload. | ||
| By default an Actor of that template is first restored from this shared | ||
| snapshot. | ||
|
|
||
| - **Last Snapshot**: the most recent per-Actor snapshot, written on Suspend and | ||
| used to restore that specific Actor on the next Resume. | ||
|
|
||
| - **Snapshot storage**: the object store (GCS or S3) where snapshots are | ||
| persisted so Actor state is durable and portable across the cluster. | ||
|
|
||
| ## Networking | ||
|
|
||
| - **Uniform DNS Mesh**: every Actor is reachable at a uniform address, | ||
| `<actor-id>.actors.resources.substrate.ate.dev`, resolved by atenet. Traffic to | ||
| that name is routed (and the Actor resumed if needed) automatically. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should be careful about where we are defining things. For a glossary, I would expect it to remain at a high level vs referencing things like enum states etc as this will be hard to maintain consistency across the entire codebase. In addition, having multiple sources of definitions may confuse the agent coding depending on which source they end up referencing.
Can we keep the glossary definitions to be summaries at the high level? More low level descriptions should be kept as close to the code definitions as possible (i.e. in docstrings) so there are less consistency issues.
This comment applies in general to the other entries...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense. Cut the state sequence and RPC/enum detail throughout, leaving short summaries. Filed #236 to move that detail into docstrings near the code. Applied your "in general" note to the other entries too.