Repository navigation
Commit 30a0dea
authored
demos/counter: inline gVisor walkthrough and fix setup commands (agent-substrate#3498)
`demos/counter/README.md` hid every walkthrough command inside 16
collapsed `<details>` blocks (leaving `<details>` tags in the docsite's
raw Markdown outputs) and had outdated or incomplete instructions across
the default, external volume, and microVM flows:
- Inline the default `gvisor` walkthrough commands in the numbered
steps, note the default `gvisor-default` sandbox upfront, move actor
deletion after `## Reaching a non-default port`, and place the `microVM`
and external CSI volume variants in dedicated sections at the end.
- Document the `atenet-router` `--ingress-allowed-spiffe-ids`
prerequisite for `kubectl ate proxy actor`, keeping
`ATE_INSTALL_KIND=true` exported on `kind`, and point the Quickstart
link to `docs/get-started/quickstart.md`.
- Add the missing `ExternalVolumes` preview gate, `ate-setup setup csi`,
`delete demo counter` and `kubectl wait --for=delete
namespace/ate-demo-counter` before replacing the template, and `kubectl
ate --preview create actor` steps for external volumes, and explain
`--validate-existing-file-path=/external-data/test.txt`.
- Add the `create`, `proxy`, `suspend`, and `delete` steps for `microVM`
in `ate-demo-counter-microvm` (`my-counter-1`).
- Document all three counters incremented by `counter.go` (`preserved
memory count`, `preserved file counter`, and `preserved rootfs counter`)
with expected `curl` output across suspend and resume.
Fixes agent-substrate#3492
AI use: AI-assisted, I reviewed and verified the changes on `kind` and
Kubernetes clusters and built the docsite locally.
- [x] Tests pass: docs-only change (`./hack/site.sh build`,
`./hack/verify/boilerplate.sh`, and live walkthrough verification)
- [x] Docs updated
---------
Signed-off-by: Mofi Rahman <[email protected]>1 parent a2cc5e4 commit 30a0dea
1 file changed
Lines changed: 121 additions & 167 deletions
0 commit comments