You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cmd/kubectl-ate/README.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,29 +83,29 @@ kubectl ate get actors -a <atespace>
83
83
# List actors across all atespaces
84
84
kubectl ate get actors -A
85
85
86
-
# Get a specific actor by ID and output as raw YAML
87
-
kubectl ate get actor <actor-id> --atespace <atespace> -o yaml
86
+
# Get a specific actor by name and output as raw YAML
87
+
kubectl ate get actor <actor-name> --atespace <atespace> -o yaml
88
88
89
89
# List all physical workers and see which actors are assigned to them
90
90
kubectl ate get workers
91
91
```
92
92
93
-
> **Note:**`get actors` requires either `--atespace <name>` / `-a <name>` (one atespace) or `-A`/`--all-atespaces` (all atespaces) — there is no default atespace. Getting a single actor always requires `--atespace`/`-a`, since an actor is addressed by `(atespace, id)`. `-a` (lower-case) scopes to one atespace; `-A` (upper-case) spans all.
93
+
> **Note:**`get actors` requires either `--atespace <name>` / `-a <name>` (one atespace) or `-A`/`--all-atespaces` (all atespaces) — there is no default atespace. Getting a single actor always requires `--atespace`/`-a`, since an actor is addressed by `(atespace, name)`. `-a` (lower-case) scopes to one atespace; `-A` (upper-case) spans all.
94
94
95
95
> **Note:** Actors and workers are not Kubernetes CRDs — they live in the Substrate control plane (valkey/redis), not `etcd`. `kubectl get actor` and `kubectl get worker` will not return anything; only `kubectl ate get …` queries the control plane. `kubectl get actortemplate` and `kubectl get workerpool`*do* work, because those are CRDs.
96
96
97
97
#### `kubectl ate get actor` output columns
98
98
99
99
| Column | Meaning |
100
100
|---|---|
101
-
|`ATESPACE`| The atespace the actor belongs to. Part of the actor's identity; folded into the storage key as `actor:<atespace>:<id>`. |
102
-
|`TEMPLATE NS`| The namespace of the `ActorTemplate` the actor was created from (distinct from `ATESPACE`). |
103
-
|`TEMPLATE`| The `ActorTemplate` name. |
104
-
|`ID`| Actor ID. User-provided for application actors; UUID for the golden actor that each template materialises during `ResumeGoldenActor`. |
101
+
|`ATESPACE`| The atespace the actor belongs to. Part of the actor's identity; folded into the storage key as `actor:<atespace>:<name>`. |
102
+
|`NAME`| The actor's name. User-provided for application actors; UUID for the golden actor that each template materialises during `ResumeGoldenActor`. |
103
+
|`TEMPLATE`| The `ActorTemplate` the actor was created from, as `<namespace>/<name>` (the template namespace is distinct from `ATESPACE`). |
105
104
|`STATUS`| One of `STATUS_RESUMING`, `STATUS_RUNNING`, `STATUS_SUSPENDING`, `STATUS_SUSPENDED`. |
106
105
|`ATEOM POD`| The worker pod (namespace/name) currently hosting the actor. Empty while suspended. |
107
106
|`ATEOM IP`| The pod IP of that worker. Empty while suspended. |
108
107
|`VERSION`| Monotonic integer that increments on every state transition (resume / suspend / checkpoint). Useful for distinguishing snapshots. |
108
+
|`AGE`| Time elapsed since the actor was created. |
109
109
110
110
#### `kubectl ate get worker` output columns
111
111
@@ -115,7 +115,7 @@ kubectl ate get workers
115
115
|`POOL`| The `WorkerPool` name. |
116
116
|`POD`| The worker pod name. |
117
117
|`STATUS`|`FREE` (idle, ready to receive an actor) or `ASSIGNED` (currently hosting an actor). |
118
-
|`ASSIGNED ACTOR`| If `STATUS=ASSIGNED`, the actor reference `<namespace>/<template>/<actor-id>`. |
118
+
|`ASSIGNED ACTOR`| If `STATUS=ASSIGNED`, the actor reference `<namespace>/<template>/<actor-name>`. |
119
119
120
120
### Atespaces
121
121
@@ -137,9 +137,16 @@ kubectl ate delete atespace <atespace>
137
137
138
138
> **Note:**`create actor … -a <atespace>` requires the atespace to already exist, otherwise it fails with `FailedPrecondition`. `delete atespace` only removes an **empty** atespace; delete its actors first (cascade delete is not yet supported).
139
139
140
+
#### `kubectl ate get atespace` output columns
141
+
142
+
| Column | Meaning |
143
+
|---|---|
144
+
|`NAME`| The atespace name. Globally unique — atespaces are global-scoped. |
145
+
|`AGE`| Time elapsed since the atespace was created. |
146
+
140
147
### Actor Lifecycle
141
148
Manage the execution state of your workloads.
142
-
*(Note: Actors are identified by a user-provided ID, which must be a valid DNS-1123 label)*
149
+
*(Note: Actors are identified by a user-provided name, which must be a valid DNS-1123 label)*
143
150
144
151
```bash
145
152
# Create a new actor deriving from a specific ActorTemplate.
@@ -159,7 +166,7 @@ kubectl ate delete actor my-actor -a <atespace>
159
166
160
167
### Logs
161
168
162
-
`kubectl ate logs` requires a resource-type subcommand; running `kubectl ate logs <id>` on its own prints help. The only supported resource type is `actors`:
169
+
`kubectl ate logs` requires a resource-type subcommand; running `kubectl ate logs <actor-name>` on its own prints help. The only supported resource type is `actors`:
163
170
164
171
```bash
165
172
# Stream logs for an actor (follows by default; aggregated across worker
0 commit comments