design: expected final ateapi.proto for decoupled substrate resources (#368)#378
Draft
Eitan Yarmush (EItanya) wants to merge 1 commit into
Draft
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
6309f19 to
7553814
Compare
Draft the target ateapi surface for issue agent-substrate#368 (ActorTemplate, WorkerPool, SandboxConfig, WorkerPoolGrant moved out of Kubernetes CRDs), following the draft API style guide (agent-substrate#351), plus design rationale and CRD migration notes. For review only: codegen and server implementation intentionally lag the proto.
7553814 to
1af11b5
Compare
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
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.
What
Draft of the expected final
ateapi.protoonce ActorTemplate, WorkerPool, SandboxConfig and WorkerPoolGrant move out of Kubernetes CRDs into the substrate API — the alignment artifact requested in #368. For review of the API shape only: codegen and server implementation intentionally lag the proto.pkg/proto/ateapipb/ateapi.proto— the target surface, edited in place so the diff shows exactly what changesdocs/design/ateapi-resource-api.md— resource model and design decisions (D1–D15)docs/design/ateapi-crd-migration.md— transition from the CRDs/POC: what changes and why, migration pathShape highlights
ateapi.v1alpha1(gRPC paths embed the package → API versioning); every message is a fresh type, migration is a client cutoverResourceMetadata meta = 1, sharedObjectRef, standard method shapes, requiredupdate_mask,int64 versionoptimistic concurrencyControl(tenant: atespaces, templates, actors) /Admin(platform: pools, sandbox configs, grants, debug)WorkerPoolSpec.kubernetes(KubernetesPlacement); everything outside it is plane-neutral. The POC'sdeployment_atespaceis honestly renamedkubernetes.namespace(atespace, worker_pool)oneofenv source with plane-neutralSecretRef; equality-onlySelectorSYNCEDmarker → at-least-once incremental eventsFour deliberate style-guide divergences are listed in the design doc; filing those as feedback on #351 separately.
Review focus
The resource-model table and decisions D1–D15 in
docs/design/ateapi-resource-api.mdare the consensus surface — the proto is those decisions spelled out.Refs #368
Julian Gutierrez Oschmann (@juli4n) the scope of this got a bit bigger than expected. I started gaming out the API decisions as per the new API guidelines and some of those bled into the overall proto design. We can always scope down if we think there's too much in here