d-bis/Sankofa
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4880a9d6c3ecdae16de02a1e0acce91045250358
Sankofa/docs/DEPLOYMENT_INDEX.md
defiQUG fe0365757a Update documentation structure and enhance .gitignore 
- 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.
2025-12-12 21:18:55 -08:00

3.8 KiB
Raw Blame History

Sankofa Phoenix - Deployment Documentation Index

Quick Navigation Guide

🎯 Start Here

For Immediate Deployment

  1. Deployment Guide ⭐

    • Production deployment instructions
    • Step-by-step guide
    • Current status

  2. Deployment Execution Plan ⭐

    • Step-by-step execution guide
    • Timeline estimates
    • Rollback procedures

For Planning

  1. Deployment Requirements

    • Complete infrastructure requirements
    • Software requirements
    • Environment configuration

  2. Infrastructure Ready

    • Current infrastructure status
    • Resource availability
    • Deployment readiness

📚 Core Documentation

Infrastructure

  • Infrastructure Ready

    • Infrastructure status
    • VM requirements
    • Resource allocation

  • VM Specifications

    • Complete VM specifications and patterns
    • Best practices and resource guidelines
    • Template information

  • VM Creation Procedure

    • Step-by-step VM creation guide
    • Troubleshooting tips
    • Configuration details

Application Deployment

VM Configuration

🔧 Operational Documentation

Monitoring and Observability

Architecture

📋 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

# 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

Reference in New Issue View Git Blame Copy Permalink