From e70dafe055497572e39b01edc15548a7d91f7163 Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Fri, 3 Jul 2026 17:54:40 +0200 Subject: [PATCH 1/2] docs: fix typos, stale content, and port inconsistencies Signed-off-by: mesutoezdil --- DEVELOPMENT.md | 12 ++++++------ Makefile | 8 ++++---- docs/substrate-agentharness-lifecycle.md | 3 +-- examples/substrate-openclaw/README.md | 5 ++--- helm/README.md | 6 +++--- python/README.md | 2 +- ui/README.md | 2 +- 7 files changed, 18 insertions(+), 20 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 113a66fcfd..8b3ae00390 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/Makefile b/Makefile index 7155476347..509ad57e8a 100644 --- a/Makefile +++ b/Makefile @@ -177,9 +177,9 @@ check-api-key: ## Validate required API key for the configured model provider exit 1; \ fi; \ elif [ "$(KAGENT_DEFAULT_MODEL_PROVIDER)" = "azureOpenAI" ]; then \ - if [ -z "$(AZUREOPENAI_API_KEY)" ]; then \ - echo "Error: AZUREOPENAI_API_KEY environment variable is not set for Azure OpenAI provider"; \ - echo "Please set it with: export AZUREOPENAI_API_KEY=your-api-key"; \ + if [ -z "$(AZURE_OPENAI_API_KEY)" ]; then \ + echo "Error: AZURE_OPENAI_API_KEY environment variable is not set for Azure OpenAI provider"; \ + echo "Please set it with: export AZURE_OPENAI_API_KEY=your-api-key"; \ exit 1; \ fi; \ elif [ "$(KAGENT_DEFAULT_MODEL_PROVIDER)" = "gemini" ]; then \ @@ -497,7 +497,7 @@ helm-install-provider: helm-version check-api-key --set ui.image.pullPolicy=Always \ --set controller.service.type=LoadBalancer \ --set providers.openAI.apiKey=$(OPENAI_API_KEY) \ - --set providers.azureOpenAI.apiKey=$(AZUREOPENAI_API_KEY) \ + --set providers.azureOpenAI.apiKey=$(AZURE_OPENAI_API_KEY) \ --set providers.anthropic.apiKey=$(ANTHROPIC_API_KEY) \ --set providers.gemini.apiKey=$(GOOGLE_API_KEY) \ --set providers.default=$(KAGENT_DEFAULT_MODEL_PROVIDER) \ diff --git a/docs/substrate-agentharness-lifecycle.md b/docs/substrate-agentharness-lifecycle.md index 6e58cbc406..2706fe6573 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 b39c2afe57..c0c5ce3a7b 100644 --- a/examples/substrate-openclaw/README.md +++ b/examples/substrate-openclaw/README.md @@ -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 e0c9b62586..415f25f0ad 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 @@ -27,7 +27,7 @@ helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=az # export your openAI key export OPENAI_API_KEY=your-openai-api-key export ANTHROPIC_API_KEY=your-anthropic-api-key -export AZUREOPENAI_API_KEY=your-azure-api-key +export AZURE_OPENAI_API_KEY=your-azure-api-key # install the kagent charts with openAI provider make KAGENT_DEFAULT_MODEL_PROVIDER=openAI helm-install @@ -48,7 +48,7 @@ make KAGENT_DEFAULT_MODEL_PROVIDER=ollama helm-install ## make sure have env variable with your API_KEY export OPENAI_API_KEY=your-openai-api-key export ANTHROPIC_API_KEY=your-anthropic-api-key -export AZURE_API_KEY=your-azure-api-key +export AZURE_OPENAI_API_KEY=your-azure-api-key #default provider is openAI but you can select from the list export KAGENT_DEFAULT_MODEL_PROVIDER=ollama diff --git a/python/README.md b/python/README.md index 218f96bb10..9b0cfd221c 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 cfc5fb2049..6d94b0c1d3 100644 --- a/ui/README.md +++ b/ui/README.md @@ -1,4 +1,4 @@ -# kagents ui +# kagent ui ```bash From aad86e22a7a097f3145a02a7b4cfa9930aabb2cb Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Tue, 7 Jul 2026 20:28:18 +0200 Subject: [PATCH 2/2] docs: update substrate version to 0.0.8 Signed-off-by: mesutoezdil --- examples/substrate-openclaw/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/substrate-openclaw/README.md b/examples/substrate-openclaw/README.md index c0c5ce3a7b..e6fcf9c486 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 \