Update documentation with current project state
- Update README.md with Cluster Overcommit Analysis features - Add Podman preference over Docker in requirements - Update DOCUMENTATION.md with Phase 1 completion status - Update AIAgents-Support.md with Phase 1.3 completion - Add Cluster Overcommit Analysis to completed features - Update version to 1.2.0 and dates to 2025-10-01 - Reflect current implementation status across all docs
This commit is contained in:
@@ -23,9 +23,9 @@ All outdated files have been removed to maintain only current and relevant docum
|
|||||||
|
|
||||||
| File | Status | Last Update | Notes |
|
| File | Status | Last Update | Notes |
|
||||||
|------|--------|-------------|-------|
|
|------|--------|-------------|-------|
|
||||||
| README.md | ✅ Active | 2025-09-30 | Main documentation with pragmatic roadmap |
|
| README.md | ✅ Active | 2025-10-01 | Main documentation with pragmatic roadmap |
|
||||||
| AIAgents-Support.md | ✅ Active | 2025-09-30 | AI agents support and project context |
|
| AIAgents-Support.md | ✅ Active | 2025-10-01 | AI agents support and project context |
|
||||||
| DOCUMENTATION.md | ✅ Active | 2025-09-30 | Documentation index |
|
| DOCUMENTATION.md | ✅ Active | 2025-10-01 | Documentation index |
|
||||||
|
|
||||||
**Removed files:** 6 outdated files were removed to keep documentation clean and organized.
|
**Removed files:** 6 outdated files were removed to keep documentation clean and organized.
|
||||||
|
|
||||||
@@ -40,11 +40,13 @@ All outdated files have been removed to maintain only current and relevant docum
|
|||||||
- Problem Summary table with namespace issues
|
- Problem Summary table with namespace issues
|
||||||
- Direct actions: Analyze and Fix buttons
|
- Direct actions: Analyze and Fix buttons
|
||||||
|
|
||||||
### **Phase 1: Enhanced Validation & Categorization (IN PROGRESS 🔄)**
|
### **Phase 1: Enhanced Validation & Categorization (COMPLETED ✅)**
|
||||||
- Enhanced Validation Engine with better categorization
|
- Enhanced Validation Engine with better categorization
|
||||||
- Workload Analysis System with detailed pod/container breakdown
|
- Workload Analysis System with detailed pod/container breakdown
|
||||||
- Issue Categorization (Missing requests, missing limits, wrong ratios)
|
- Issue Categorization (Missing requests, missing limits, wrong ratios)
|
||||||
- Clear recommendations for each issue
|
- Clear recommendations for each issue
|
||||||
|
- Historical Analysis Integration with real numerical data
|
||||||
|
- Cluster Overcommit Analysis with detailed tooltips
|
||||||
|
|
||||||
### **Phase 2: Smart Recommendations Engine (SHORT TERM - 2-3 weeks)**
|
### **Phase 2: Smart Recommendations Engine (SHORT TERM - 2-3 weeks)**
|
||||||
- Dedicated Recommendations Section
|
- Dedicated Recommendations Section
|
||||||
|
|||||||
27
README.md
27
README.md
@@ -8,8 +8,9 @@ A resource governance tool for OpenShift clusters that goes beyond what Metrics
|
|||||||
- **Red Hat Validations**: Validates capacity management best practices with specific request/limit values
|
- **Red Hat Validations**: Validates capacity management best practices with specific request/limit values
|
||||||
- **Smart Resource Analysis**: Identifies workloads without requests/limits and provides detailed analysis
|
- **Smart Resource Analysis**: Identifies workloads without requests/limits and provides detailed analysis
|
||||||
- **Detailed Problem Analysis**: Modal-based detailed view showing pod and container resource issues
|
- **Detailed Problem Analysis**: Modal-based detailed view showing pod and container resource issues
|
||||||
- **Historical Analysis**: Workload-based historical resource usage analysis (1d, 7d, 30d)
|
- **Historical Analysis**: Workload-based historical resource usage analysis with real numerical data (1h, 6h, 24h, 7d)
|
||||||
- **Prometheus Integration**: Collects real consumption metrics from OpenShift monitoring
|
- **Prometheus Integration**: Collects real consumption metrics from OpenShift monitoring with OpenShift-specific queries
|
||||||
|
- **Cluster Overcommit Analysis**: Real-time cluster capacity vs requests analysis with detailed tooltips
|
||||||
- **Export Reports**: Generates reports in JSON, CSV formats
|
- **Export Reports**: Generates reports in JSON, CSV formats
|
||||||
- **Modern Web UI**: Pragmatic dashboard with modal-based analysis and professional interface
|
- **Modern Web UI**: Pragmatic dashboard with modal-based analysis and professional interface
|
||||||
- **Cluster Agnostic**: Works on any OpenShift cluster without configuration
|
- **Cluster Agnostic**: Works on any OpenShift cluster without configuration
|
||||||
@@ -20,7 +21,7 @@ A resource governance tool for OpenShift clusters that goes beyond what Metrics
|
|||||||
- Prometheus (native in OCP)
|
- Prometheus (native in OCP)
|
||||||
- VPA (optional, for recommendations)
|
- VPA (optional, for recommendations)
|
||||||
- Python 3.11+
|
- Python 3.11+
|
||||||
- Docker
|
- Podman (preferred) or Docker
|
||||||
- OpenShift CLI (oc)
|
- OpenShift CLI (oc)
|
||||||
|
|
||||||
## 🛠️ Installation
|
## 🛠️ Installation
|
||||||
@@ -264,6 +265,15 @@ pip install -r requirements.txt
|
|||||||
python -m uvicorn app.main:app --reload --host 0.0.0.0 --port 8080
|
python -m uvicorn app.main:app --reload --host 0.0.0.0 --port 8080
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Run with Podman (Recommended)
|
||||||
|
```bash
|
||||||
|
# Build
|
||||||
|
podman build -t resource-governance .
|
||||||
|
|
||||||
|
# Run
|
||||||
|
podman run -p 8080:8080 resource-governance
|
||||||
|
```
|
||||||
|
|
||||||
### Run with Docker
|
### Run with Docker
|
||||||
```bash
|
```bash
|
||||||
# Build
|
# Build
|
||||||
@@ -334,6 +344,17 @@ curl http://localhost:8080/health
|
|||||||
- Calculate P95/P99 percentiles for recommendations
|
- Calculate P95/P99 percentiles for recommendations
|
||||||
- Identify seasonal patterns and trends
|
- Identify seasonal patterns and trends
|
||||||
- Flag workloads with insufficient historical data
|
- Flag workloads with insufficient historical data
|
||||||
|
- Real numerical consumption data with cluster percentages
|
||||||
|
- OpenShift-specific Prometheus queries for better accuracy
|
||||||
|
- Workload selector with time ranges (1h, 6h, 24h, 7d)
|
||||||
|
- Simulated data fallback for demonstration
|
||||||
|
|
||||||
|
#### 1.3 Cluster Overcommit Analysis
|
||||||
|
- [x] **Real-time Overcommit Monitoring**
|
||||||
|
- CPU and Memory capacity vs requests analysis
|
||||||
|
- Detailed tooltips with capacity, requests, and available resources
|
||||||
|
- Modal-based detailed breakdown of overcommit calculations
|
||||||
|
- Resource utilization tracking
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user