fe0365757a
- Added generated index files and report directories to .gitignore to prevent unnecessary tracking of transient files. - Updated README links to reflect new documentation paths for better navigation. - Improved documentation organization by ensuring all links point to the correct locations, enhancing user experience and accessibility.
169 lines
3.8 KiB
Markdown
169 lines
3.8 KiB
Markdown
# Sankofa Phoenix - Deployment Documentation Index
|
|
|
|
**Quick Navigation Guide**
|
|
|
|
---
|
|
|
|
## 🎯 Start Here
|
|
|
|
### For Immediate Deployment
|
|
1. **[Deployment Guide](./DEPLOYMENT.md)** ⭐
|
|
- Production deployment instructions
|
|
- Step-by-step guide
|
|
- Current status
|
|
|
|
2. **[Deployment Execution Plan](./DEPLOYMENT_EXECUTION_PLAN.md)** ⭐
|
|
- Step-by-step execution guide
|
|
- Timeline estimates
|
|
- Rollback procedures
|
|
|
|
### For Planning
|
|
3. **[Deployment Requirements](./DEPLOYMENT_REQUIREMENTS.md)**
|
|
- Complete infrastructure requirements
|
|
- Software requirements
|
|
- Environment configuration
|
|
|
|
4. **[Infrastructure Ready](./INFRASTRUCTURE_READY.md)**
|
|
- Current infrastructure status
|
|
- Resource availability
|
|
- Deployment readiness
|
|
|
|
---
|
|
|
|
## 📚 Core Documentation
|
|
|
|
### Infrastructure
|
|
- **[Infrastructure Ready](./INFRASTRUCTURE_READY.md)**
|
|
- Infrastructure status
|
|
- VM requirements
|
|
- Resource allocation
|
|
|
|
- **[VM Specifications](vm/VM_SPECIFICATIONS.md)**
|
|
- Complete VM specifications and patterns
|
|
- Best practices and resource guidelines
|
|
- Template information
|
|
|
|
- **[VM Creation Procedure](vm/VM_CREATION_PROCEDURE.md)**
|
|
- Step-by-step VM creation guide
|
|
- Troubleshooting tips
|
|
- Configuration details
|
|
|
|
### Application Deployment
|
|
- **[Deployment Guide](./DEPLOYMENT.md)**
|
|
- Application deployment steps
|
|
- Database setup
|
|
- Keycloak configuration
|
|
|
|
- **[Keycloak Deployment](./KEYCLOAK_DEPLOYMENT.md)**
|
|
- Keycloak setup
|
|
- OIDC configuration
|
|
- Client setup
|
|
|
|
### VM Configuration
|
|
- **[VM Specifications](vm/VM_SPECIFICATIONS.md)**
|
|
- Complete VM specifications
|
|
- Template details and configurations
|
|
- Resource guidelines
|
|
|
|
- **[VM Creation Procedure](vm/VM_CREATION_PROCEDURE.md)**
|
|
- Step-by-step VM creation
|
|
- Configuration details
|
|
- Troubleshooting guide
|
|
|
|
- **[VM Deployment Checklist](vm/VM_DEPLOYMENT_CHECKLIST.md)**
|
|
- Deployment checklist
|
|
- Verification steps
|
|
|
|
---
|
|
|
|
## 🔧 Operational Documentation
|
|
|
|
### Monitoring and Observability
|
|
- **[Launch Checklist](./status/LAUNCH_CHECKLIST.md)**
|
|
- Pre-launch verification
|
|
- Success criteria
|
|
- Support readiness
|
|
|
|
### Architecture
|
|
- **[System Architecture](./system_architecture.md)**
|
|
- Overall architecture
|
|
- Component overview
|
|
|
|
- **[Datacenter Architecture](./datacenter_architecture.md)**
|
|
- Datacenter specifications
|
|
- Hardware requirements
|
|
|
|
- **[Blockchain Architecture](./blockchain_eea_architecture.md)**
|
|
- Blockchain design
|
|
- EEA compliance
|
|
|
|
---
|
|
|
|
## 📋 Checklists
|
|
|
|
### Pre-Deployment
|
|
- [ ] Resource quota verified
|
|
- [ ] Kubernetes cluster ready
|
|
- [ ] Database accessible
|
|
- [ ] Keycloak configured
|
|
- [ ] Cloudflare account ready
|
|
|
|
### Deployment
|
|
- [ ] Control plane deployed
|
|
- [ ] Applications deployed
|
|
- [ ] Infrastructure VMs deployed
|
|
- [ ] Application VMs deployed
|
|
- [ ] Monitoring stack deployed
|
|
|
|
### Post-Deployment
|
|
- [ ] All services healthy
|
|
- [ ] All VMs running
|
|
- [ ] Guest agent on all VMs
|
|
- [ ] Monitoring operational
|
|
- [ ] Smoke tests passing
|
|
|
|
---
|
|
|
|
## 🚀 Quick Reference
|
|
|
|
### Essential Commands
|
|
```bash
|
|
# Resource check
|
|
./scripts/check-proxmox-quota.sh
|
|
|
|
# Deploy VMs
|
|
kubectl apply -f examples/production/smom-dbis-138/
|
|
|
|
# Check status
|
|
kubectl get proxmoxvm -A
|
|
kubectl get pods -A
|
|
|
|
# Run tests
|
|
./scripts/smoke-tests.sh
|
|
```
|
|
|
|
### Key Files
|
|
- VM YAML files: `examples/production/smom-dbis-138/*.yaml`
|
|
- Infrastructure VMs: `examples/production/nginx-proxy-vm.yaml`, `cloudflare-tunnel-vm.yaml`
|
|
- Scripts: `scripts/*.sh`
|
|
- GitOps: `gitops/apps/*/`
|
|
|
|
---
|
|
|
|
## 📞 Support
|
|
|
|
### Troubleshooting
|
|
- Check controller logs: `kubectl logs -n crossplane-system -l app=crossplane-provider-proxmox`
|
|
- Check VM status: `kubectl get proxmoxvm -A -o wide`
|
|
- Check pod logs: `kubectl logs <pod-name> -n <namespace>`
|
|
|
|
### Documentation
|
|
- All deployment docs: `docs/`
|
|
- Scripts: `scripts/`
|
|
- Examples: `examples/production/`
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-01-XX
|
|
|