# DBAOps Sovereign™ — User Manual

**Release:** 1.3.0 Gold Master  
**Vendor:** RHOYLLE INNOVATION EMPIRE LLC  

This guide is for **operators and approvers** using Fleet Command (web UI) and related APIs during **pilot and production**.

---

## 1. What this product does

DBAOps Sovereign™ is a **control plane** for SQL Server fleets: see instances, health-style signals, telemetry, backup/HADR/patch/job/disk **coverage**, compliance scores, alerts, and baseline drift — with optional **collector-driven** ingest.

---

## 2. Getting in

1. Open the dashboard URL your administrator gives you (often `https://…` or `http://localhost:3000` in dev).  
2. **Sign in** with the email and password issued for your environment.  
3. Seeded demo users (after database migrate) are documented in **`.env.example`**; change passwords before production.

If login fails: confirm the **API** is reachable (status in the header should show **API Connected**).

---

## 3. Main screens

| Screen | Purpose |
|--------|---------|
| **Command Center** | KPI snapshot: instances, alerts, compliance average, telemetry count, **coverage** signals, license strip. |
| **Fleet** | Registered SQL instances (name, engine, version, last seen). |
| **Telemetry** | Latest performance snapshot per instance (CPU, memory, sessions, blocking). |
| **Coverage** | Backup RPO, Always On, patch/build, database inventory, SQL Agent jobs, volume space (from **facts** ingest). |
| **Compliance** | Framework scores per instance (seeded/mock until your scans feed it). |
| **Alerts** | Active and historical alerts; acknowledge when your role allows. |
| **Security** | Security posture summary (API JSON). |
| **Operations** | Jobs/volume/coverage-oriented summary. |
| **Baseline / Drift** | Configuration snapshots and drift findings (Operator/Admin workflows). |
| **Audit** | Administrator / Auditor view of mutating API actions. |
| **Integrations** | Catalog of first-party and roadmap integrations. |
| **Mobile API** | Compact `GET /api/mobile/summary` sample for apps. |

---

## 4. License bar

The top **license strip** shows **edition**, **instance usage** (used / allowed), and **expiry** when applicable. If the subscription is **inactive, expired, or over limit**, **writes** to the platform (ingest, register instance, baseline capture, alert ack) may return **403 LICENSE_BLOCK** until the license is renewed — **reads** usually still work so you can see status.

---

## 5. Collectors (fleet data)

PowerShell modules live under **`src/collectors/`**. Typical flow:

1. **Register** instances (Admin) or ensure they exist in **Fleet**.  
2. Run collector with your **API URL** and, if required, **ingest key** and **admin JWT** for registration.  
3. **Telemetry** → `POST /api/telemetry/snapshot`  
4. **Coverage facts** → `POST /api/ingest/fleet-facts`  

Details: **`src/collectors/README.md`**, **`docs/SHIP-V1-TELEMETRY.md`**, **`docs/SHIP-V1-FLEET-COVERAGE.md`**.

---

## 6. API (automation)

- **Contract:** `GET /api/openapi.json`  
- **Health:** `GET /api/health` (liveness), `GET /api/health/ready` (readiness)  
- **License:** `GET /api/license`  

Use the OpenAPI document for exact paths, headers (JWT, `X-Sovereign-Ingest-Key`), and payloads.

---

## 7. Troubleshooting

| Symptom | Check |
|---------|--------|
| **API Offline** | API process running; URL/port; firewall; reverse proxy. |
| **403 LICENSE_BLOCK** | `/api/license` — renew or raise instance limit; see **`docs/TIERS.md`**. |
| **404 on ingest** | Instance **not registered** — register fleet first. |
| **401 on protected routes** | `SOVEREIGN_REQUIRE_AUTH=true` — send **Bearer** token. |
| **SQL errors** | `SOVEREIGN_DB_CONNECTION`, migrate run, **`docs/CUSTOMER-DEPLOYMENT.md`**. |

---

## 8. Related documents

| Document | Audience |
|----------|----------|
| **`PRODUCT.md`** | What the product **is** (deliverable). |
| **`docs/CUSTOMER-DEPLOYMENT.md`** | Production install. |
| **`docs/RELEASE-GOLD.md`** | Release verification checklist. |
| **`docs/PILOT-RUNBOOK.md`** | Pilot day flow. |

---

© 2026 RHOYLLE INNOVATION EMPIRE LLC.
