diff --git a/LICENSE b/LICENSE index 30c3423..d645695 100644 --- a/LICENSE +++ b/LICENSE @@ -1,8 +1,4 @@ -<<<<<<< HEAD -||||||| (empty tree) -======= ->>>>>>> e2a9125 (Initial commit of Agent Substrate) Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ diff --git a/README.md b/README.md index dd3218c..ddec488 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,10 @@ Agent Substrate is designed to be **framework and agent harness agnostic**. Beca * **Claude Code & CodeX:** Support for high-density, stateful coding environments that preserve terminal and filesystem state across sessions. * **Model Context Protocol (MCP):** Deploy secure, sandboxed MCP servers as Substrate Actors to provide durable tools for any LLM. +## Ecosystem & Examples + +* **[Agent Executor](https://github.com/google/ax):** A distributed agent runtime that demonstrates building a secure, hyper-scalable agent harness on Agent Substrate (see the [announcement blog](https://cloud.google.com/blog/products/ai-machine-learning/agent-executor-googles-distributed-agent-runtime) and [integration guide](https://github.com/google/ax/blob/main/manifests/README.md)). + ## Status and compatibility Agent Substrate is currently in VERY early development. It is not ready for @@ -62,6 +66,10 @@ production use, and the APIs are almost guaranteed to change. We are not making any guarantees about backward compatibility at this stage, and everything in this project may be changed. +### Supported Kubernetes Releases + +Currently we aim to support the [latest stable release](https://kubernetes.io/releases/) of Kubernetes, and the previous minor release. + ## Community For announcements, technical discussions, and community support, please join diff --git a/cmd/kubectl-ate/README.md b/cmd/kubectl-ate/README.md index 5d54d4b..025e671 100644 --- a/cmd/kubectl-ate/README.md +++ b/cmd/kubectl-ate/README.md @@ -45,6 +45,17 @@ gcloud beta container clusters update CLUSTER_NAME \ --location=LOCATION ``` +**Local (kind):** + +The kind overlay installed by `hack/install-ate-kind.sh --deploy-ate-system` already provisions an in-cluster OpenTelemetry Collector and a Jaeger all-in-one in the `otel-system` namespace. No additional setup is required. + +Port-forward the Jaeger UI and invoke any command with `--trace`: +```bash +kubectl port-forward -n otel-system svc/jaeger 16686:16686 & +kubectl ate get actor my-counter-1 --trace +# open http://localhost:16686 and search for the most recent trace +``` + ## Global Flags These flags can be appended to any command: @@ -73,6 +84,30 @@ kubectl ate get actor -o yaml kubectl ate get workers ``` +> **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. + +#### `kubectl ate get actor` output columns + +| Column | Meaning | +|---|---| +| `NAMESPACE` | The namespace of the `ActorTemplate` the actor was created from. | +| `TEMPLATE` | The `ActorTemplate` name. | +| `ID` | Actor ID. User-provided for application actors; UUID for the golden actor that each template materialises during `ResumeGoldenActor`. | +| `STATUS` | One of `STATUS_RESUMING`, `STATUS_RUNNING`, `STATUS_SUSPENDING`, `STATUS_SUSPENDED`. | +| `ATEOM POD` | The worker pod (namespace/name) currently hosting the actor. Empty while suspended. | +| `ATEOM IP` | The pod IP of that worker. Empty while suspended. | +| `VERSION` | Monotonic integer that increments on every state transition (resume / suspend / checkpoint). Useful for distinguishing snapshots. | + +#### `kubectl ate get worker` output columns + +| Column | Meaning | +|---|---| +| `NAMESPACE` | The `WorkerPool` namespace. | +| `POOL` | The `WorkerPool` name. | +| `POD` | The worker pod name. | +| `STATUS` | `FREE` (idle, ready to receive an actor) or `ASSIGNED` (currently hosting an actor). | +| `ASSIGNED ACTOR` | If `STATUS=ASSIGNED`, the actor reference `/