diff --git a/README.md b/README.md index 1433d32..273ab01 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ goals in the near term. To quickly set up the complete environment: -1. Make sure you have [Go](https://go.dev/doc/install), [`kubectl`](https://kubernetes.io/docs/tasks/tools/), and [`docker`](https://www.docker.com/) installed and configured on your dev machine. We will automatically manage other dependencies via Go, including [`kind`](https://kind.sigs.k8s.io/). +1. Make sure you have [Go](https://go.dev/doc/install), [`kubectl`](https://kubernetes.io/docs/tasks/tools/), and [`docker`](https://www.docker.com/) installed and configured on your dev machine. We will automatically manage other dependencies via Go, including [`kind`](https://kind.sigs.k8s.io/). On Docker Desktop, allocate at least **12 GiB of memory** to the Docker VM (Settings → Resources → Memory) — the full bring-up otherwise OOMs. 2. Run the following steps: ```shell diff --git a/demos/counter/README.md b/demos/counter/README.md index f6cc308..6485079 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