Skip to content

docs: clarify kind prereqs and fix stale install-script references#32

Open
Davanum Srinivas (dims) wants to merge 1 commit into
agent-substrate:mainfrom
dims:docs/kind-local-dev-prereqs
Open

docs: clarify kind prereqs and fix stale install-script references#32
Davanum Srinivas (dims) wants to merge 1 commit into
agent-substrate:mainfrom
dims:docs/kind-local-dev-prereqs

Conversation

@dims
Copy link
Copy Markdown
Contributor

  • 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.
  • 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.

Fixes #<issue_number_goes_here>

It's a good idea to open an issue first for discussion.

  • Tests pass
  • Appropriate changes to documentation are included in the PR

@dims Davanum Srinivas (dims) force-pushed the docs/kind-local-dev-prereqs branch from ceef546 to 97ff0d1 Compare May 21, 2026 07:50
- 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 <davanum@gmail.com>
@dims Davanum Srinivas (dims) force-pushed the docs/kind-local-dev-prereqs branch from 97ff0d1 to 6f2fae0 Compare May 21, 2026 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant