smom-dbis-138/orchestration/portal/README_ENHANCED.md

Enhanced Multi-Cloud Orchestration Portal

🚀 Quick Start

Run Enhanced Portal

cd orchestration/portal
pip install -r requirements.txt
python app_enhanced.py

Access at:

• Main Dashboard: http://localhost:5000
• Health Dashboard: http://localhost:5000/dashboard/health
• Cost Dashboard: http://localhost:5000/dashboard/costs

✨ Features

Enhanced Dashboard

• Real-time Statistics: Total environments, enabled count, providers, active alerts
• Alert System: Prominent display of unacknowledged alerts
• Recent Deployments: Timeline of recent deployment activity
• Provider Grouping: Environments organized by cloud provider with visual indicators

Environment Detail Pages

• Comprehensive Metrics: CPU, memory, network, pods, nodes
• Interactive Charts: 24-hour CPU and memory usage graphs
• Deployment History: Complete audit trail with status tracking
• Health Indicators: Visual status badges and uptime tracking

Health Dashboard

• Multi-Environment Comparison: Side-by-side health comparison
• Provider Performance: Compare performance across providers
• Detailed Metrics Table: Comprehensive health metrics

Cost Dashboard

• Cost Tracking: Track costs across all environments
• Provider Breakdown: Costs grouped by cloud provider
• Trend Analysis: 90-day cost trend visualization
• Cost Breakdown Table: Detailed cost per environment and resource type

Deployment Management

• Strategy Selection: Blue-green, canary, or rolling deployments
• Version Control: Specify version to deploy
• Deployment History: Complete audit trail
• Log Access: View deployment logs
• Status Tracking: Real-time deployment status

📊 Database

The portal uses SQLite for storing:

• Deployment history
• Metrics data
• Alerts
• Cost tracking

Database location: logs/orchestration.db

🔌 API Endpoints

Environments

• GET /api/environments - List all environments
• GET /api/environments/<name> - Get environment details with metrics, alerts, costs
• POST /api/environments/<name>/deploy - Trigger deployment
• GET /api/environments/<name>/status - Get deployment status
• GET /api/environments/<name>/metrics - Get metrics (with ?hours=24 parameter)
• GET /api/environments/<name>/alerts - Get alerts (with ?unacknowledged_only=true)

Deployments

• GET /api/deployments - List deployments (with ?environment=, ?status=, ?limit= filters)
• GET /api/deployments/<id>/logs - Get deployment logs

Alerts

• POST /api/alerts/<id>/acknowledge - Acknowledge an alert

Costs

• GET /api/costs - Get cost data (with ?environment=, ?days= parameters)

🎨 UI/UX Features

Visual Design

• Modern card-based layout
• Gradient headers
• Color-coded status indicators
• Font Awesome icons
• Responsive grid system

Interactive Elements

• Hover effects on cards
• Click-to-deploy buttons
• Expandable sections
• Real-time chart updates

Accessibility

• Semantic HTML
• High contrast colors
• Keyboard navigation
• Screen reader support

🔧 Configuration

Environment Variables

# Optional: Slack webhook for notifications
export SLACK_WEBHOOK_URL="https://hooks.slack.com/services/..."

# Optional: Database path (default: logs/orchestration.db)
export DB_PATH="/path/to/db.db"

Sample Data

The portal automatically seeds sample data on first run for demonstration purposes. In production, this would be replaced with real data from:

• Kubernetes API
• Terraform state
• Cloud provider APIs
• Monitoring systems

📈 Metrics Collection

Metrics are collected and stored in the database. To add real metrics collection:

1. Integrate with Prometheus/Grafana
2. Query Kubernetes metrics API
3. Use cloud provider monitoring APIs
4. Implement custom metric collectors

🔔 Notifications

Slack Integration

Set SLACK_WEBHOOK_URL environment variable to enable Slack notifications for deployments.

Custom Webhooks

Modify app_enhanced.py to add custom webhook integrations.

🚀 Deployment

Production Deployment

1. Use a production WSGI server (Gunicorn, uWSGI)
2. Set up reverse proxy (Nginx, Apache)
3. Use PostgreSQL instead of SQLite
4. Enable HTTPS
5. Set up monitoring and logging

Docker Deployment

FROM python:3.11-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY . .
CMD ["gunicorn", "-w", "4", "-b", "0.0.0.0:5000", "app_enhanced:app"]

🔐 Security

• Input validation on all API endpoints
• SQL injection prevention (parameterized queries)
• XSS protection (template escaping)
• CORS configuration
• Rate limiting (recommended for production)

📝 Future Enhancements

• Real-time WebSocket updates
• Advanced filtering and search
• Bulk operations
• Export functionality (CSV, PDF)
• Customizable dashboards
• Mobile app
• Advanced analytics
• Machine learning predictions

🐛 Troubleshooting

Database Issues

• Check file permissions on logs/orchestration.db
• Ensure logs/ directory exists
• Check SQLite version compatibility

Metrics Not Showing

• Verify sample data was seeded
• Check database connection
• Review logs for errors

Charts Not Rendering

• Check Chart.js CDN availability
• Verify JavaScript console for errors
• Ensure data format is correct

📚 Documentation

• UX/UI Enhancements
• Multi-Cloud Architecture
• API Documentation (to be created)

🤝 Contributing

1. Follow existing code style
2. Add tests for new features
3. Update documentation
4. Submit pull requests

📄 License

Same as main project license.