Repository navigation
docs(readme): describe GameMesh as it now runs, in production - #87
Merged
Merged
Conversation
The README predated deployment phase 1. It now opens with the live endpoint (https://api.gamemesh.app/health reports the deployed commit) and CI badges, and adds what the phase built: - Production: a diagram from players to pods and from a push to a deploy, and what runs at each layer (host, provider firewall, k3s, TLS, workloads, rebuild). - CI/CD: the jobs every pull request passes and what the deploy job does, including the rollback to the previous commit. - Security: least privilege for CI, OIDC instead of stored credentials, the pinned supply chain, secrets and the edge (DNSSEC, CAA, DMARC). - Measured figures: merge to live in 6 min 46 s, 3,494 of 3,494 requests served during a rollout, a broken release rolled back. The existing architecture, design decisions, messaging, presence, observability and load-test sections stay, tightened, with longer material folded into collapsible sections; outdated details (Go version, Grafana's default password) are corrected, and the docs list gains the runbook and the phase plan. All three mermaid diagrams render with mermaid-cli 11.4.2. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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
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 README predated deployment phase 1. It now opens with the live endpoint and CI badges, and adds:
ci-ok, and the deploy job with its automatic rollback.Existing architecture, design decisions, messaging, presence, observability and load-test sections are kept and tightened (long material in collapsible sections); outdated details corrected; docs list gains the runbook and the phase plan.
Checked
Claims checked against the code (topics, sweep interval,
APP_ENVdefault, compose port binding, make targets). All three mermaid diagrams render with mermaid-cli 11.4.2. No server addresses.🤖 Generated with Claude Code