[mayawang]

Opened on behalf of @rich7420 while PR creation is limited to collaborators (#448). All commits are theirs.

Part of #487:

• adds a version-pinned AX installation guide
• clarifies the Substrate installation prerequisites and when the default deployment target applies
• documents the worker OverlayFS kernel requirement, and clarifies guest exec validation and routing in docs/runner.md

Docs only.

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[mayawang]

@rich7420 the CLA check is failing on your commits. Could you sign the Google CLA at https://cla.developers.google.com/ with the email on your commits? Then it'll go green and we can review.

[rich7420]

Thanks for the heads-up, @mayawang. I’ll check the CLA registration for my commit email and follow up.

[rich7420]

Thanks, @mayawang. The CLA check now passes.

[mayawang]

Thanks @rich7420, and thanks for signing the CLA. One change in direction: we want the README to stay the low-bar path (ideally a single make deploy, and local mode from #504), so could you drop the README changes and link docs/installation.md from CONTRIBUTING.md instead? The installation guide and the docs/runner.md fixes are great as contributor and operator docs.

[rich7420]

Thanks, @mayawang. README changes removed; the guide is linked from CONTRIBUTING.md.

[mayawang]

Thanks @rich7420 for the README change. Heads-up: #508 removes ko from the build and adds make images, so once it lands, could you update the guide to use it instead of ko and KO_DOCKER_REPO? Then we'll get a review.

[rakyll]

Some comments.

[rakyll]

Given this reads more like a script already, shall we turn it into a target like make deploy?

[rich7420]

Could I take a follow-up for configurable make deploy (snapshot storage, digest-pinned images, and a smoke check), coordinated with #508?

[rakyll]

Is it possible to say you need an Agent Substrate with X, Y, Z, in one sentence.

[rich7420]

Condensed the Substrate prerequisites into one sentence, with the setup details linked below.

[mayawang]

Update @rich7420: #508 is on hold, so the current ko-based guide is right for now, no need to wait. @rakyll could you review this one? I opened it on rich7420's behalf so I can't approve it.