* feat: Implement multi-tenant architecture with tenant and knowledge base models - Added data models for tenants, knowledge bases, and related configurations. - Introduced role and permission management for users in the multi-tenant system. - Created a service layer for managing tenants and knowledge bases, including CRUD operations. - Developed a tenant-aware instance manager for LightRAG with caching and isolation features. - Added a migration script to transition existing workspace-based deployments to the new multi-tenant architecture. * chore: ignore lightrag/api/webui/assets/ directory * chore: stop tracking lightrag/api/webui/assets (ignore in .gitignore) * feat: Initialize LightRAG Multi-Tenant Stack with PostgreSQL - Added README.md for project overview, setup instructions, and architecture details. - Created docker-compose.yml to define services: PostgreSQL, Redis, LightRAG API, and Web UI. - Introduced env.example for environment variable configuration. - Implemented init-postgres.sql for PostgreSQL schema initialization with multi-tenant support. - Added reproduce_issue.py for testing default tenant access via API. * feat: Enhance TenantSelector and update related components for improved multi-tenant support * feat: Enhance testing capabilities and update documentation - Updated Makefile to include new test commands for various modes (compatibility, isolation, multi-tenant, security, coverage, and dry-run). - Modified API health check endpoint in Makefile to reflect new port configuration. - Updated QUICK_START.md and README.md to reflect changes in service URLs and ports. - Added environment variables for testing modes in env.example. - Introduced run_all_tests.sh script to automate testing across different modes. - Created conftest.py for pytest configuration, including database fixtures and mock services. - Implemented database helper functions for streamlined database operations in tests. - Added test collection hooks to skip tests based on the current MULTITENANT_MODE. * feat: Implement multi-tenant support with demo mode enabled by default - Added multi-tenant configuration to the environment and Docker setup. - Created pre-configured demo tenants (acme-corp and techstart) for testing. - Updated API endpoints to support tenant-specific data access. - Enhanced Makefile commands for better service management and database operations. - Introduced user-tenant membership system with role-based access control. - Added comprehensive documentation for multi-tenant setup and usage. - Fixed issues with document visibility in multi-tenant environments. - Implemented necessary database migrations for user memberships and legacy support. * feat(audit): Add final audit report for multi-tenant implementation - Documented overall assessment, architecture overview, test results, security findings, and recommendations. - Included detailed findings on critical security issues and architectural concerns. fix(security): Implement security fixes based on audit findings - Removed global RAG fallback and enforced strict tenant context. - Configured super-admin access and required user authentication for tenant access. - Cleared localStorage on logout and improved error handling in WebUI. chore(logs): Create task logs for audit and security fixes implementation - Documented actions, decisions, and next steps for both audit and security fixes. - Summarized test results and remaining recommendations. chore(scripts): Enhance development stack management scripts - Added scripts for cleaning, starting, and stopping the development stack. - Improved output messages and ensured graceful shutdown of services. feat(starter): Initialize PostgreSQL with AGE extension support - Created initialization scripts for PostgreSQL extensions including uuid-ossp, vector, and AGE. - Ensured successful installation and verification of extensions. * feat: Implement auto-select for first tenant and KB on initial load in WebUI - Removed WEBUI_INITIAL_STATE_FIX.md as the issue is resolved. - Added useTenantInitialization hook to automatically select the first available tenant and KB on app load. - Integrated the new hook into the Root component of the WebUI. - Updated RetrievalTesting component to ensure a KB is selected before allowing user interaction. - Created end-to-end tests for multi-tenant isolation and real service interactions. - Added scripts for starting, stopping, and cleaning the development stack. - Enhanced API and tenant routes to support tenant-specific pipeline status initialization. - Updated constants for backend URL to reflect the correct port. - Improved error handling and logging in various components. * feat: Add multi-tenant support with enhanced E2E testing scripts and client functionality * update client * Add integration and unit tests for multi-tenant API, models, security, and storage - Implement integration tests for tenant and knowledge base management endpoints in `test_tenant_api_routes.py`. - Create unit tests for tenant isolation, model validation, and role permissions in `test_tenant_models.py`. - Add security tests to enforce role-based permissions and context validation in `test_tenant_security.py`. - Develop tests for tenant-aware storage operations and context isolation in `test_tenant_storage_phase3.py`. * feat(e2e): Implement OpenAI model support and database reset functionality * Add comprehensive test suite for gpt-5-nano compatibility - Introduced tests for parameter normalization, embeddings, and entity extraction. - Implemented direct API testing for gpt-5-nano. - Validated .env configuration loading and OpenAI API connectivity. - Analyzed reasoning token overhead with various token limits. - Documented test procedures and expected outcomes in README files. - Ensured all tests pass for production readiness. * kg(postgres_impl): ensure AGE extension is loaded in session and configure graph initialization * dev: add hybrid dev helper scripts, Makefile, docker-compose.dev-db and local development docs * feat(dev): add dev helper scripts and local development documentation for hybrid setup * feat(multi-tenant): add detailed specifications and logs for multi-tenant improvements, including UX, backend handling, and ingestion pipeline * feat(migration): add generated tenant/kb columns, indexes, triggers; drop unused tables; update schema and docs * test(backward-compat): adapt tests to new StorageNameSpace/TenantService APIs (use concrete dummy storages) * chore: multi-tenant and UX updates — docs, webui, storage, tenant service adjustments * tests: stabilize integration tests + skip external services; fix multi-tenant API behavior and idempotency - gpt5_nano_compatibility: add pytest-asyncio markers, skip when OPENAI key missing, prevent module-level asyncio.run collection, add conftest - Ollama tests: add server availability check and skip markers; avoid pytest collection warnings by renaming helper classes - Graph storage tests: rename interactive test functions to avoid pytest collection - Document & Tenant routes: support external_ids for idempotency; ensure HTTPExceptions are re-raised - LightRAG core: support external_ids in apipeline_enqueue_documents and idempotent logic - Tests updated to match API changes (tenant routes & document routes) - Add logs and scripts for inspection and audit
146 lines
4.7 KiB
Python
146 lines
4.7 KiB
Python
"""Admin management routes for LightRAG API.
|
|
|
|
Provides endpoints for system administration, including tenant creation and listing.
|
|
"""
|
|
|
|
import logging
|
|
from typing import List, Optional
|
|
|
|
from fastapi import APIRouter, Depends, HTTPException, status
|
|
from pydantic import BaseModel
|
|
|
|
from lightrag.services.tenant_service import TenantService
|
|
from lightrag.api.dependencies import get_admin_context
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Request/Response Models
|
|
class TenantCreateRequest(BaseModel):
|
|
name: str
|
|
description: Optional[str] = ""
|
|
metadata: Optional[dict] = None
|
|
|
|
class TenantResponse(BaseModel):
|
|
tenant_id: str
|
|
name: str
|
|
description: str
|
|
created_at: str
|
|
updated_at: str
|
|
num_knowledge_bases: int
|
|
num_documents: int
|
|
storage_used_gb: float
|
|
|
|
class PaginatedTenantResponse(BaseModel):
|
|
"""Paginated response for tenants."""
|
|
items: List[TenantResponse]
|
|
total: int
|
|
page: int
|
|
page_size: int
|
|
total_pages: int
|
|
has_next: bool
|
|
has_prev: bool
|
|
|
|
def create_admin_routes(tenant_service: TenantService) -> APIRouter:
|
|
"""Create admin management routes.
|
|
|
|
Args:
|
|
tenant_service: Service instance for tenant operations
|
|
|
|
Returns:
|
|
APIRouter with admin routes
|
|
"""
|
|
router = APIRouter(prefix="/api/v1/admin", tags=["admin"])
|
|
|
|
@router.post("/tenants", response_model=TenantResponse, status_code=status.HTTP_201_CREATED)
|
|
async def create_tenant(
|
|
request: TenantCreateRequest,
|
|
admin_context: dict = Depends(get_admin_context)
|
|
):
|
|
"""Create a new tenant.
|
|
|
|
Requires admin authentication.
|
|
"""
|
|
try:
|
|
tenant = await tenant_service.create_tenant(
|
|
tenant_name=request.name,
|
|
description=request.description or "",
|
|
)
|
|
return TenantResponse(
|
|
tenant_id=tenant.tenant_id,
|
|
name=tenant.tenant_name,
|
|
description=tenant.description,
|
|
created_at=tenant.created_at.isoformat(),
|
|
updated_at=tenant.updated_at.isoformat(),
|
|
num_knowledge_bases=tenant.kb_count,
|
|
num_documents=tenant.total_documents,
|
|
storage_used_gb=tenant.total_storage_mb / 1024.0,
|
|
)
|
|
except Exception as e:
|
|
logger.error(f"Error creating tenant: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Failed to create tenant"
|
|
)
|
|
|
|
@router.get("/tenants", response_model=PaginatedTenantResponse)
|
|
async def list_tenants(
|
|
page: int = 1,
|
|
page_size: int = 10,
|
|
search: Optional[str] = None,
|
|
admin_context: dict = Depends(get_admin_context)
|
|
):
|
|
"""List all available tenants with pagination.
|
|
|
|
Useful for tenant selection.
|
|
"""
|
|
try:
|
|
# Validate pagination parameters
|
|
page = max(1, page)
|
|
page_size = min(max(1, page_size), 100) # Max 100 per page
|
|
|
|
# Get tenants from service
|
|
tenants_data = await tenant_service.list_tenants(
|
|
skip=(page - 1) * page_size,
|
|
limit=page_size,
|
|
search=search,
|
|
tenant_id_filter=None
|
|
)
|
|
|
|
total_count = tenants_data.get("total", 0)
|
|
tenants_list = tenants_data.get("items", [])
|
|
|
|
# Convert to response models
|
|
items = [
|
|
TenantResponse(
|
|
tenant_id=t.tenant_id,
|
|
name=t.tenant_name,
|
|
description=t.description,
|
|
created_at=t.created_at.isoformat(),
|
|
updated_at=t.updated_at.isoformat(),
|
|
num_knowledge_bases=t.kb_count,
|
|
num_documents=t.total_documents,
|
|
storage_used_gb=t.total_storage_mb / 1024.0,
|
|
)
|
|
for t in tenants_list
|
|
]
|
|
|
|
# Calculate pagination metadata
|
|
total_pages = (total_count + page_size - 1) // page_size
|
|
|
|
return PaginatedTenantResponse(
|
|
items=items,
|
|
total=total_count,
|
|
page=page,
|
|
page_size=page_size,
|
|
total_pages=total_pages,
|
|
has_next=page < total_pages,
|
|
has_prev=page > 1
|
|
)
|
|
except Exception as e:
|
|
logger.error(f"Error listing tenants: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Failed to list tenants"
|
|
)
|
|
|
|
return router
|