Repository navigation
Document the Deploy stream as the VTA Farm and drop the "planned" placeholders - #38
Merged
Merged
Conversation
…ceholders The hardened Kubernetes deployment the sysop docs kept describing as planned now exists as three ic3software repos: vtafarm-k8s (OpenTofu stacks for the Hetzner clusters and platform layer), vtafarm-api (the Go API that provisions per-user stacks), and vtafarm (the React frontend). Rewrite sysop/deploy/README.md from a stub into an index page: what the farm is, which repo to read for what, the five OpenTofu layers, prerequisites, and where the runbooks live. It also maps each Explore walkthrough step to the Kubernetes Job the farm runs for it, since the farm's full-stack mode automates the same offline sealed-bundle bootstrap, and notes that a VTA Only session (a developer's Personal VTA) attaches to the farm's shared mediator and DID host instead. Update every page that pointed at the Deploy stream as "not yet documented" or "planned": the top-level and sysop READMEs, the explore pages, the community-manager README, and the developer Personal VTA guide. Add a VTA Farm row to the components table and update CLAUDE.md's layout table. Signed-off-by: Geoff Turk <geoff@ic3.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The hardened Kubernetes deployment the sysop docs kept describing as "planned" or "not yet documented" now exists as three repos: vtafarm-k8s, vtafarm-api, and vtafarm. This PR updates every reference so the docs are current.
Changes
sysop/deploy/README.mdis rewritten from a stub into an index page: what the VTA Farm is, which repo to read for what, the five OpenTofu layers vtafarm-k8s builds, prerequisites, and where the day-two runbooks live.setup --from <recipe>becomes a Job, every cross-directory file handoff becomes two PVCs mounted into one Job, and everynohupbecomes a Deployment (see full-stack-setup-design.md). It also notes that a VTA Only session, which is what a developer's Personal VTA is, attaches to the farm's shared mediator and DID host and skips the bundle exchange.sysop/README.md, the top-levelREADME.md, the three explore pages,community-manager/README.md, anddeveloper/01-personal-vta.mdno longer describe the Deploy stream as planned or undocumented.CLAUDE.mdlayout table is updated.Checks
markdownlint-cli2 "**/*.md"passes with 0 issues (run in Docker).