docs: update README for v1.3 with config logs and GenAI auto-fill

Added Config Logs section to features, updated GenAI setup guide to reflect
auto-fill from OCI credentials, added config-logs API endpoints to reference,
and added v1.3 to versioning table. Bumped version badge to 1.3.
This commit is contained in:
nogueiraguh
2026-03-03 15:49:18 -03:00
parent 5a28f0d56f
commit 336766dae2

View File

@@ -9,7 +9,7 @@
</p> </p>
<p align="center"> <p align="center">
<img src="https://img.shields.io/badge/version-1.2-C74634?style=flat-square" alt="Version"> <img src="https://img.shields.io/badge/version-1.3-C74634?style=flat-square" alt="Version">
<img src="https://img.shields.io/badge/python-3.12-3776AB?style=flat-square" alt="Python"> <img src="https://img.shields.io/badge/python-3.12-3776AB?style=flat-square" alt="Python">
<img src="https://img.shields.io/badge/FastAPI-0.115-009688?style=flat-square" alt="FastAPI"> <img src="https://img.shields.io/badge/FastAPI-0.115-009688?style=flat-square" alt="FastAPI">
<img src="https://img.shields.io/badge/OCI-GenAI-C74634?style=flat-square" alt="OCI"> <img src="https://img.shields.io/badge/OCI-GenAI-C74634?style=flat-square" alt="OCI">
@@ -74,6 +74,14 @@ The platform combines security compliance scanning, AI-powered chat with **RAG (
- Browse, inspect and delete individual embeddings from the ADB vector store - Browse, inspect and delete individual embeddings from the ADB vector store
- 4 embedding models supported: Cohere Embed English/Multilingual v3.0 (1024d), Light variants (384d) - 4 embedding models supported: Cohere Embed English/Multilingual v3.0 (1024d), Light variants (384d)
### 📜 Configuration Logs
- **Persistent activity log** per configuration tab (OCI, GenAI, ADB, MCP)
- Logs all test, save, upload, report, and ingest operations with severity (success/error/info)
- **Inline log panel** at the bottom of each config tab with severity filter
- Auto-cleanup of logs older than 30 days
- Admin can view all logs; users see only their own
- API endpoints for listing and clearing logs
### 🔐 Security ### 🔐 Security
- **JWT authentication** with configurable expiry - **JWT authentication** with configurable expiry
- **TOTP MFA** (Google Authenticator / Authy compatible) - **TOTP MFA** (Google Authenticator / Authy compatible)
@@ -179,12 +187,11 @@ Click **Testar** to validate the connection.
Navigate to **GenAI Config** tab: Navigate to **GenAI Config** tab:
1. Select the **OCI Credential** created in Step 1 1. Select the **OCI Credential** created in Step 1**Region** and **Compartment OCID** are auto-filled from the selected credential
2. Choose a **model** from the catalog 2. Choose a **model** from the catalog
3. Select the **GenAI region** (must have Generative AI service available) 3. Adjust the **GenAI region** if needed (auto-populated, must have Generative AI service available)
4. Set the **Compartment OCID** (where GenAI policies are configured) 4. Adjust parameters (temperature, max_tokens, etc.)
5. Adjust parameters (temperature, max_tokens, etc.) 5. The **endpoint** is auto-generated: `https://inference.generativeai.{region}.oci.oraclecloud.com`
6. The **endpoint** is auto-generated: `https://inference.generativeai.{region}.oci.oraclecloud.com`
For **dedicated endpoints**, switch Serving Type to `DEDICATED` and provide the endpoint ID. For **dedicated endpoints**, switch Serving Type to `DEDICATED` and provide the endpoint ID.
@@ -366,6 +373,13 @@ oci-cis-agent/
| GET | `/api/reports/{id}/html` | View HTML report | | GET | `/api/reports/{id}/html` | View HTML report |
| GET | `/api/reports/{id}/download` | Download report | | GET | `/api/reports/{id}/download` | Download report |
### Config Logs
| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/api/config-logs` | List config logs (filterable by `config_type`, `severity`, `config_id`) |
| DELETE | `/api/config-logs` | Clear config logs (admin, filterable by `config_type`, `config_id`) |
### Admin ### Admin
| Method | Endpoint | Description | | Method | Endpoint | Description |
@@ -431,6 +445,7 @@ oci-cis-agent/
| Version | Date | Changes | | Version | Date | Changes |
|---------|------|---------| |---------|------|---------|
| **v1.3** | 2026-03 | Persistent config logs per tab, GenAI auto-fill from OCI credentials, inline UX feedback with loading spinners, MCP type-switch fix |
| **v1.2** | 2026-03 | RAG pipeline (OCI GenAI embeddings + ADB vector search), dedicated Embeddings tab, CIS report chunking, file upload embedding | | **v1.2** | 2026-03 | RAG pipeline (OCI GenAI embeddings + ADB vector search), dedicated Embeddings tab, CIS report chunking, file upload embedding |
| **v1.1** | 2025-02 | OCI SDK GenAI (exact pattern), OCI Account Explorer, MCP↔ADB linking, full chat parameters | | **v1.1** | 2025-02 | OCI SDK GenAI (exact pattern), OCI Account Explorer, MCP↔ADB linking, full chat parameters |
| **v1.0** | 2025-02 | Initial release: OCI theme, GenAI integration, MCP servers, ADB vector, JWT+MFA+RBAC | | **v1.0** | 2025-02 | Initial release: OCI theme, GenAI integration, MCP servers, ADB vector, JWT+MFA+RBAC |