Files
Sankofa/docs/README.md

95 lines
4.6 KiB
Markdown
Raw Normal View History

# Sankofa Phoenix Documentation
Complete documentation for the Sankofa Phoenix sovereign cloud platform.
## Quick Links
- **[Main README](../../README.md)** - Project overview and getting started
- **[Project Status](../../PROJECT_STATUS.md)** - Current project status
- **[Configuration Guide](../../CONFIGURATION_GUIDE.md)** - Setup and configuration
- **[Environment Variables](../../ENV_EXAMPLES.md)** - Environment variable examples
## Documentation Structure
### Architecture
- **[System Architecture](./system_architecture.md)** - Overall system architecture
- **[Ecosystem Architecture](./ecosystem-architecture.md)** - Ecosystem structure
- **[Datacenter Architecture](./datacenter_architecture.md)** - Datacenter specifications
- **[Blockchain Architecture](./blockchain_eea_architecture.md)** - Blockchain integration
- **[Data Model](./architecture/data-model.md)** - GraphQL schema and data model
- **[Tech Stack](./architecture/tech-stack.md)** - Technology stack details
### Infrastructure
- **[Infrastructure README](../infrastructure/README.md)** - Infrastructure management overview
- **[Proxmox Task List](./proxmox/TASK_LIST.md)** - Proxmox deployment tasks
- **[Domain Migration](./infrastructure/DOMAIN_MIGRATION.md)** - Domain migration documentation
- **[DNS Configuration](./proxmox/DNS_CONFIGURATION.md)** - DNS setup guide
### Development
- **[Development Guide](./DEVELOPMENT.md)** - Development setup and workflow
- **[Testing Guide](./TESTING.md)** - Testing strategies and examples
- **[Deployment Guide](./DEPLOYMENT.md)** - Production deployment instructions
- **[Troubleshooting Guide](./TROUBLESHOOTING_GUIDE.md)** - Comprehensive troubleshooting guide
### Deployment & Status
- **[Deployment Requirements](./DEPLOYMENT_REQUIREMENTS.md)** - Complete deployment requirements
- **[Deployment Execution Plan](./DEPLOYMENT_EXECUTION_PLAN.md)** - Step-by-step execution guide
- **[Deployment Index](./DEPLOYMENT_INDEX.md)** - Navigation guide
- **[Next Steps Action Plan](./NEXT_STEPS_ACTION_PLAN.md)** - Comprehensive action plan
- **[Infrastructure Ready](./INFRASTRUCTURE_READY.md)** - Current infrastructure status
- **[Production Deployment Ready](./PRODUCTION_DEPLOYMENT_READY.md)** - Production readiness status
### Operations
- **[Runbooks](./runbooks/)** - Operational runbooks
- VM Provisioning
- Troubleshooting
- Disaster Recovery
### Brand & Positioning
- **[Brand Documentation](./brand/)** - Brand philosophy and positioning
- **[Ecosystem Mapping](./brand/ecosystem-mapping.md)** - Ecosystem structure
### Tenants (Multi-Tenancy)
- **[Tenant Management](./tenants/TENANT_MANAGEMENT.md)** - Comprehensive tenant management guide
- **[Billing Guide](./tenants/BILLING_GUIDE.md)** - Advanced billing features (superior to Azure)
- **[Identity Setup](./tenants/IDENTITY_SETUP.md)** - Keycloak and identity provider setup
- **[Azure Migration Guide](./tenants/AZURE_MIGRATION.md)** - Guide for migrating from Azure
## Key Features
### Sovereign Infrastructure
- **NO Azure/Microsoft dependencies** - All solutions are self-hosted
- **Superior to Azure** - More flexible, granular, and better UX than Azure
- **Sovereign-owned hardware** - Complete control over infrastructure
### Multi-Tenancy
- **Keycloak-based identity** - Sovereign alternative to Azure AD
- **Fine-grained permissions** - Beyond Azure RBAC
- **Custom domains per tenant** - Better than Azure
- **Cross-tenant resource sharing** - More flexible than Azure
### Billing (Superior to Azure Cost Management)
- **Per-second granularity** - vs Azure's hourly
- **Real-time cost tracking** - Better than Azure
- **ML-based forecasting** - Predictive cost analysis
- **Blockchain-backed billing** - Immutable audit trail
### Current Status
- **[VM Status Report](./VM_STATUS_REPORT_2025-12-09.md)** - Current VM status
- **[VM Cleanup Complete](./VM_CLEANUP_COMPLETE.md)** - VM cleanup status
- **[Bug Fixes](./BUG_FIXES_2025-12-09.md)** - Recent bug fixes
- **[Resource Quota Check](./RESOURCE_QUOTA_CHECK_COMPLETE.md)** - Resource availability
- **[Proxmox Credentials Status](./PROXMOX_CREDENTIALS_STATUS.md)** - Credentials status
### SMOM-DBIS-138
- **[SMOM-DBIS-138 Index](./smom-dbis-138-INDEX.md)** - Navigation guide
- **[SMOM-DBIS-138 Quick Start](./smom-dbis-138-QUICK_START.md)** - Quick start guide
- **[SMOM-DBIS-138 Complete Summary](./smom-dbis-138-COMPLETE_SUMMARY.md)** - Complete summary
- **[SMOM-DBIS-138 Next Steps](./smom-dbis-138-next-steps.md)** - Next steps guide
- **[SMOM-DBIS-138 Project Integration](./smom-dbis-138-project-integration.md)** - Integration guide
## Archive
Historical documentation is archived in [docs/archive/](./archive/) for reference.