Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python

add upgrade-triggered OpenRAG docs reingestion tracking

Olfa Maslahaa6e2e2c388e
diff --git a/src/api/settings.py b/src/api/settings.py
index 4058805d7..5e6329887 100644
--- a/src/api/settings.py
+++ b/src/api/settings.py
@@ -6,6 +6,7 @@ from pydantic import BaseModel, Field
from utils.container_utils import transform_localhost_url
from utils.logging_config import get_logger
from utils.telemetry import TelemetryClient, Category, MessageId
+from utils.version_utils import OPENRAG_VERSION
from config.settings import (
DISABLE_INGEST_WITH_LANGFLOW,
INGEST_SAMPLE_DATA,
@@ -84,6 +85,7 @@ class OnboardingStateBody(BaseModel):
upload_steps: Optional[Dict[str, Any]] = None
openrag_docs_filter_id: Optional[str] = None
user_doc_filter_id: Optional[str] = None
+ openrag_docs_ingested_version: Optional[str] = None
class DoclingPresetBody(BaseModel):
@@ -101,6 +103,7 @@ class OnboardingStateConfig(BaseModel):
upload_steps: Optional[Dict[str, Any]]
openrag_docs_filter_id: Optional[str]
user_doc_filter_id: Optional[str]
+ openrag_docs_ingested_version: Optional[str]
class OpenAIProviderConfig(BaseModel):
has_api_key: bool
@@ -311,6 +314,7 @@ async def get_settings(
upload_steps=openrag_config.onboarding.upload_steps,
openrag_docs_filter_id=openrag_config.onboarding.openrag_docs_filter_id,
user_doc_filter_id=openrag_config.onboarding.user_doc_filter_id,
+ openrag_docs_ingested_version=openrag_config.onboarding.openrag_docs_ingested_version,
),
providers=ProvidersConfig(
openai=OpenAIProviderConfig(
@@ -1010,6 +1014,7 @@ async def onboarding(
langflow_file_service,
session_manager,
)
+ current_config.onboarding.openrag_docs_ingested_version = OPENRAG_VERSION
logger.info("Sample data ingestion completed successfully")
except Exception as e:
@@ -1516,6 +1521,7 @@ async def rollback_onboarding(
# Clear embedding provider and model settings
current_config.knowledge.embedding_provider = "openai" # Reset to default
current_config.knowledge.embedding_model = ""
+ current_config.onboarding.openrag_docs_ingested_version = None
# Mark config as not edited so user can go through onboarding again
current_config.edited = False
diff --git a/src/config/config_manager.py b/src/config/config_manager.py
index 8b3bb38b8..67cbd58d2 100644
--- a/src/config/config_manager.py
+++ b/src/config/config_manager.py
@@ -97,6 +97,7 @@ class OnboardingState:
upload_steps: Optional[Dict[str, Any]] = field(default=None)
openrag_docs_filter_id: Optional[str] = field(default=None)
user_doc_filter_id: Optional[str] = field(default=None)
+ openrag_docs_ingested_version: Optional[str] = field(default=None)
@dataclass
diff --git a/src/main.py b/src/main.py
index fe752f659..1c67fdaf8 100644
--- a/src/main.py
+++ b/src/main.py
@@ -55,6 +55,7 @@ from config.settings import (
LANGFLOW_URL_INGEST_FLOW_ID,
SESSION_SECRET,
clients,
+ config_manager,
get_embedding_model,
get_index_name,
is_no_auth_mode,
@@ -515,6 +516,89 @@ async def _ingest_default_documents_url(session_manager, docs_url: str, crawl_de
)
resp.raise_for_status()
+
+async def _delete_existing_default_docs(session_manager):
+ """Delete previously ingested default OpenRAG docs before reingestion."""
+ from session_manager import AnonymousUser
+
+ if session_manager is None:
+ logger.warning(
+ "Session manager unavailable; skipping default docs cleanup before reingestion"
+ )
+ return
+
+ anonymous_user = AnonymousUser()
+ effective_jwt = None
+ if session_manager:
+ session_manager.get_user_opensearch_client(anonymous_user.user_id, effective_jwt)
+ if hasattr(session_manager, "_anonymous_jwt"):
+ effective_jwt = session_manager._anonymous_jwt
+
+ opensearch_client = session_manager.get_user_opensearch_client(
+ anonymous_user.user_id, effective_jwt
+ )
+ delete_query = {
+ "query": {
+ "bool": {
+ "must": [
+ {"term": {"connector_type": "system_default"}},
+ {"term": {"owner_email": anonymous_user.email}},
+ ]
+ }
+ }
+ }
+ result = await opensearch_client.delete_by_query(
+ index=get_index_name(),
+ body=delete_query,
+ conflicts="proceed",
+ )
+ logger.info(
+ "Deleted existing default OpenRAG docs before reingestion",
+ deleted_chunks=result.get("deleted", 0),
+ )
+
+
+async def _reingest_default_docs_on_upgrade_if_needed(
+ document_service,
+ task_service,
+ langflow_file_service,
+ session_manager,
+):
+ """Reingest default OpenRAG docs once when app version changes."""
+ config = get_openrag_config()
+
+ previous_version = config.onboarding.openrag_docs_ingested_version
+ current_version = OPENRAG_VERSION
+ should_reingest = bool(previous_version) and previous_version != current_version
+
+ # Legacy installs may not have a stored docs ingestion version.
+ # Use the presence of the OpenRAG docs filter as the signal that docs were
+ # already onboarded, independent of whether config.edited is set.
+ if not previous_version and config.onboarding.openrag_docs_filter_id:
+ should_reingest = True
+
+ if not should_reingest:
+ return
+
+ logger.info(
+ "Detected OpenRAG upgrade; reingesting default docs",
+ previous_version=previous_version,
+ current_version=current_version,
+ )
+ await _delete_existing_default_docs(session_manager)
+ await ingest_default_documents_when_ready(
+ document_service,
+ task_service,
+ langflow_file_service,
+ session_manager,
+ )
+ config.onboarding.openrag_docs_ingested_version = current_version
+ if not config_manager.save_config_file(config):
+ logger.warning(
+ "Default docs were reingested but failed to persist ingested version",
+ current_version=current_version,
+ )
+
async def health_check(request: Request):
"""Simple liveness probe: Indicates that the OpenRAG Backend service is online and running."""
return JSONResponse({"status": "ok"}, status_code=200)
@@ -660,6 +744,17 @@ async def startup_tasks(services):
# Configure alerting security
await configure_alerting_security()
+ # Reingest bundled OpenRAG docs once after application upgrade.
+ try:
+ await _reingest_default_docs_on_upgrade_if_needed(
+ services["document_service"],
+ services["task_service"],
+ services["langflow_file_service"],
+ services["session_manager"],
+ )
+ except Exception as e:
+ logger.warning("Default docs reingestion on upgrade failed", error=str(e))
+
# Update MCP servers with provider credentials (especially important for no-auth mode)
await _update_mcp_servers_with_provider_credentials(services)