📚 FireMUD Infrastructure Documentation
This directory contains core documentation for the shared infrastructure that powers the FireMUD platform. These documents provide architecture, deployment, and integration guidance across all services.
🔀 Core Infrastructure Docs
| Document | Description |
|---|---|
| System Architecture Overview | High-level design with observability and service interactions. |
| System Architecture Diagram | Visual representation of component relationships and client flows. |
| System Context Diagram | Shows clients, DMZ components, internal services, and datastores. |
| Deployment Environments | Describes how Docker Compose and Kubernetes are used in dev/prod setups. |
| Gateway Architecture | Details on Spring Cloud Gateway routing, WebSocket support, and service access. |
| Protocol Bridging | Explains how FireMUD supports both WebSocket and Telnet clients through a unified backend. |
| gRPC API Style & Versioning Guidelines | Conventions for service APIs. |
| Redis Architecture | Describes where Redis is deployed and how session state is stored. |
| Security Architecture | TLS termination, mTLS usage, and network policy overview. |
| CI/CD Pipeline | Overview of GitHub Actions workflows for building, testing, and deployment. |
| Backup & Disaster Recovery | Snapshot schedules and restore workflow. |
🌐 Network Boundary and Certificates
The Spring Cloud Gateway and TCP Proxy Service sit in a DMZ behind the external load balancer. TLS and mTLS certificates for all services are issued by cert-manager and stored as Kubernetes Secrets.
🏢 Multi-Tenant Deployment
All games share the same Kubernetes cluster and infrastructure. Databases use per-service schemas keyed by tenantId; no tenant-specific clusters exist. See Multi-Tenancy for more.
📜 Logging Stack
The log aggregation pipeline is summarized in Logging & Monitoring.
🧭 Usage
All service-level design documents should refer to this directory for shared infrastructure context, rather than duplicating gateway, deployment, or protocol behavior.
For example:
See Gateway Architecture, Deployment Environments, or Protocol Bridging for relevant infrastructure details. Redis-backed session state is described in detail in Redis Architecture. Observability integrations are summarized in Logging & Monitoring. Client reconnection flow is covered in the Reconnection Strategy. TLS, certificate rotation, and network policies are detailed in the Security Architecture. Example manifests live in
k8s/network-policies/and provide a default ingress policy for internal services. Backup procedures and disaster recovery steps are outlined in Backup & Disaster Recovery. Service developers should follow the gRPC API Style & Versioning Guidelines when defining new APIs. Distributed workflows are explained in Transaction Strategies.