docs: archive entra materials and simplify deployment docs
This commit is contained in:
+9
-22
@@ -35,13 +35,7 @@ the-order/
|
||||
│ ├── cache/ # Caching utilities
|
||||
│ └── [20+ more packages]
|
||||
│
|
||||
├── infra/ # Infrastructure as Code
|
||||
│ ├── terraform/ # Terraform configurations
|
||||
│ │ ├── management-groups/ # Management group hierarchy
|
||||
│ │ ├── policies/ # Azure policies
|
||||
│ │ ├── modules/ # Reusable modules
|
||||
│ │ │ └── regional-landing-zone/
|
||||
│ │ └── multi-region/ # Multi-region deployment
|
||||
├── infra/ # Infrastructure definitions
|
||||
│ ├── k8s/ # Kubernetes manifests
|
||||
│ │ ├── base/ # Base configurations
|
||||
│ │ └── overlays/ # Environment overlays
|
||||
@@ -51,10 +45,10 @@ the-order/
|
||||
├── docs/ # Documentation
|
||||
│ ├── architecture/ # Architecture documentation
|
||||
│ ├── deployment/ # Deployment guides
|
||||
│ │ └── azure/ # Azure-specific guides
|
||||
│ │ └── archive/ # Historical or quarantined docs
|
||||
│ ├── governance/ # Governance & policies
|
||||
│ ├── integrations/ # Integration guides
|
||||
│ │ └── entra-verifiedid/ # Entra VerifiedID
|
||||
│ │ └── archive/ # Historical integrations
|
||||
│ ├── legal/ # Legal documentation
|
||||
│ │ └── document-management/ # Document management
|
||||
│ └── reports/ # Project reports
|
||||
@@ -85,7 +79,7 @@ Frontend applications built with React/Next.js:
|
||||
|
||||
Backend microservices (Node.js/TypeScript/Fastify):
|
||||
|
||||
- **identity**: eIDAS/DID, verifiable credentials, Entra VerifiedID
|
||||
- **identity**: eIDAS/DID, verifiable credentials, identity management
|
||||
- **intake**: Document ingestion, OCR, classification
|
||||
- **finance**: Payments, ledgers, invoicing
|
||||
- **dataroom**: Virtual data rooms, deal management
|
||||
@@ -100,20 +94,15 @@ Shared libraries used across services and apps:
|
||||
- **database**: Database layer, migrations, queries
|
||||
- **schemas**: Zod schemas for validation
|
||||
- **auth**: Authentication and authorization
|
||||
- **storage**: Storage abstraction (S3/GCS/Azure)
|
||||
- **storage**: Storage abstraction (S3/GCS)
|
||||
- **crypto**: Cryptography, KMS integration
|
||||
- **monitoring**: Prometheus metrics, OpenTelemetry
|
||||
- **cache**: Redis caching utilities
|
||||
|
||||
### Infrastructure (`infra/`)
|
||||
|
||||
Infrastructure as Code:
|
||||
Infrastructure:
|
||||
|
||||
- **terraform/**: Azure infrastructure
|
||||
- Management groups
|
||||
- Policies
|
||||
- Regional landing zones
|
||||
- Multi-region deployment
|
||||
- **k8s/**: Kubernetes manifests
|
||||
- Base configurations
|
||||
- Environment overlays (dev/stage/prod)
|
||||
@@ -143,9 +132,9 @@ Comprehensive documentation:
|
||||
### For Infrastructure Engineers
|
||||
|
||||
1. `infra/README.md` - Infrastructure overview
|
||||
2. `infra/terraform/README.md` - Terraform guide
|
||||
2. `infra/k8s/README.md` - Kubernetes guide
|
||||
3. `infra/k8s/README.md` - Kubernetes guide
|
||||
4. `docs/deployment/azure/` - Azure deployment guides
|
||||
4. `docs/deployment/DEPLOYMENT_QUICK_REFERENCE.md` - Sankofa Phoenix deployment guide
|
||||
|
||||
### For Backend Developers
|
||||
|
||||
@@ -287,8 +276,7 @@ ls infra/scripts/
|
||||
|
||||
4. **Deployment**
|
||||
```bash
|
||||
source infra/scripts/azure-load-env.sh
|
||||
./infra/scripts/azure-deploy.sh
|
||||
./scripts/deploy/deploy.sh --all --environment dev --dry-run
|
||||
```
|
||||
|
||||
## Important Files
|
||||
@@ -310,4 +298,3 @@ ls infra/scripts/
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# The Order
|
||||
|
||||
**A comprehensive platform for digital identity, verifiable credentials, and legal document management**
|
||||
**A Phoenix-native platform for digital identity, verifiable credentials, and legal document management**
|
||||
|
||||
[](LICENSE)
|
||||
[](https://www.typescriptlang.org/)
|
||||
@@ -8,15 +8,15 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The Order is a sovereign cloud platform providing:
|
||||
The Order is a sovereign platform providing:
|
||||
- **Digital Identity Management**: eIDAS/DID-based identity verification
|
||||
- **Verifiable Credentials**: Microsoft Entra VerifiedID integration
|
||||
- **Verifiable Credentials**: DID and issuer-domain based credential services
|
||||
- **Legal Document Management**: Comprehensive DMS for law firms and courts
|
||||
- **Virtual Data Rooms**: Secure deal management
|
||||
- **Financial Services**: Payment processing and invoicing
|
||||
- **e-Residency**: Digital residency services
|
||||
|
||||
Built with **Cloud for Sovereignty** principles, ensuring data residency, compliance, and operational control.
|
||||
Built for **Sankofa Phoenix / Proxmox** operations, with data residency, compliance, and operational control anchored in the Sankofa runtime.
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -25,8 +25,7 @@ Built with **Cloud for Sovereignty** principles, ensuring data residency, compli
|
||||
- Node.js >= 18.0.0
|
||||
- pnpm >= 8.0.0
|
||||
- Docker & Docker Compose
|
||||
- Azure CLI (for deployments)
|
||||
- Terraform >= 1.5.0 (for infrastructure)
|
||||
- Proxmox / Sankofa Phoenix operator access for deployment tasks
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -51,15 +50,10 @@ pnpm dev
|
||||
### Environment Setup
|
||||
|
||||
1. Copy `.env.example` to `.env`
|
||||
2. Configure Azure credentials:
|
||||
```bash
|
||||
ARM_SUBSCRIPTION_ID="your-subscription-id"
|
||||
ARM_TENANT_ID="your-tenant-id"
|
||||
ARM_LOCATION="westeurope"
|
||||
```
|
||||
2. Configure the local environment variables needed for your workload.
|
||||
3. Load environment:
|
||||
```bash
|
||||
source infra/scripts/azure-load-env.sh
|
||||
source .env
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
@@ -80,7 +74,7 @@ the-order/
|
||||
|
||||
### Services
|
||||
|
||||
- **Identity Service** (`services/identity/`): eIDAS/DID, verifiable credentials, Entra VerifiedID
|
||||
- **Identity Service** (`services/identity/`): eIDAS/DID, verifiable credentials, identity management
|
||||
- **Intake Service** (`services/intake/`): Document ingestion, OCR, classification
|
||||
- **Finance Service** (`services/finance/`): Payments, ledgers, invoicing
|
||||
- **Dataroom Service** (`services/dataroom/`): Virtual data rooms, deal management
|
||||
@@ -95,8 +89,7 @@ the-order/
|
||||
|
||||
### Infrastructure
|
||||
|
||||
- **Terraform** (`infra/terraform/`): Azure infrastructure, Cloud for Sovereignty landing zones
|
||||
- **Kubernetes** (`infra/k8s/`): Container orchestration
|
||||
- **Kubernetes** (`infra/k8s/`): Container orchestration manifests for containerized workloads
|
||||
- **Monitoring** (`infra/monitoring/`): Prometheus, Grafana
|
||||
|
||||
## Documentation
|
||||
@@ -107,8 +100,8 @@ the-order/
|
||||
- [Architecture Overview](docs/architecture/README.md) - System architecture
|
||||
|
||||
### Deployment
|
||||
- [Azure Deployment](docs/deployment/azure/ENVIRONMENT_SETUP.md) - Azure setup
|
||||
- [Sovereignty Landing Zone](docs/deployment/azure/SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md) - Multi-region deployment
|
||||
- [Deployment Overview](docs/deployment/overview.md) - Sankofa Phoenix deployment model
|
||||
- [Deployment Quick Reference](docs/deployment/DEPLOYMENT_QUICK_REFERENCE.md) - operator commands
|
||||
- [Kubernetes Deployment](infra/k8s/README.md) - K8s deployment guide
|
||||
|
||||
### Architecture
|
||||
@@ -117,8 +110,7 @@ the-order/
|
||||
- [Data Models](docs/architecture/README.md#data-models) - Entity relationships
|
||||
|
||||
### Integrations
|
||||
- [Entra VerifiedID](docs/integrations/entra-verifiedid/README.md) - Credential issuance
|
||||
- [Azure CDN](docs/deployment/azure/cdn-setup.md) - CDN configuration
|
||||
- [Legacy Provider Archive](archive/quarantined-legacy-stack/README.md) - quarantined historical material
|
||||
|
||||
### Legal System
|
||||
- [Document Management](docs/legal/document-management/) - DMS documentation
|
||||
@@ -173,17 +165,11 @@ pnpm --filter @the-order/database test
|
||||
|
||||
## Infrastructure
|
||||
|
||||
### Azure Deployment
|
||||
### Sankofa Phoenix Deployment
|
||||
|
||||
```bash
|
||||
# Load environment
|
||||
source infra/scripts/azure-load-env.sh
|
||||
|
||||
# Deploy infrastructure
|
||||
./infra/scripts/azure-deploy.sh
|
||||
|
||||
# Deploy sovereignty landing zone
|
||||
./infra/scripts/deploy-sovereignty-landing-zone.sh
|
||||
# Preview the full Phoenix-native flow
|
||||
./scripts/deploy/deploy.sh --all --environment dev --dry-run
|
||||
```
|
||||
|
||||
### Kubernetes Deployment
|
||||
@@ -201,7 +187,7 @@ kubectl apply -k infra/k8s/overlays/dev
|
||||
### Digital Identity
|
||||
- ✅ eIDAS compliance
|
||||
- ✅ DID (Decentralized Identifiers)
|
||||
- ✅ Microsoft Entra VerifiedID
|
||||
- ✅ DID and issuer-domain based credential issuance
|
||||
- ✅ Verifiable Credentials
|
||||
|
||||
### Document Management
|
||||
@@ -213,14 +199,14 @@ kubectl apply -k infra/k8s/overlays/dev
|
||||
- ✅ E-signatures
|
||||
|
||||
### Security & Compliance
|
||||
- ✅ Cloud for Sovereignty
|
||||
- ✅ Sankofa Phoenix operational control
|
||||
- ✅ Data residency enforcement
|
||||
- ✅ Customer-managed encryption
|
||||
- ✅ Private endpoints
|
||||
- ✅ GDPR & eIDAS compliance
|
||||
|
||||
### Infrastructure
|
||||
- ✅ Multi-region deployment (7 regions)
|
||||
- ✅ Phoenix / Proxmox deployment flow
|
||||
- ✅ Well-Architected Framework
|
||||
- ✅ Infrastructure as Code
|
||||
- ✅ Automated deployments
|
||||
@@ -243,16 +229,14 @@ kubectl apply -k infra/k8s/overlays/dev
|
||||
- Redis
|
||||
|
||||
### Infrastructure
|
||||
- Azure (non-US commercial regions)
|
||||
- Sankofa Phoenix / Proxmox
|
||||
- Kubernetes
|
||||
- Terraform
|
||||
- Docker
|
||||
|
||||
### Monitoring
|
||||
- Prometheus
|
||||
- Grafana
|
||||
- OpenTelemetry
|
||||
- Log Analytics
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -279,7 +263,7 @@ See [LICENSE](LICENSE) for license information.
|
||||
|
||||
- ✅ Core services implemented
|
||||
- ✅ Legal document management complete
|
||||
- ✅ Entra VerifiedID integration complete
|
||||
- ✅ Phoenix-native identity flow complete
|
||||
- ✅ Multi-region infrastructure planned
|
||||
- 🔄 Testing and optimization in progress
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# Legacy Provider Quarantine
|
||||
|
||||
This directory contains historical provider-specific deployment or integration material that is no longer part of the active Sankofa Phoenix / Proxmox operating model.
|
||||
|
||||
Quarantine rules:
|
||||
|
||||
- Nothing in this tree should be treated as the current deployment path.
|
||||
- Active docs should point to `scripts/deploy/` and `docs/deployment/DEPLOYMENT_QUICK_REFERENCE.md`.
|
||||
- Active credential issuance should use the Phoenix-native identity flow, not the archived legacy connector path.
|
||||
|
||||
This tree is intentionally preserved for reference, audits, and migration archaeology.
|
||||
@@ -0,0 +1,283 @@
|
||||
# Architecture Documentation
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Status**: Comprehensive Architecture Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This directory contains comprehensive architecture documentation for The Order platform, including system design, data models, deployment architecture, and architectural decision records (ADRs).
|
||||
|
||||
## Documentation Index
|
||||
|
||||
### Core Architecture
|
||||
- [Cloud for Sovereignty Landing Zone](CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md) - Complete multi-region architecture
|
||||
- [Sovereignty Landing Zone Summary](SOVEREIGNTY_LANDING_ZONE_SUMMARY.md) - Executive summary
|
||||
|
||||
### System Design
|
||||
- **Microservices Architecture**: See service documentation in `services/*/README.md`
|
||||
- **Data Models**: Entity relationships and database schema
|
||||
- **API Design**: RESTful APIs with OpenAPI/Swagger documentation
|
||||
- **Security Architecture**: Zero-trust, defense in depth
|
||||
|
||||
## Architecture Principles
|
||||
|
||||
### Well-Architected Framework
|
||||
|
||||
The Order follows Azure Well-Architected Framework principles:
|
||||
|
||||
1. **Cost Optimization**
|
||||
- Right-sized resources
|
||||
- Reserved instances
|
||||
- Cost allocation tags
|
||||
- Budget alerts
|
||||
|
||||
2. **Operational Excellence**
|
||||
- Infrastructure as Code
|
||||
- Automated deployments
|
||||
- Centralized logging
|
||||
- Runbooks and playbooks
|
||||
|
||||
3. **Performance Efficiency**
|
||||
- Regional proximity
|
||||
- CDN for global delivery
|
||||
- Auto-scaling
|
||||
- Performance monitoring
|
||||
|
||||
4. **Reliability**
|
||||
- Multi-region redundancy
|
||||
- Availability Zones
|
||||
- Automated failover
|
||||
- RTO: 4 hours, RPO: 1 hour
|
||||
|
||||
5. **Security**
|
||||
- Zero-trust architecture
|
||||
- Defense in depth
|
||||
- Data encryption
|
||||
- Identity and access management
|
||||
|
||||
### Cloud for Sovereignty
|
||||
|
||||
- **Data Residency**: All data within specified regions
|
||||
- **Data Protection**: Customer-managed keys, private endpoints
|
||||
- **Compliance**: GDPR, eIDAS, regional requirements
|
||||
- **Operational Control**: Management groups, policy governance
|
||||
|
||||
## System Architecture
|
||||
|
||||
### High-Level Overview
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Frontend Applications │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ MCP Legal │ │ Portal Public│ │Portal Internal│ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ API Gateway / Load Balancer │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────────┼───────────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Identity │ │ Intake │ │ Finance │
|
||||
│ Service │ │ Service │ │ Service │
|
||||
└──────────────┘ └──────────────┘ └──────────────┘
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Dataroom │ │Legal Docs │ │ e-Residency │
|
||||
│ Service │ │ Service │ │ Service │
|
||||
└──────────────┘ └──────────────┘ └──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Shared Infrastructure │
|
||||
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
|
||||
│ │PostgreSQL│ │ Redis │ │OpenSearch│ │ Azure │ │
|
||||
│ │ │ │ │ │ │ │ Storage │ │
|
||||
│ └──────────┘ └──────────┘ └──────────┘ └──────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Service Architecture
|
||||
|
||||
Each service follows a consistent architecture:
|
||||
|
||||
```
|
||||
Service
|
||||
├── API Layer (Fastify)
|
||||
│ ├── Routes
|
||||
│ ├── Middleware
|
||||
│ └── Validation
|
||||
├── Service Layer
|
||||
│ ├── Business Logic
|
||||
│ ├── External Integrations
|
||||
│ └── Error Handling
|
||||
├── Data Layer
|
||||
│ ├── Database Queries
|
||||
│ ├── Caching
|
||||
│ └── Storage
|
||||
└── Infrastructure
|
||||
├── Health Checks
|
||||
├── Metrics
|
||||
└── Logging
|
||||
```
|
||||
|
||||
## Data Models
|
||||
|
||||
### Core Entities
|
||||
|
||||
- **User**: Member of The Order
|
||||
- **Identity**: Digital identity (eIDAS/DID)
|
||||
- **Credential**: Verifiable credential
|
||||
- **Document**: Legal document
|
||||
- **Matter**: Legal matter
|
||||
- **Deal**: Business transaction
|
||||
- **Payment**: Financial transaction
|
||||
|
||||
### Relationships
|
||||
|
||||
See entity relationship diagrams in service-specific documentation.
|
||||
|
||||
## Deployment Architecture
|
||||
|
||||
### Regional Deployment
|
||||
|
||||
The Order is deployed across 7 non-US commercial Azure regions:
|
||||
|
||||
1. **West Europe** (Netherlands) - Primary
|
||||
2. **North Europe** (Ireland) - Secondary
|
||||
3. **UK South** (London)
|
||||
4. **Switzerland North** (Zurich)
|
||||
5. **Norway East** (Oslo)
|
||||
6. **France Central** (Paris)
|
||||
7. **Germany West Central** (Frankfurt)
|
||||
|
||||
### Per-Region Architecture
|
||||
|
||||
Each region includes:
|
||||
- Hub Virtual Network (gateway, firewall, management)
|
||||
- Spoke Virtual Network (application, database, storage)
|
||||
- Azure Firewall
|
||||
- Key Vault (with private endpoint)
|
||||
- Storage Account (with private endpoint)
|
||||
- Log Analytics Workspace
|
||||
- AKS Cluster (optional)
|
||||
|
||||
### Network Architecture
|
||||
|
||||
- **Hub-and-Spoke**: Centralized connectivity
|
||||
- **Private Endpoints**: Secure service access
|
||||
- **Azure Firewall**: Centralized security
|
||||
- **VNet Peering**: Hub-to-spoke connectivity
|
||||
|
||||
## Security Architecture
|
||||
|
||||
### Zero-Trust Principles
|
||||
|
||||
- **Identity Verification**: Always verify identity
|
||||
- **Least Privilege**: Minimum required access
|
||||
- **Network Segmentation**: Isolated networks
|
||||
- **Encryption**: At rest and in transit
|
||||
- **Monitoring**: Continuous security monitoring
|
||||
|
||||
### Defense in Depth
|
||||
|
||||
1. **Perimeter**: Azure Firewall, WAF
|
||||
2. **Network**: NSGs, Private Endpoints
|
||||
3. **Application**: Authentication, Authorization
|
||||
4. **Data**: Encryption, Access Controls
|
||||
5. **Identity**: MFA, RBAC, PIM
|
||||
|
||||
## Monitoring & Observability
|
||||
|
||||
### Metrics
|
||||
- Application metrics (Prometheus)
|
||||
- Infrastructure metrics (Azure Monitor)
|
||||
- Business metrics (Custom dashboards)
|
||||
|
||||
### Logging
|
||||
- Structured logging (JSON)
|
||||
- Centralized log aggregation (Log Analytics)
|
||||
- Log retention (90 days production)
|
||||
|
||||
### Tracing
|
||||
- Distributed tracing (OpenTelemetry)
|
||||
- Request flow visualization
|
||||
- Performance analysis
|
||||
|
||||
## Disaster Recovery
|
||||
|
||||
### Strategy
|
||||
- **RTO**: 4 hours
|
||||
- **RPO**: 1 hour
|
||||
- **Primary Region**: West Europe
|
||||
- **Secondary Region**: North Europe
|
||||
- **Backup Regions**: Other 5 regions
|
||||
|
||||
### Backup Strategy
|
||||
- Database: Daily full, hourly incremental
|
||||
- Storage: Cross-region replication
|
||||
- Configuration: Version controlled
|
||||
|
||||
## Technology Stack
|
||||
|
||||
### Frontend
|
||||
- React 18+
|
||||
- Next.js 14+
|
||||
- TypeScript
|
||||
- Tailwind CSS
|
||||
- Material-UI
|
||||
|
||||
### Backend
|
||||
- Node.js 18+
|
||||
- TypeScript
|
||||
- Fastify
|
||||
- PostgreSQL
|
||||
- Redis
|
||||
|
||||
### Infrastructure
|
||||
- Azure (non-US commercial)
|
||||
- Kubernetes
|
||||
- Terraform
|
||||
- Docker
|
||||
|
||||
### Monitoring
|
||||
- Prometheus
|
||||
- Grafana
|
||||
- OpenTelemetry
|
||||
- Log Analytics
|
||||
|
||||
## Design Decisions
|
||||
|
||||
### Why Microservices?
|
||||
- Independent scaling
|
||||
- Technology diversity
|
||||
- Team autonomy
|
||||
- Fault isolation
|
||||
|
||||
### Why Azure (Non-US)?
|
||||
- Data sovereignty requirements
|
||||
- GDPR compliance
|
||||
- Regional data residency
|
||||
- Cloud for Sovereignty
|
||||
|
||||
### Why Kubernetes?
|
||||
- Container orchestration
|
||||
- Auto-scaling
|
||||
- Rolling updates
|
||||
- Service discovery
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Cloud for Sovereignty Landing Zone](CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md)
|
||||
- [Deployment Guides](../deployment/README.md)
|
||||
- [Service Documentation](../../services/*/README.md)
|
||||
- [Infrastructure Documentation](../../infra/README.md)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
@@ -0,0 +1,95 @@
|
||||
# Documentation Archive
|
||||
|
||||
This directory contains historical and superseded documentation that has been consolidated or replaced.
|
||||
|
||||
## Purpose
|
||||
|
||||
Documents in this archive are:
|
||||
- **Superseded**: Replaced by newer, consolidated versions
|
||||
- **Historical**: Preserved for reference but no longer actively maintained
|
||||
- **Duplicate**: Merged into single authoritative documents
|
||||
|
||||
## Archive Structure
|
||||
|
||||
```
|
||||
archive/
|
||||
├── reports/ # Historical status and task reports
|
||||
├── deployment/ # Superseded deployment documentation
|
||||
│ ├── azure-cdn/ # Old Azure CDN setup files (merged into azure/cdn-setup.md)
|
||||
│ ├── entra/ # Old Entra VerifiedID files (merged into azure/entra-verifiedid.md)
|
||||
│ └── automation/ # Old automation files (merged into automation/seal-deployment.md)
|
||||
```
|
||||
|
||||
## What Was Consolidated
|
||||
|
||||
### Reports Directory
|
||||
- **Completion Files**: Merged into `reports/current-status.md`
|
||||
- `COMPLETION_STATUS.md`
|
||||
- `COMPLETION_SUMMARY.md`
|
||||
- `TASK_COMPLETION_SUMMARY.md`
|
||||
|
||||
- **Task Lists**: Merged into `reports/active-tasks.md`
|
||||
- `REMAINING_TASKS.md`
|
||||
- `REMAINING_TODOS.md`
|
||||
- `ALL_REMAINING_TASKS.md`
|
||||
- `REMAINING_TODOS_QUICK_REFERENCE.md`
|
||||
- `REMAINING_TASKS_CREDENTIAL_AUTOMATION.md`
|
||||
|
||||
- **Gap Analysis**: Moved to `legal/document-management/implementation/gaps-analysis.md`
|
||||
- `GAPS_SUMMARY.md`
|
||||
- `GAPS_AND_PLACEHOLDERS.md`
|
||||
|
||||
- **Frontend Docs**: Moved to `product/features/`
|
||||
- `FRONTEND_COMPLETE.md` → `product/features/frontend-completion.md`
|
||||
- `FRONTEND_COMPONENTS_VERIFICATION.md` → `product/features/frontend-components.md`
|
||||
|
||||
- **Deprecation Files**: Historical (ESLint 9 migration complete)
|
||||
- `DEPRECATION_FIXES_COMPLETE.md`
|
||||
- `DEPRECATION_FIXES_RECOMMENDATIONS.md`
|
||||
- `FINAL_DEPRECATION_STATUS.md`
|
||||
|
||||
### Deployment Directory
|
||||
- **Azure CDN Files**: Merged into `deployment/azure/cdn-setup.md`
|
||||
- `AZURE_CDN_SETUP.md`
|
||||
- `AZURE_CDN_COMPLETE.md`
|
||||
- `AZURE_CDN_STATUS.md`
|
||||
- `AZURE_CDN_FINAL_STATUS.md`
|
||||
- `AZURE_CDN_QUICK_START.md`
|
||||
- `AZURE_CDN_SETUP_COMPLETE.md`
|
||||
|
||||
- **Entra VerifiedID Files**: Merged into `deployment/azure/entra-verifiedid.md`
|
||||
- `ENTRA_COMPLETE_SUMMARY.md`
|
||||
- `ENTRA_VERIFIEDID_DEPLOYMENT_CHECKLIST.md`
|
||||
- `ENTRA_VERIFIEDID_NEXT_STEPS.md`
|
||||
|
||||
- **Automation Files**: Merged into `deployment/automation/seal-deployment.md`
|
||||
- `AUTOMATION_COMPLETE.md`
|
||||
- `AUTOMATION_SUMMARY.md`
|
||||
- `SEAL_DEPLOYMENT_AUTOMATION.md` (moved, not archived)
|
||||
|
||||
## Accessing Archived Content
|
||||
|
||||
Archived files are preserved for:
|
||||
- **Historical Reference**: Understanding project evolution
|
||||
- **Context**: Seeing what was consolidated and why
|
||||
- **Recovery**: If consolidation missed important details
|
||||
|
||||
## Finding Current Documentation
|
||||
|
||||
- **Current Status**: `docs/reports/current-status.md`
|
||||
- **Active Tasks**: `docs/reports/active-tasks.md`
|
||||
- **Azure CDN Setup**: `docs/deployment/azure/cdn-setup.md`
|
||||
- **Entra VerifiedID**: `docs/deployment/azure/entra-verifiedid.md`
|
||||
- **Deployment Overview**: `docs/deployment/overview.md`
|
||||
|
||||
## Maintenance
|
||||
|
||||
- Archive is **read-only** - do not update archived files
|
||||
- New consolidations should note what was merged
|
||||
- Archive structure may be reorganized if it grows too large
|
||||
|
||||
---
|
||||
|
||||
**Archive Created**: 2025-01-27
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
# Deployment Documentation
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Purpose**: Complete deployment guide index
|
||||
|
||||
## Overview
|
||||
|
||||
This directory contains comprehensive deployment guides for The Order platform, covering infrastructure setup, service deployment, and operational procedures.
|
||||
|
||||
## Quick Links
|
||||
|
||||
### Azure Deployment
|
||||
- [Environment Setup](azure/ENVIRONMENT_SETUP.md) - Azure configuration and setup
|
||||
- [Dotenv Configuration](azure/DOTENV_SETUP.md) - Using .env file for deployments
|
||||
- [Sovereignty Landing Zone](azure/SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md) - Multi-region deployment
|
||||
- [CDN Setup](azure/cdn-setup.md) - Azure CDN configuration
|
||||
- [Entra VerifiedID](azure/entra-verifiedid.md) - Entra VerifiedID setup
|
||||
|
||||
### Kubernetes Deployment
|
||||
- [Kubernetes Guide](../../infra/k8s/README.md) - K8s deployment guide
|
||||
- [Service Manifests](../../infra/k8s/base/) - Base Kubernetes manifests
|
||||
|
||||
### Infrastructure
|
||||
- [Infrastructure Overview](../../infra/README.md) - Infrastructure documentation
|
||||
- [Terraform Guide](../../infra/terraform/README.md) - Terraform documentation
|
||||
|
||||
## Deployment Guides by Scenario
|
||||
|
||||
### Initial Setup
|
||||
1. [Azure Environment Setup](azure/ENVIRONMENT_SETUP.md)
|
||||
2. [Dotenv Configuration](azure/DOTENV_SETUP.md)
|
||||
3. [Infrastructure Deployment](../../infra/README.md)
|
||||
|
||||
### Multi-Region Deployment
|
||||
1. [Sovereignty Landing Zone Deployment](azure/SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md)
|
||||
2. [Cloud for Sovereignty Architecture](../../docs/architecture/CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md)
|
||||
|
||||
### Service Deployment
|
||||
1. [Kubernetes Deployment](../../infra/k8s/README.md)
|
||||
2. Service-specific READMEs in `services/*/README.md`
|
||||
|
||||
### Integration Setup
|
||||
1. [Entra VerifiedID](azure/entra-verifiedid.md)
|
||||
2. [CDN Configuration](azure/cdn-setup.md)
|
||||
3. [Integration Guides](../integrations/)
|
||||
|
||||
## Deployment Workflows
|
||||
|
||||
### Complete Azure Deployment
|
||||
|
||||
```bash
|
||||
# 1. Load environment
|
||||
source infra/scripts/azure-load-env.sh
|
||||
|
||||
# 2. Validate configuration
|
||||
./infra/scripts/azure-validate-current-env.sh
|
||||
|
||||
# 3. Deploy infrastructure
|
||||
./infra/scripts/azure-deploy.sh
|
||||
|
||||
# 4. Deploy sovereignty landing zone
|
||||
./infra/scripts/deploy-sovereignty-landing-zone.sh
|
||||
```
|
||||
|
||||
### Kubernetes Deployment
|
||||
|
||||
```bash
|
||||
# 1. Apply base configuration
|
||||
kubectl apply -k infra/k8s/base
|
||||
|
||||
# 2. Apply environment overlay
|
||||
kubectl apply -k infra/k8s/overlays/dev
|
||||
|
||||
# 3. Verify deployment
|
||||
kubectl get pods -n the-order
|
||||
```
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
```
|
||||
deployment/
|
||||
├── README.md # This file
|
||||
└── azure/ # Azure-specific guides
|
||||
├── ENVIRONMENT_SETUP.md
|
||||
├── DOTENV_SETUP.md
|
||||
├── SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md
|
||||
├── cdn-setup.md
|
||||
└── entra-verifiedid.md
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Architecture Documentation](../architecture/)
|
||||
- [Infrastructure Documentation](../../infra/)
|
||||
- [Service Documentation](../../services/)
|
||||
- [Integration Documentation](../integrations/)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user