33d50fb91e
Some checks failed
API CI / API Lint (push) Successful in 47s
API CI / API Type Check (push) Failing after 47s
API CI / API Test (push) Successful in 1m0s
API CI / API Build (push) Failing after 50s
API CI / Build Docker Image (push) Has been skipped
Build Crossplane Provider / build (push) Failing after 5m51s
CD Pipeline / Deploy to Staging (push) Failing after 29s
CI Pipeline / Lint and Type Check (push) Failing after 36s
CI Pipeline / Build (push) Has been skipped
CI Pipeline / Test Backend (push) Failing after 1m33s
CI Pipeline / Test Frontend (push) Failing after 30s
CI Pipeline / Security Scan (push) Failing after 1m16s
Crossplane Provider CI / Go Test (push) Failing after 3m23s
Crossplane Provider CI / Go Lint (push) Failing after 7m27s
Crossplane Provider CI / Go Build (push) Failing after 3m27s
Deploy to Staging / Deploy to Staging (push) Failing after 30s
Portal CI / Portal Lint (push) Failing after 21s
Portal CI / Portal Type Check (push) Failing after 21s
Portal CI / Portal Test (push) Failing after 21s
Portal CI / Portal Build (push) Failing after 22s
Test Suite / frontend-tests (push) Failing after 30s
Test Suite / api-tests (push) Failing after 49s
Test Suite / blockchain-tests (push) Failing after 30s
Type Check / type-check (map[directory:. name:root]) (push) Failing after 23s
Type Check / type-check (map[directory:api name:api]) (push) Failing after 21s
Type Check / type-check (map[directory:portal name:portal]) (push) Failing after 19s
Validate Configuration Files / validate (push) Failing after 1m52s
CD Pipeline / Deploy to Production (push) Has been skipped
Co-authored-by: Cursor <cursoragent@cursor.com>
316 lines
10 KiB
Markdown
316 lines
10 KiB
Markdown
# Phoenix Operating Model Documentation
|
|
|
|
**Sankofa Phoenix Cloud Services — Enterprise-Grade Operating Model for Sovereign Governments**
|
|
|
|
This directory contains comprehensive documentation for the Phoenix operating model, designed for international and multi-national sovereign governments.
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
**Phoenix (Sankofa Cloud Services)** is a competing cloud services offering purpose-built to service **international and multi-national Sovereign Governments** and their contractors. Phoenix competes directly with Azure, AWS, and other cloud service providers while offering superior capabilities for sovereign deployments.
|
|
|
|
The operating model separates **commercial governance**, **technical tenancy**, and **content/devops control** into five orthogonal control planes while enabling clean interoperability across distributed, multi-region deployments.
|
|
|
|
---
|
|
|
|
## Core Documentation
|
|
|
|
### 1. [Operating Model](./OPERATING_MODEL.md)
|
|
|
|
**Comprehensive operating model documentation** covering all five control planes, entity models, key rules, and integration patterns.
|
|
|
|
**Sections:**
|
|
- Executive Summary
|
|
- Five Control Planes (Commercial, Tenancy, Subscription, Environment, Content & DevOps)
|
|
- Entity Models and Schemas
|
|
- Hierarchical Access Model (RBAC)
|
|
- Key Rules and Constraints
|
|
- Multi-Region and Multi-National Capabilities
|
|
- Decentralized Architecture
|
|
- Integration with Existing Infrastructure
|
|
- Use Cases for Sovereign Governments
|
|
- Glossary
|
|
|
|
**Use Cases:**
|
|
- Architecture decks
|
|
- Product specifications
|
|
- Implementation guides
|
|
- Technical reference
|
|
|
|
---
|
|
|
|
### 2. [Architecture Diagrams](./OPERATING_MODEL_DIAGRAMS.md)
|
|
|
|
**Visual representations** of the Phoenix operating model with 15 mermaid diagrams.
|
|
|
|
**Diagrams:**
|
|
- Control Plane Overview
|
|
- Entity Relationship Diagram
|
|
- Multi-Region Landing Zone Architecture
|
|
- Decentralized Control Planes
|
|
- Content Hierarchy
|
|
- Access Model (RBAC)
|
|
- Promotion Flow
|
|
- Integration Architecture
|
|
- Sovereign Environment Isolation
|
|
- Multi-National Tenant Structure
|
|
- Landing Zone Patterns
|
|
- Competitive Architecture Comparison
|
|
- Data Flow
|
|
- Sequence Diagrams
|
|
- Multi-Region Topology
|
|
|
|
**Use Cases:**
|
|
- Architecture presentations
|
|
- Technical documentation
|
|
- Client proposals
|
|
- Training materials
|
|
|
|
---
|
|
|
|
### 3. [Cloud Provider Mapping](./CLOUD_PROVIDER_MAPPING.md)
|
|
|
|
**Mapping Phoenix to Azure/AWS** with competitive analysis and migration considerations.
|
|
|
|
**Sections:**
|
|
- Mapping to Azure (entity mapping, architecture comparison)
|
|
- Mapping to AWS (entity mapping, architecture comparison)
|
|
- Hybrid Deployments (sovereign + public cloud)
|
|
- Multi-Region Landing Zones (comparison)
|
|
- Decentralized Architecture (vs centralized)
|
|
- Feature Comparison Matrix
|
|
- Migration Considerations (complexity, strategies, timelines)
|
|
|
|
**Use Cases:**
|
|
- Competitive analysis
|
|
- Migration planning
|
|
- Architecture comparison
|
|
- Sales and marketing
|
|
|
|
---
|
|
|
|
### 4. [MVP Control Plane](./MVP_CONTROL_PLANE.md)
|
|
|
|
**Minimum Viable Product specification** for Phoenix operating model implementation.
|
|
|
|
**Sections:**
|
|
- MVP Scope Definition
|
|
- MVP for Each Control Plane
|
|
- Multi-Region MVP Requirements
|
|
- Decentralized Architecture MVP
|
|
- Sovereign Government MVP Requirements
|
|
- Required APIs and Services
|
|
- Data Model Extensions
|
|
- Implementation Priorities
|
|
- Dependencies Between Features
|
|
- Risk Assessment
|
|
- Integration with Existing Infrastructure
|
|
- Success Criteria
|
|
|
|
**Use Cases:**
|
|
- Implementation planning
|
|
- Development roadmap
|
|
- MVP definition
|
|
- Technical specification
|
|
|
|
---
|
|
|
|
### 5. [Multi-Region Landing Zones](./MULTI_REGION_LANDING_ZONES.md)
|
|
|
|
**Comprehensive guide** for multi-region landing zones for sovereign governments.
|
|
|
|
**Sections:**
|
|
- Landing Zone Architecture
|
|
- Multi-Region Deployment Patterns
|
|
- Sovereign Cloud Per Region/Nation
|
|
- Cross-Region Connectivity
|
|
- Regional Data Residency
|
|
- Multi-National Coordination
|
|
- Federated Identity
|
|
- Network Connectivity
|
|
- Regional Compliance
|
|
- Use Cases
|
|
- Landing Zone Templates
|
|
- Deployment Automation
|
|
- Integration with Existing Infrastructure
|
|
- Best Practices
|
|
- Troubleshooting
|
|
|
|
**Use Cases:**
|
|
- Landing zone design
|
|
- Multi-region deployment
|
|
- Sovereign cloud deployment
|
|
- Implementation guide
|
|
|
|
---
|
|
|
|
### 6. [Migration Guide](./MIGRATION_GUIDE.md)
|
|
|
|
**Step-by-step migration guides** for moving to Phoenix operating model.
|
|
|
|
**Sections:**
|
|
- Migration from Existing Phoenix Model
|
|
- Migration from Azure
|
|
- Migration from AWS
|
|
- Migration Planning
|
|
- Risk Mitigation
|
|
- Post-Migration
|
|
|
|
**Use Cases:**
|
|
- Migration planning
|
|
- Migration execution
|
|
- Migration validation
|
|
- Migration support
|
|
|
|
---
|
|
|
|
### 7. [Product Specification](./PRODUCT_SPEC.md)
|
|
|
|
**Client-facing product specification** for sovereign governments.
|
|
|
|
**Sections:**
|
|
- Executive Summary
|
|
- Competitive Value Proposition
|
|
- Operating Model Overview
|
|
- Decentralized Architecture
|
|
- Multi-Region Landing Zones
|
|
- Sovereign Government Use Cases
|
|
- Compliance and Security Features
|
|
- Landing Zone Patterns
|
|
- Pricing and Packaging
|
|
- Migration Path
|
|
- Understanding All Capabilities
|
|
|
|
**Use Cases:**
|
|
- Client proposals
|
|
- Sales presentations
|
|
- Enterprise offerings
|
|
- Business development
|
|
|
|
---
|
|
|
|
## Supporting Documentation
|
|
|
|
### [Structural Config Locations](./STRUCTURAL_CONFIG_LOCATIONS.md)
|
|
|
|
Reference guide for Phoenix structural configuration locations, deployments, and topology.
|
|
|
|
### [Business Communications](./BUSINESS_COMMUNICATIONS.md)
|
|
|
|
Phoenix business communications infrastructure including AS4 gateway, workflow automation, and financial messaging.
|
|
|
|
### [Codespaces IDE Setup](./CODESPACES_IDE_SETUP.md)
|
|
|
|
Development environment setup for Phoenix using GitHub Codespaces.
|
|
|
|
## Enhancement Documentation
|
|
|
|
### [API Specification](./API_SPECIFICATION.md)
|
|
|
|
Complete API specification for all five control planes, including GraphQL schemas, REST endpoints, authentication, authorization, and integration patterns.
|
|
|
|
### [Implementation Examples](./IMPLEMENTATION_EXAMPLES.md)
|
|
|
|
Practical code examples and implementation patterns, including entity creation, Infrastructure as Code (Terraform, Pulumi), CI/CD pipelines, multi-region deployments, and integration examples.
|
|
|
|
### [Operational Runbooks](./OPERATIONAL_RUNBOOKS.md)
|
|
|
|
Operational procedures, troubleshooting guides, incident response procedures, maintenance procedures, monitoring and alerting, and backup and recovery.
|
|
|
|
### [Case Studies](./CASE_STUDIES.md)
|
|
|
|
Real-world deployment examples and success stories for sovereign governments, including multi-national defense contractors, international healthcare agencies, cross-border financial regulators, and air-gapped government systems.
|
|
|
|
### [FAQ](./FAQ.md)
|
|
|
|
Frequently asked questions covering general concepts, entity model, multi-region, identity and access, billing, content & DevOps, migration, compliance, technical questions, best practices, and troubleshooting.
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
### For Architects
|
|
|
|
1. Start with [Operating Model](./OPERATING_MODEL.md) for comprehensive understanding
|
|
2. Review [Architecture Diagrams](./OPERATING_MODEL_DIAGRAMS.md) for visual understanding
|
|
3. Review [Cloud Provider Mapping](./CLOUD_PROVIDER_MAPPING.md) for competitive context
|
|
|
|
### For Implementers
|
|
|
|
1. Start with [MVP Control Plane](./MVP_CONTROL_PLANE.md) for implementation scope
|
|
2. Review [Operating Model](./OPERATING_MODEL.md) for entity models and APIs
|
|
3. Review [Multi-Region Landing Zones](./MULTI_REGION_LANDING_ZONES.md) for deployment patterns
|
|
|
|
### For Business/Sales
|
|
|
|
1. Start with [Product Specification](./PRODUCT_SPEC.md) for client-facing content
|
|
2. Review [Cloud Provider Mapping](./CLOUD_PROVIDER_MAPPING.md) for competitive advantages
|
|
3. Review [Use Cases](./OPERATING_MODEL.md#xi-use-cases-for-sovereign-governments) for scenarios
|
|
|
|
### For Migrations
|
|
|
|
1. Start with [Migration Guide](./MIGRATION_GUIDE.md) for migration planning
|
|
2. Review [Cloud Provider Mapping](./CLOUD_PROVIDER_MAPPING.md) for entity mapping
|
|
3. Review [Operating Model](./OPERATING_MODEL.md) for target model understanding
|
|
|
|
---
|
|
|
|
## Key Concepts
|
|
|
|
### Five Control Planes
|
|
|
|
1. **Commercial Plane** — *Who pays* (Client/Billing Profile)
|
|
2. **Tenancy Plane** — *Who owns domains & identity* (Tenant)
|
|
3. **Subscription Plane** — *What is provisioned* (Subscription)
|
|
4. **Environment Plane** — *Where workloads run* (Environment)
|
|
5. **Content & DevOps Plane** — *What is built, governed, and deployed* (Enterprise → Portfolio → Product → Application → Component)
|
|
|
|
### Key Principles
|
|
|
|
- **Separation of Concerns**: Each plane operates independently
|
|
- **ID-Based References**: Planes reference each other through IDs
|
|
- **Enterprise Scale**: Support for large multi-tenant deployments
|
|
- **Sovereign First**: Built for sovereign governments
|
|
- **Multi-Region Native**: Designed for international/multi-national deployments
|
|
- **Decentralized Architecture**: Supports distributed sovereignty
|
|
|
|
---
|
|
|
|
## Related Documentation
|
|
|
|
### Architecture
|
|
|
|
- **[Architecture Index](../ARCHITECTURE_INDEX.md)** - Complete architecture documentation index
|
|
- **[Data Model](../architecture/data-model.md)** - GraphQL schema and data model
|
|
- **[Well-Architected Framework](../architecture/well-architected.md)** - Well-Architected Framework
|
|
|
|
### Tenant Management
|
|
|
|
- **[Tenant Management](../tenants/TENANT_MANAGEMENT.md)** - Multi-tenant operations guide
|
|
- **[Billing Guide](../tenants/BILLING_GUIDE.md)** - Billing and cost management
|
|
- **[Identity Setup](../tenants/IDENTITY_SETUP.md)** - Keycloak configuration
|
|
|
|
**Note**: The existing tenant/billing documentation uses a tenant-based model. See [Migration Guide](./MIGRATION_GUIDE.md) for migration to the new operating model with Client/Tenant/Subscription separation.
|
|
|
|
---
|
|
|
|
## Document Status
|
|
|
|
| Document | Status | Version | Last Updated |
|
|
|----------|--------|---------|-------------|
|
|
| Operating Model | ✅ Complete | 1.0 | 2025-01-09 |
|
|
| Architecture Diagrams | ✅ Complete | 1.0 | 2025-01-09 |
|
|
| Cloud Provider Mapping | ✅ Complete | 1.0 | 2025-01-09 |
|
|
| MVP Control Plane | ✅ Complete | 1.0 | 2025-01-09 |
|
|
| Multi-Region Landing Zones | ✅ Complete | 1.0 | 2025-01-09 |
|
|
| Migration Guide | ✅ Complete | 1.0 | 2025-01-09 |
|
|
| Product Specification | ✅ Complete | 1.0 | 2025-01-09 |
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-01-09
|
|
**Status**: Complete Documentation Suite
|
|
|
|
|