Docs: refresh README + API reference + ansible README#331
Open
ptrlrd wants to merge 2 commits into
Open
Conversation
- infrastructure/ansible/README.md: full rewrite reflecting the
DigitalOcean migration (CF LB retired; single DO box for app
containers; Lightsail secondary now Mongo-only). Documents the
do-ansible wrapper, install-autodeploy.yml, the hourly autodeploy
cron, and the gotcha that Touch ID blocks unattended op:// reads
(which is why the cron sources creds from /etc/spire-codex/cf-purge.env
on the box instead of 1Password).
- contributing/API_REFERENCE.md: adds /api/images/beta/versions,
documents the ?version= query param on /api/images and
/api/images/{category}/download, adds /api/versions and /api/unlocks
which were already shipped but undocumented.
- README.md: Production section now describes the autodeploy cron flow
(rather than implying CI SSH-deploys). CI/CD section reflects that
CI only builds + pushes (Umami website-id injected per-tag from
repo secrets). Beta-site section points at tools/beta-watch/ for
the launchd-driven automated ingest, and the manual ingest snippet
is updated to use the new VERSION env var on sync-images.sh.
Earlier rewrite still framed the layout as 'DO box + Lightsail Mongo secondary' — the Lightsail boxes are actually gone. Mongo is co-located on the DO droplet. Updated the Hosts section, removed the audit-lightsail.yml playbook listing (kept only in the file tree as a historical-recovery utility), reframed mongo-install/backup as co-located, and dropped the dual-wrapper framing — bin/op-ansible is now just legacy. bin/do-ansible is the only wrapper anyone should run.
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.
Documentation sweep after the DigitalOcean migration, autodeploy cron, beta-watch, per-version beta images, and Umami beta tracking landed without docs catching up.
Changes
infrastructure/ansible/README.md— full rewrite. Documents the post-Overwolf layout (single DO app box, Lightsail secondary now Mongo-only, CF LB retired), the two SSH wrappers (do-ansiblefor DO,op-ansiblefor the legacy Lightsail box), the hourly autodeploy cron +install-autodeploy.ymlworkflow, and the Touch ID gotcha that drove the autodeploy to read from a local/etc/spire-codex/cf-purge.envinstead of 1Password.contributing/API_REFERENCE.md— adds/api/images/beta/versions, the?version=query param on/api/imagesand the download endpoint, plus/api/versionsand/api/unlockswhich were shipped but undocumented.README.md— Production deployment section now describes the autodeploy cron flow (rather than the old "CI SSH-deploys" model). CI/CD note clarifies that CI only builds + pushes images, with Umami website-id injected per-tag. Beta-site section points attools/beta-watch/for the launchd-driven automated ingest.