Skip to content

Commit 89dbf9c

Browse files
committed
Update README.md with current project status
- Update Development Phases to reflect Phase 1-3 completion - Fix project structure to show deploy/openshift/ and src/shared/ - Update Quick Start with local dev and OpenShift deployment instructions - Add link to development-plan.md for detailed tracking
1 parent 3b7ba7c commit 89dbf9c

1 file changed

Lines changed: 47 additions & 20 deletions

File tree

README.md

Lines changed: 47 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -198,15 +198,18 @@ aiops-nextgen/
198198
│ ├── 08-integration-matrix.md # Integration contracts
199199
│ └── 09-deployment.md # OpenShift deployment
200200
├── deploy/ # Deployment manifests
201-
│ ├── helm/ # Helm charts
202-
│ └── kustomize/ # Kustomize overlays
201+
│ ├── helm/ # Helm charts (future)
202+
│ └── openshift/ # Kustomize overlays for OpenShift
203203
└── src/ # Source code
204-
├── cluster-registry/
205-
├── observability-collector/
206-
├── intelligence-engine/
207-
├── realtime-streaming/
208-
├── api-gateway/
209-
└── frontend/
204+
├── shared/ # Shared Python package (models, db, redis, config)
205+
├── cluster-registry/ # Fleet management service
206+
├── observability-collector/# Metrics federation service
207+
├── intelligence-engine/ # AI/LLM service (pending)
208+
├── realtime-streaming/ # WebSocket service (pending)
209+
├── api-gateway/ # Entry point service (pending)
210+
├── frontend/ # React SPA (pending)
211+
├── docker-compose.yml # Local development stack
212+
└── development-plan.md # Implementation roadmap
210213
```
211214

212215
---
@@ -215,12 +218,14 @@ aiops-nextgen/
215218

216219
| Phase | Focus | Status |
217220
|-------|-------|--------|
218-
| 1 | Specification Review | **Complete** |
219-
| 2 | Core Infrastructure (Registry, Collector) | Pending |
220-
| 3 | Intelligence Layer (LLM, Personas) | Pending |
221-
| 4 | Real-time & Frontend | Pending |
222-
| 5 | AIOps Features (Anomaly, RCA) | Pending |
223-
| 6 | CNF/Telco Specialization | Pending |
221+
| 1 | Foundation & Data Layer (shared models, PostgreSQL, Redis) | ✅ Complete |
222+
| 2 | Cluster Registry (fleet CRUD, health monitoring, events) | ✅ Complete |
223+
| 3 | Observability Collector (metrics, alerts, GPU telemetry) | ✅ Complete |
224+
| 4 | Intelligence Engine (LLM, personas, chat, anomaly) | Pending |
225+
| 5 | Real-time Streaming & API Gateway | Pending |
226+
| 6 | Frontend (React SPA) | Pending |
227+
228+
See [`src/development-plan.md`](src/development-plan.md) for detailed task tracking.
224229

225230
---
226231

@@ -236,18 +241,40 @@ aiops-nextgen/
236241

237242
## Quick Start
238243

244+
### Local Development
245+
239246
```bash
240247
# Clone repository
241248
git clone https://github.com/open-experiments/aiops-nextgen.git
242249
cd aiops-nextgen
243250

244-
# Review specifications
245-
ls specs/
251+
# Start infrastructure (PostgreSQL + Redis)
252+
cd src && docker-compose up -d postgresql redis
253+
254+
# Start services
255+
cd src/cluster-registry && uvicorn app.main:app --reload --port 8001
256+
cd src/observability-collector && uvicorn app.main:app --reload --port 8002
257+
```
258+
259+
### OpenShift Deployment
246260

247-
# Deploy to OpenShift (after implementation)
248-
helm install aiops-nextgen ./deploy/helm/aiops-nextgen \
249-
--namespace aiops-nextgen \
250-
--create-namespace
261+
```bash
262+
# Login to OpenShift
263+
oc login --token=<token> --server=<api-server>
264+
265+
# Create namespace and deploy
266+
oc new-project aiops-nextgen
267+
oc apply -k deploy/openshift/
268+
269+
# Verify deployment
270+
oc get pods -n aiops-nextgen
251271
```
252272

273+
### API Endpoints
274+
275+
| Service | Port | Health Check |
276+
|---------|------|--------------|
277+
| Cluster Registry | 8001 | `GET /health`, `GET /ready` |
278+
| Observability Collector | 8002 | `GET /health`, `GET /ready` |
279+
253280
---

0 commit comments

Comments
 (0)