docs: which nodes codavox goes on, and the safe compiler cutover#21
Merged
Conversation
installation.md explained how to install the package but never which machines, omitting that codavox runs on the compilers at all. Added a 'Where to install it' table — same package on the primary and every compiler, with publish/deploy on the primary and the agent plus the code-id / code-content commands OpenVox Server invokes on each compiler. It also now answers the natural question of whether installing on compilers is risky: installing is inert (no config change, non-conflicting paths), and the care is in the wiring cutover, because codavox has no fallback. A compiler wired before its agent has converged fails every catalog compile. Added the safe order — install, converge the agent, then set versioned-code.conf and environmentpath, canary one compiler — and noted it is reversible. The README quickstart's compiler step said 'point OpenVox Server at codavox' but only showed the agent and code-id, and did not convey that order. Reworded to run the agent first, then wire, and to point at installation.md for the wiring and the canary. Signed-off-by: Michael Harp <mike@mikeharp.com>
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
1 participant
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.
Two related doc gaps around installing on compilers.
installation.md — which machines, and is it risky?
publish/deploy/deploy-serveron the primary,agent+code-id/code-contenton each compiler (where OpenVox Server invokes them per compile).versioned-code.conf+environmentpath→ canary one compiler) and that it's reversible.README quickstart — the compiler step said "point OpenVox Server at codavox" but only showed
agent+code-id, and didn't convey the order. Reworded to run the agent first, then wire, pointing at installation.md for the wiring and canary.Docs-only. markdownlint clean, anchors resolve, cspell clean.
🤖 Generated with Claude Code