docs: fix and fill gaps in the kubectl-ate CLI reference - #814
Open
botengyao wants to merge 1 commit into
Open
Conversation
Two more documented commands fail the way agent-substrate#561 fixed: the `--trace` example in the CLI README and `get actors` in the parking demo both omit `-a/--atespace`, which those commands require. Also in the CLI README: - The actor STATUS column listed 4 of the 8 states the API defines, missing PAUSING, PAUSED, CRASHED, and DELETING. - `pause actor` was undocumented, even though pause vs suspend (node-local vs uploaded snapshot) is the distinction users most need spelled out. - `top` was undocumented, while the `get workers` section already referred to "the same flags as `top workers`" — a dangling reference. Plus a typo in hack/update/proto-fmt.sh.
botengyao
marked this pull request as ready for review
August 8, 2026 20:23
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.
Follow-up to #561, doc-only — happy to open an issue if preferred.
#561 fixed the
kubectl ate logsexamples that omitted the required-a/--atespace. Two more documented commands have the same problem:cmd/kubectl-ate/README.md, the--traceexample:kubectl ate get actor my-counter-1 --tracedemos/parking/README.md:kubectl ate get actorsBoth fail with
--atespace is required when getting actors/specify --atespace <name> to list one atespace, or -A/--all-atespaces for all.While in the CLI README, three gaps that a first-time reader hits:
get actorSTATUS column lists 4 states; the API defines 8. AddedSTATUS_PAUSING,STATUS_PAUSED,STATUS_CRASHED,STATUS_DELETING(all reachable — the control plane sets each of them today).pause actorwas undocumented. Added it alongsidesuspend, with a note on the distinction that matters in practice:suspenduploads the snapshot so the actor can resume anywhere,pausekeeps it on the node VM and biases the next resume back to that node.topwas undocumented, even though theget workerssection already pointed at "the same flags astop workers". Added a section with the flags and the output columns, plus a note that it needs metrics-server.Plus a typo in
hack/update/proto-fmt.sh("wince" → "since").