Add Docker Compose Reference Architecture page - #56
Open
fungc-io wants to merge 5 commits into
Open
Conversation
Adapt the Compose-on-VMs deployment reference into a public architecture guide alongside the Kubernetes on-premises page. Covers the four setups (A-D), expected capacity, datastore requirements, and per-setup inventories. Drop the mermaid align directives, which GitBook's mermaid 11.14.0 rejects, and cross-link from the on-premises page.
Replace the A-D setup matrix with Option 1 (your own datastores) and Option 2 (included datastores), each with a Non-Production and a Production setup. Add a Choosing a Setup section with a 2x2 VM-count table. Diagrams and inventories are unchanged.
Split the setup axes into datastore option and availability tier so environment names no longer stand in for HA mode. Factor the items shared by every setup into one Common Inventory table and move shared requirements after the diagrams. Make headings unique, use one name per VM role, and drop repeated sentences.
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
Adds Deployment › Architecture Guides › Docker Compose Reference Architecture, a reference for running Authgear on conventional VMs with Docker Compose or Podman Compose, for deployments where Kubernetes is unavailable or not worth operating.
The page covers:
Also adds a cross-link from On-Premises Reference Architecture to the new page, and a SUMMARY entry after it.
Diagrams
The diagrams are mermaid
architecture-betablocks. They avoid thealigndirective (mermaid 11.16+) because the docs site currently ships mermaid 11.14.0, where it produces a syntax error. All four were rendered with mermaid-cli pinned to 11.14.0 to confirm they parse and lay out sensibly.Files
deployment/architecture-guides/docker-compose-reference-architecture.md(new)deployment/architecture-guides/on-premises-reference-architecture.md(cross-link)SUMMARY.md