chore(v1.2/P14): generic-host rename — Pi as one example, not the default#5
Merged
Merged
Conversation
Phase 14 of v1.2 (privacy / OSS hardening). The orchestrator now sells itself as a Linux-host deploy with Raspberry Pi positioned as one example target rather than the assumed default. Directory + file renames (git tracks as renames) - infra/pi-orchestrator/ -> infra/orchestrator/ - install/pi-install.sh -> install/install.sh - docs/deploy/pi.md -> docs/deploy/linux.md Script reframing - install/install.sh: banner becomes "VocalizeAI Linux Installer"; docstring lists Debian 12 / Ubuntu 22.04 / Raspberry Pi OS as tested targets; "Pi install complete" -> "Install complete". - infra/orchestrator/setup.sh, deploy.sh: rename `PI_HOST`/`PI_USER` args to `TARGET_HOST`/`TARGET_USER` (legacy PI_HOST / PI_USER still accepted as fallback env vars so existing operator muscle memory keeps working); rewrite banners + log lines + manual-steps copy to refer to "the remote host" instead of "the Pi"; both scripts pass `bash -n` and `shellcheck --severity=warning` clean. - infra/orchestrator/cloudflared-config.yml: header comments drop "on Pi" qualifier. Doc reframing (criterion #4 surfaces) - README.md, README.zh-CN.md: status line, file-tree comment, and cross-reference to deploy/linux.md all reframed to "Linux host (Raspberry Pi is one example target)". - CONTRIBUTING.md: reference to "live Pi orchestrator" becomes "Linux-host orchestrator". - docs/architecture.md: "Pi deployment assets" -> "Linux deployment assets"; Further Reading entry updated. - docs/deploy/local.md: env-table comments referring to "Pi" become generic ("orchestrator service port", "Linux-host orchestrator"). - docs/deploy/linux.md: full rewrite — intro, BOM, OS prep, Tailscale, Clone-and-Install, Environment Config, Cloudflare Tunnel, systemd, troubleshooting sections all reframed to "any modern Linux host with systemd"; the Pi-specific BOM + imaging + first-boot instructions are moved into a single "Hardware example: Raspberry Pi" subsection at the bottom. - infra/README.md: orchestrator entry reframed. - scripts/README.md: stability-driver description reframed. - CHANGELOG.md: v1.0.0 bullet reframed. - .github/ISSUE_TEMPLATE/bug_report.yml: OS examples include Debian 12; "Pi production" deployment mode becomes "Linux-host production"; journalctl hint refers to "a systemd-installed host" rather than Pi. Verification - `git grep -nIE "pi-orchestrator|pi-install|deploy/pi\.md" -- .` returns zero hits — all stale paths gone. - `shellcheck --severity=warning` clean on all three renamed shell scripts; `bash -n` clean too. - `pytest tests/test_app_startup_guards.py tests/test_pipeline.py` still pass (no production code touched; only path strings + docs). Phase: v1.2 / 14-generic-host-rename Requirements: SELF-LINUX-01..05
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.
Summary
Phase 14 of v1.2 (privacy / OSS hardening). The orchestrator now sells itself
as a Linux-host deploy with Raspberry Pi positioned as one example target,
not the assumed default.
Renames
infra/pi-orchestrator/infra/orchestrator/install/pi-install.shinstall/install.shdocs/deploy/pi.mddocs/deploy/linux.mdBehaviour changes
install/install.shis the canonical entry point and advertises itselfas the Linux installer (tested on Debian 12, Ubuntu 22.04, Raspberry Pi
OS Bookworm).
infra/orchestrator/setup.shanddeploy.shacceptTARGET_HOST/TARGET_USERas primary env vars; the legacyPI_HOST/PI_USERnames are still honoured as fallbacks so existing operator muscle
memory keeps working.
docs/deploy/linux.mdreads as a generic Linux runbook. TheRaspberry-Pi-specific BOM, OS imaging, and first-boot SSH steps are
collected into one "Hardware example: Raspberry Pi" subsection at the
bottom that the main text links to.
ROADMAP success criteria
infra/pi-orchestrator/is renamed toinfra/orchestrator/; all internal references (scripts, systemd units, docs) are updated; no broken paths exist.git grep -nIE "pi-orchestrator|pi-install|deploy/pi\.md"returns zero hitsinstall/install.shis the generic Linux entry point; Pi-specific steps are optional (flag or separate example script);install/pi-install.shis no longer the documented default.install/install.shis the only documented installer; banner reads "Linux Installer"; noraspi-config-style commandsdocs/deploy/pi.mdis renamed todocs/deploy/linux.md; Pi appears as a hardware sub-section; CONTRIBUTING and README cross-references are updated.docs/deploy/linux.mddocs/architecture.md,infra/README.md,SECURITY.md,scripts/README.md, CHANGELOG.md, and.github/ISSUE_TEMPLATE/bug_report.ymlall use "any Linux host" as the default; "Raspberry Pi" appears only as an example.install/install.shon a fresh Debian-12 or Ubuntu-22.04 target installs only generic Linux packages (noraspi-config-style commands); the script passesbash -nandshellcheckclean.bash -nandshellcheck --severity=warningclean; installer only invokesapt-get install python3.11 python3.11-venv python3-pip build-essential rsync(already generic — the priorpi-install.shnever used Pi-specific commands either)Test plan
git grep -nIE "pi-orchestrator|pi-install|deploy/pi\.md"— zero hits.shellcheck --severity=warningon the three renamed scripts — clean.bash -non the three renamed scripts — clean.pytest tests/test_app_startup_guards.py tests/test_pipeline.py— green.