diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 436021f84..88de07144 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -45,13 +45,13 @@ make --version make create-kind-cluster ``` -1. Configure the cluster and set the default namespace `kagent`: +2. Configure the cluster and set the default namespace `kagent`: ```shell make use-kind-cluster ``` -1. Set your model provider: +3. Set your model provider: ```shell export KAGENT_DEFAULT_MODEL_PROVIDER=openAI @@ -59,7 +59,7 @@ export KAGENT_DEFAULT_MODEL_PROVIDER=openAI export KAGENT_DEFAULT_MODEL_PROVIDER=anthropic ``` -1. Set your providers API_KEY: +4. Set your providers API_KEY: ```shell export OPENAI_API_KEY=your-openai-api-key @@ -81,7 +81,7 @@ OPENAI_API_KEY=your-openai-api-key # GOOGLE_API_KEY=your-google-api-key ``` -1. Build images, load them into kind cluster and deploy everything using Helm: +5. Build images, load them into kind cluster and deploy everything using Helm: ```shell make helm-install @@ -99,10 +99,10 @@ KAGENT_HELM_EXTRA_ARGS=-f helm/kagent/values.local.yaml To access the UI, port-forward to the UI port on the `kagent-ui` service: ```shell -kubectl port-forward svc/kagent-ui 8001:8080 +kubectl port-forward svc/kagent-ui 3000:8080 ``` -Then open your browser and go to `http://localhost:8001`. +Then open your browser and go to `http://localhost:3000`. ### Addons diff --git a/docs/substrate-agentharness-lifecycle.md b/docs/substrate-agentharness-lifecycle.md index 6e58cbc40..2706fe657 100644 --- a/docs/substrate-agentharness-lifecycle.md +++ b/docs/substrate-agentharness-lifecycle.md @@ -45,8 +45,7 @@ The substrate reconcile path should: 2. Verify the `WorkerPool` exists. 3. Create or update the generated `ActorTemplate` with an owner reference to the `AgentHarness`. 4. Wait for `ActorTemplate.status.phase == Ready`. -5. Create or resume the actor through `ate-api`. -6. Mark `ActorReady` and aggregate `Ready`. +5. Mark `ActorTemplateReady` and aggregate `Ready`. Actors are created on demand by the HTTP gateway on the first chat connection. ## Delete diff --git a/examples/substrate-openclaw/README.md b/examples/substrate-openclaw/README.md index b39c2afe5..e6fcf9c48 100644 --- a/examples/substrate-openclaw/README.md +++ b/examples/substrate-openclaw/README.md @@ -40,7 +40,7 @@ on the kagent chart), prefix these keys with `substrate.` — e.g. Then install the Substrate platform and kagent: ```bash -export SUBSTRATE_VERSION=0.0.7 +export SUBSTRATE_VERSION=0.0.8 helm upgrade --install substrate-crds \ oci://ghcr.io/kagent-dev/substrate/helm/substrate-crds \ @@ -83,7 +83,6 @@ metadata: name: peterj-claw namespace: kagent spec: - runtime: substrate backend: openclaw description: OpenClaw on Agent Substrate modelConfigRef: default-model-config @@ -145,12 +144,12 @@ With `controller.substrate.enabled=true`, the kagent Helm chart installs a names Port-forward the UI: ```bash -kubectl port-forward -n kagent svc/kagent-ui 8001:8080 +kubectl port-forward -n kagent svc/kagent-ui 3000:8080 ``` Navigate to the deployed agent harness. If the OpenClaw Control UI asks for a gateway connection, use: -- Gateway URL: `http://localhost:8001/api/agentharnesses/kagent/peterj-claw/gateway/` +- Gateway URL: `http://localhost:3000/api/agentharnesses/kagent/peterj-claw/gateway/` The gateway URL must include the trailing slash. The gateway runs without authentication; the actor's only externally reachable surface is reached through the controller's same-origin proxy over the actor's private atenet ingress. diff --git a/helm/README.md b/helm/README.md index 8870aa919..415f25f0a 100644 --- a/helm/README.md +++ b/helm/README.md @@ -18,7 +18,7 @@ helm install kagent ./helm/kagent/ --namespace kagent --set providers.openAI.api helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=ollama helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=openAI --set providers.openAI.apiKey=your-openai-api-key helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=anthropic --set providers.anthropic.apiKey=your-anthropic-api-key -helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=azureOpenAI --set providers.azureOpenAI.apiKey=your-openai-api-key +helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=azureOpenAI --set providers.azureOpenAI.apiKey=your-azure-openai-api-key ``` ### Using Make diff --git a/python/README.md b/python/README.md index 218f96bb1..9b0cfd221 100644 --- a/python/README.md +++ b/python/README.md @@ -2,7 +2,7 @@ ## Prerequisites - [uv package manager](https://docs.astral.sh/uv/getting-started/installation/) -- OpenAI API key +- An LLM provider API key (OpenAI, Anthropic, Gemini, etc.) ## Python diff --git a/ui/README.md b/ui/README.md index cfc5fb204..6d94b0c1d 100644 --- a/ui/README.md +++ b/ui/README.md @@ -1,4 +1,4 @@ -# kagents ui +# kagent ui ```bash