Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Davanum Srinivas (dims) wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −4
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Copy link
Copy Markdown
Collaborator

@BenTheElder Benjamin Elder (BenTheElder) May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not required or used anymore

Copy link
Copy Markdown
Collaborator Author

@dims Davanum Srinivas (dims) May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benjamin Elder (@BenTheElder) we still use (

substrate/.github/workflows/pr-workflow.yaml

Line 42 in 2f2292f

run: go install sigs.k8s.io/kind@v0.31.0
)

should we reflect that? (and drop the note about PodCertificateRequest API)

Copy link
Copy Markdown
Collaborator

@BenTheElder Benjamin Elder (BenTheElder) May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you DIY install we don't inherently depend on kind, but our dev scripts will depend on the version in the tools module in the future, I think we don't need to specify the version here. Thanks.

I also think we will stop depending on the default node image in the future, but I want to ship some upstream kind fixes first.

- [`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).
Copy link
Copy Markdown
Collaborator

@BenTheElder Benjamin Elder (BenTheElder) May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we using 12GiB?

must be the image cache ... we're going to need to think about tiers there

Copy link
Copy Markdown
Collaborator Author

@dims Davanum Srinivas (dims) May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

12 seemed to work :) i did not try going lower

Copy link
Copy Markdown
Collaborator

@BenTheElder Benjamin Elder (BenTheElder) May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm OK, I want to avoid overstating it if we can, this is also likely going to be very fluid as we iterate, most of it is probably various in-memory storage currently that doesn't strictly need to all be in memory in the future ...


2. Run the following steps:
```shell
Expand Down
15 changes: 13 additions & 2 deletions demos/counter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 4 additions & 1 deletion internal/e2e/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading