From 6f2fae0342685c3756321d7ce1456ca10dffbc59 Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Thu, 21 May 2026 10:47:07 +0300 Subject: [PATCH] docs: clarify kind prereqs and fix stale install-script references - README Quickstart now pins kind >= v0.31.0. Earlier releases ship a default Kubernetes node image without the PodCertificateRequest API the install scripts depend on, so kube-apiserver never reaches readiness on a fresh `brew install kind` machine. - README Quickstart also documents the 12 GiB Docker Desktop memory floor required for the full system bring-up. - internal/e2e/readme.md referenced a `hack/install.sh` that does not exist. Point readers at the two real entry points instead (hack/install-ate.sh for GKE, hack/install-ate-kind.sh for kind). - demos/counter/README.md claimed a GCS bucket was required, but the kind overlay provisions an in-cluster rustfs S3 store. Document both targets so the demo can run without provisioning GCP. Signed-off-by: Davanum Srinivas --- README.md | 5 ++++- demos/counter/README.md | 15 +++++++++++++-- internal/e2e/readme.md | 5 ++++- 3 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ddec488..1da7e92 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,10 @@ goals in the near term. To quickly set up the complete environment: -1. Make sure you have [`kind`](https://kind.sigs.k8s.io/), [`kubectl`](https://kubernetes.io/docs/tasks/tools/), and [`docker`](https://www.docker.com/) installed and configured on your dev machine. +1. Make sure the following tools are installed and configured on your development machine: + - [`kind`](https://kind.sigs.k8s.io/) **v0.31.0 or newer** (required for the `PodCertificateRequest` API the install scripts use; matches the CI-pinned `go install sigs.k8s.io/kind@v0.31.0`). + - [`kubectl`](https://kubernetes.io/docs/tasks/tools/). + - [`docker`](https://www.docker.com/) with **at least 12 GiB of memory** allocated to the VM (Docker Desktop: Settings → Resources → Memory). 2. Run the following steps: ```shell diff --git a/demos/counter/README.md b/demos/counter/README.md index 599a6e8..881086b 100644 --- a/demos/counter/README.md +++ b/demos/counter/README.md @@ -6,9 +6,20 @@ It deploys a simple Go HTTP server (`counter.go`) that increments a counter on e ## Prerequisites -- A k8s cluster with Agent Substrate installed (`./hack/install-ate.sh --deploy-ate-system`). +- A Kubernetes cluster with Agent Substrate installed. - `ko` installed for building images. -- A GCS bucket for storing snapshots (configured via `BUCKET_NAME` env var). +- A snapshot store appropriate to the cluster: + - On GKE, a GCS bucket whose name is supplied via the `BUCKET_NAME` environment variable. + - On a local `kind` cluster, the in-cluster `rustfs` S3-compatible store provisioned by the kind overlay. `BUCKET_NAME` defaults to `ate-snapshots` and does not need to be set. + +Two install scripts are available and accept the same flag set: + +| Target | Script | +|---|---| +| GKE | `./hack/install-ate.sh` | +| Local `kind` | `./hack/install-ate-kind.sh` | + +The remainder of this guide uses `./hack/install-ate.sh`. For a `kind` cluster, substitute `./hack/install-ate-kind.sh` in every command below. The end-to-end `kind` bring-up is described in the [Quickstart in the top-level README](../../README.md#quickstart-development). ## How to Run on Agent Substrate diff --git a/internal/e2e/readme.md b/internal/e2e/readme.md index 7bddd63..b72d402 100644 --- a/internal/e2e/readme.md +++ b/internal/e2e/readme.md @@ -18,7 +18,10 @@ $ go test -v ./internal/e2e/suites/... -args -e2e ## Preconditions -The e2e tests assume you have a cluster setup with `hack/install.sh`. +The e2e tests assume a cluster has been provisioned with one of the install scripts: + +- `hack/install-ate.sh --deploy-ate-system` for a GKE-based environment (requires `.ate-dev-env.sh`; see the top-level [README](../../README.md#gke-quickstart-development)). +- `hack/install-ate-kind.sh --deploy-ate-system` for a local `kind` cluster (see the top-level [README](../../README.md#quickstart-development)). ## Creating a new test suite