README
¶
ate-setup
Installs and tears down Agent Substrate on a Kubernetes cluster.
go run ./cmd/ate-setup [global flags] <command> [flags]
make build-ate-setup # builds bin/ate-setup
ate-setup is a Go port of hack/install-ate.sh and the scripts it sources.
Both work today and can be used against the same cluster.
Installing a release
By default every image is built from the checkout with ko, which is what a
developer wants and what the shell installer always did. To install published
images instead, name the registry they were pushed to:
ate-setup deploy ate-system \
--image-repo registry.example.com/substrate \
--image-tag v0.0.0
Nothing is built and no registry is pushed to; the manifests still come from the checkout. Each reference is pinned to the digest its tag names, so the registry has to be readable from here as well as from the cluster.
commands.md— every command with itshack/install-ate.shequivalent.differences.md— where the port deliberately behaves differently, and what was reproduced exactly.
Documentation
¶
Overview ¶
Command ate-setup installs and tears down Agent Substrate on a Kubernetes cluster. It is a Go port of hack/install-ate.sh and the scripts it sources, which remain in place and still work; see cmd/ate-setup/commands.md for the flag-by-flag mapping between the two.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
cmd
Package cmd implements the ate-setup command tree.
|
Package cmd implements the ate-setup command tree. |
|
config
Package config resolves the environment ate-setup installs into.
|
Package config resolves the environment ate-setup installs into. |
|
demos
Package demos holds the contract every bundled demo implements, the registry the command tree is built from, and the shared behavior of a demo that is one manifest template.
|
Package demos holds the contract every bundled demo implements, the registry the command tree is built from, and the shared behavior of a demo that is one manifest template. |
|
demos/all
Package all links every bundled demo into the binary.
|
Package all links every bundled demo into the binary. |
|
demos/autoscaledworkerpool
Package autoscaledworkerpool installs the counter workload plus the custom-metrics stack that drives a HorizontalPodAutoscaler over its WorkerPool.
|
Package autoscaledworkerpool installs the counter workload plus the custom-metrics stack that drives a HorizontalPodAutoscaler over its WorkerPool. |
|
demos/claudemultiplex
Package claudemultiplex installs the claude-code-multiplex demo, which runs several Claude Code agents side by side on one WorkerPool.
|
Package claudemultiplex installs the claude-code-multiplex demo, which runs several Claude Code agents side by side on one WorkerPool. |
|
demos/counter
Package counter installs the counter demo: a counter actor exercising snapshot, resume, and atenet ingress, optionally with an external volume attached so the CSI path is covered end to end.
|
Package counter installs the counter demo: a counter actor exercising snapshot, resume, and atenet ingress, optionally with an external volume attached so the CSI path is covered end to end. |
|
demos/demotest
Package demotest provides the fixtures the demo packages share in their tests: an Env that needs no cluster, and the assertion that a rendered template is a complete manifest.
|
Package demotest provides the fixtures the demo packages share in their tests: an Env that needs no cluster, and the assertion that a rendered template is a complete manifest. |
|
demos/egress
Package egress installs the egress demo, which exercises egress policy enforcement through atenet.
|
Package egress installs the egress demo, which exercises egress policy enforcement through atenet. |
|
demos/multitemplate
Package multitemplate installs the multi-template demo, where two ActorTemplates in two different atespaces share a single WorkerPool.
|
Package multitemplate installs the multi-template demo, where two ActorTemplates in two different atespaces share a single WorkerPool. |
|
demos/parking
Package parking installs the parking demo, which parks and unparks actors on a small WorkerPool.
|
Package parking installs the parking demo, which parks and unparks actors on a small WorkerPool. |
|
demos/sandbox
Package sandbox installs the sandbox demo: an ActorTemplate driven on demand by the sandbox client rather than by a long-lived workload.
|
Package sandbox installs the sandbox demo: an ActorTemplate driven on demand by the sandbox client rather than by a long-lived workload. |
|
images
Package images decides where ate-setup gets container images from.
|
Package images decides where ate-setup gets container images from. |
|
ko
Package ko builds and publishes images referenced by manifests, replacing the run_ko helper in the shell installer.
|
Package ko builds and publishes images referenced by manifests, replacing the run_ko helper in the shell installer. |
|
kube
Package kube provides the cluster operations ate-setup needs, replacing the kubectl invocations the install shell scripts made.
|
Package kube provides the cluster operations ate-setup needs, replacing the kubectl invocations the install shell scripts made. |
|
kustomize
Package kustomize renders the overlays under manifests/ate-install, standing in for `kubectl kustomize <dir> --load-restrictor LoadRestrictionsNone`.
|
Package kustomize renders the overlays under manifests/ate-install, standing in for `kubectl kustomize <dir> --load-restrictor LoadRestrictionsNone`. |
|
log
Package log prints install progress, preserving the "[step]: name" output the shell scripts produced so existing CI log scrapers keep working.
|
Package log prints install progress, preserving the "[step]: name" output the shell scripts produced so existing CI log scrapers keep working. |
|
render
Package render expands the demos' *.yaml.tmpl files.
|
Package render expands the demos' *.yaml.tmpl files. |
|
steps
Package steps holds the install and teardown operations that the shell installer implemented as bash functions.
|
Package steps holds the install and teardown operations that the shell installer implemented as bash functions. |
Click to show internal directories.
Click to hide internal directories.