Skip to content

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

Python

parametrize opensearch index name (#914)

ming392657fd6d2f
diff --git a/.env.example b/.env.example
index 45183b60e..b97e01f18 100644
--- a/.env.example
+++ b/.env.example
@@ -32,6 +32,11 @@ OPENSEARCH_PASSWORD=
# Default: ./opensearch-data
OPENSEARCH_DATA_PATH=./opensearch-data
+# OpenSearch index name for storing documents
+# Default: documents
+# Change this if you want to use a different index name or avoid conflicts
+OPENSEARCH_INDEX_NAME=documents
+
# make here https://console.cloud.google.com/apis/credentials
GOOGLE_OAUTH_CLIENT_ID=
GOOGLE_OAUTH_CLIENT_SECRET=
diff --git a/docker-compose.yml b/docker-compose.yml
index fc11fe550..97ed46bc8 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -79,6 +79,7 @@ services:
- WEBHOOK_BASE_URL=${WEBHOOK_BASE_URL}
- AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
- AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+ - OPENSEARCH_INDEX_NAME=${OPENSEARCH_INDEX_NAME:-documents}
volumes:
- ${OPENRAG_DOCUMENTS_PATH:-./openrag-documents}:/app/openrag-documents:Z
- ${OPENRAG_KEYS_PATH:-./keys}:/app/keys:U,z
@@ -133,12 +134,13 @@ services:
- OPENSEARCH_HOST=${OPENSEARCH_HOST:-opensearch}
- OPENSEARCH_PORT=${OPENSEARCH_PORT:-9200}
- OPENSEARCH_URL=https://${OPENSEARCH_HOST:-opensearch}:${OPENSEARCH_PORT:-9200}
+ - OPENSEARCH_INDEX_NAME=${OPENSEARCH_INDEX_NAME:-documents}
- DOCLING_SERVE_URL=${DOCLING_SERVE_URL:-http://host.docker.internal:5001}
- FILENAME=None
- MIMETYPE=None
- FILESIZE=0
- SELECTED_EMBEDDING_MODEL=${SELECTED_EMBEDDING_MODEL:-}
- - LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT=JWT,OPENRAG-QUERY-FILTER,OPENSEARCH_PASSWORD,OPENSEARCH_URL,DOCLING_SERVE_URL,OWNER,OWNER_NAME,OWNER_EMAIL,CONNECTOR_TYPE,FILENAME,MIMETYPE,FILESIZE,SELECTED_EMBEDDING_MODEL,OPENAI_API_KEY,ANTHROPIC_API_KEY,WATSONX_API_KEY,WATSONX_ENDPOINT,WATSONX_PROJECT_ID,OLLAMA_BASE_URL
+ - LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT=JWT,OPENRAG-QUERY-FILTER,OPENSEARCH_PASSWORD,OPENSEARCH_URL,OPENSEARCH_INDEX_NAME,DOCLING_SERVE_URL,OWNER,OWNER_NAME,OWNER_EMAIL,CONNECTOR_TYPE,FILENAME,MIMETYPE,FILESIZE,SELECTED_EMBEDDING_MODEL,OPENAI_API_KEY,ANTHROPIC_API_KEY,WATSONX_API_KEY,WATSONX_ENDPOINT,WATSONX_PROJECT_ID,OLLAMA_BASE_URL
- LANGFLOW_LOG_LEVEL=DEBUG
- LANGFLOW_AUTO_LOGIN=${LANGFLOW_AUTO_LOGIN}
- LANGFLOW_SUPERUSER=${LANGFLOW_SUPERUSER}
diff --git a/flows/ingestion_flow.json b/flows/ingestion_flow.json
index 6f65c04e0..6893bede6 100644
--- a/flows/ingestion_flow.json
+++ b/flows/ingestion_flow.json
@@ -3805,7 +3805,7 @@
"info": "The OpenSearch index name where documents will be stored and searched. Will be created automatically if it doesn't exist.",
"list": false,
"list_add_label": "Add More",
- "load_from_db": false,
+ "load_from_db": true,
"name": "index_name",
"override_skip": false,
"placeholder": "",
@@ -3816,7 +3816,7 @@
"trace_as_metadata": true,
"track_in_telemetry": false,
"type": "str",
- "value": "documents"
+ "value": "OPENSEARCH_INDEX_NAME"
},
"ingest_data": {
"_input_type": "HandleInput",
diff --git a/flows/openrag_agent.json b/flows/openrag_agent.json
index f04405ebe..bf40c40a0 100644
--- a/flows/openrag_agent.json
+++ b/flows/openrag_agent.json
@@ -3082,7 +3082,7 @@
"info": "The OpenSearch index name where documents will be stored and searched. Will be created automatically if it doesn't exist.",
"list": false,
"list_add_label": "Add More",
- "load_from_db": false,
+ "load_from_db": true,
"name": "index_name",
"override_skip": false,
"placeholder": "",
@@ -3093,7 +3093,7 @@
"trace_as_metadata": true,
"track_in_telemetry": false,
"type": "str",
- "value": "documents"
+ "value": "OPENSEARCH_INDEX_NAME"
},
"ingest_data": {
"_input_type": "HandleInput",
@@ -4792,4 +4792,4 @@
"assistants",
"agents"
]
-}
+}
\ No newline at end of file
diff --git a/flows/openrag_nudges.json b/flows/openrag_nudges.json
index 7ab4ae917..e78861db9 100644
--- a/flows/openrag_nudges.json
+++ b/flows/openrag_nudges.json
@@ -2691,7 +2691,7 @@
"info": "The OpenSearch index name where documents will be stored and searched. Will be created automatically if it doesn't exist.",
"list": false,
"list_add_label": "Add More",
- "load_from_db": false,
+ "load_from_db": true,
"name": "index_name",
"override_skip": false,
"placeholder": "",
@@ -2702,7 +2702,7 @@
"trace_as_metadata": true,
"track_in_telemetry": false,
"type": "str",
- "value": "documents"
+ "value": "OPENSEARCH_INDEX_NAME"
},
"ingest_data": {
"_input_type": "HandleInput",
@@ -4119,4 +4119,4 @@
"assistants",
"agents"
]
-}
+}
\ No newline at end of file
diff --git a/flows/openrag_url_mcp.json b/flows/openrag_url_mcp.json
index caf9a0f72..867a997ba 100644
--- a/flows/openrag_url_mcp.json
+++ b/flows/openrag_url_mcp.json
@@ -3981,7 +3981,7 @@
"info": "The OpenSearch index name where documents will be stored and searched. Will be created automatically if it doesn't exist.",
"list": false,
"list_add_label": "Add More",
- "load_from_db": false,
+ "load_from_db": true,
"name": "index_name",
"override_skip": false,
"placeholder": "",
@@ -3992,7 +3992,7 @@
"trace_as_metadata": true,
"track_in_telemetry": false,
"type": "str",
- "value": "documents"
+ "value": "OPENSEARCH_INDEX_NAME"
},
"ingest_data": {
"_input_type": "HandleInput",
diff --git a/helm/openrag/templates/backend/deployment.yaml b/helm/openrag/templates/backend/deployment.yaml
index aa6077ba8..4a1e2a1a6 100644
--- a/helm/openrag/templates/backend/deployment.yaml
+++ b/helm/openrag/templates/backend/deployment.yaml
@@ -74,6 +74,8 @@ spec:
name: {{ include "openrag.fullname" . }}-opensearch
key: password
{{- end }}
+ - name: OPENSEARCH_INDEX_NAME
+ value: {{ .Values.global.opensearch.indexName | quote }}
# Langflow connection
- name: LANGFLOW_URL
value: {{ include "openrag.langflow.url" . | quote }}
diff --git a/helm/openrag/templates/langflow/deployment.yaml b/helm/openrag/templates/langflow/deployment.yaml
index 2683011f4..4f36d4455 100644
--- a/helm/openrag/templates/langflow/deployment.yaml
+++ b/helm/openrag/templates/langflow/deployment.yaml
@@ -77,6 +77,19 @@ spec:
value: {{ .Values.langflow.logLevel | quote }}
- name: HIDE_GETTING_STARTED_PROGRESS
value: "true"
+ # Langflow Tracking (Langfuse)
+ - name: LANGFUSE_SECRET_KEY
+ valueFrom:
+ secretKeyRef:
+ name: {{ include "openrag.fullname" . }}-langflow
+ key: langfuse-secret-key
+ - name: LANGFUSE_PUBLIC_KEY
+ valueFrom:
+ secretKeyRef:
+ name: {{ include "openrag.fullname" . }}-langflow
+ key: langfuse-public-key
+ - name: LANGFUSE_HOST
+ value: {{ .Values.langflow.langfuse.host | quote }}
# Auth settings
- name: LANGFLOW_AUTO_LOGIN
value: {{ .Values.langflow.auth.autoLogin | quote }}
@@ -101,7 +114,7 @@ spec:
- name: CONNECTOR_TYPE_URL
value: "url"
- name: OPENRAG-QUERY-FILTER
- value: "{}"
+ value: {{ .Values.langflow.openragQueryFilter | quote }}
- name: FILENAME
value: "None"
- name: MIMETYPE
@@ -133,9 +146,11 @@ spec:
value: {{ .Values.global.opensearch.port | quote }}
- name: OPENSEARCH_URL
value: {{ include "openrag.opensearch.url" . | quote }}
+ - name: OPENSEARCH_INDEX_NAME
+ value: {{ .Values.global.opensearch.indexName | quote }}
# Docling service URL (for document processing in flows)
- name: DOCLING_SERVE_URL
- value: "http://host.docker.internal:5001"
+ value: {{ .Values.langflow.doclingServeUrl | quote }}
{{- if .Values.global.opensearch.password }}
- name: OPENSEARCH_PASSWORD
valueFrom:
diff --git a/helm/openrag/templates/secrets/langflow-secret.yaml b/helm/openrag/templates/secrets/langflow-secret.yaml
index e43e07b18..4ecdcd18a 100644
--- a/helm/openrag/templates/secrets/langflow-secret.yaml
+++ b/helm/openrag/templates/secrets/langflow-secret.yaml
@@ -11,4 +11,6 @@ stringData:
secret-key: {{ .Values.langflow.auth.secretKey | default (randAlphaNum 32) | quote }}
superuser: {{ .Values.langflow.auth.superuser | quote }}
superuser-password: {{ .Values.langflow.auth.superuserPassword | default (randAlphaNum 16) | quote }}
+ langfuse-public-key: {{ .Values.langflow.langfuse.publicKey | quote }}
+ langfuse-secret-key: {{ .Values.langflow.langfuse.secretKey | quote }}
{{- end }}
diff --git a/helm/openrag/values.yaml b/helm/openrag/values.yaml
index fbf0707a3..aa46870aa 100644
--- a/helm/openrag/values.yaml
+++ b/helm/openrag/values.yaml
@@ -25,6 +25,7 @@ global:
scheme: "https" # https for production SaaS
username: "admin" # OpenSearch username
password: "" # OpenSearch password (stored in secret)
+ indexName: "documents" # OpenSearch index name
# Shared OAuth credentials (same across all tenants)
oauth:
@@ -90,9 +91,17 @@ langflow:
# Runtime settings
deactivateTracing: true
logLevel: "INFO" # DEBUG, INFO, WARNING, ERROR
+ doclingServeUrl: "http://host.docker.internal:5001"
+ openragQueryFilter: "{}"
+
+ # Langfuse Tracking
+ langfuse:
+ secretKey: ""
+ publicKey: ""
+ host: "https://cloud.langfuse.com"
# Variables to expose to flows
- variablesToGetFromEnvironment: "JWT,OPENRAG-QUERY-FILTER,OPENSEARCH_PASSWORD,OPENSEARCH_URL,DOCLING_SERVE_URL,OWNER,OWNER_NAME,OWNER_EMAIL,CONNECTOR_TYPE,FILENAME,MIMETYPE,FILESIZE,SELECTED_EMBEDDING_MODEL,OPENAI_API_KEY,ANTHROPIC_API_KEY,WATSONX_API_KEY,WATSONX_ENDPOINT,WATSONX_PROJECT_ID,OLLAMA_BASE_URL"
+ variablesToGetFromEnvironment: "JWT,OPENRAG-QUERY-FILTER,OPENSEARCH_PASSWORD,OPENSEARCH_URL,OPENSEARCH_INDEX_NAME,DOCLING_SERVE_URL,OWNER,OWNER_NAME,OWNER_EMAIL,CONNECTOR_TYPE,FILENAME,MIMETYPE,FILESIZE,SELECTED_EMBEDDING_MODEL,OPENAI_API_KEY,ANTHROPIC_API_KEY,WATSONX_API_KEY,WATSONX_ENDPOINT,WATSONX_PROJECT_ID,OLLAMA_BASE_URL"
# Probes
livenessProbe:
diff --git a/src/config/settings.py b/src/config/settings.py
index 78cf03a65..a8e9433ad 100644
--- a/src/config/settings.py
+++ b/src/config/settings.py
@@ -78,7 +78,7 @@ WEBHOOK_BASE_URL = os.getenv(
) # No default - must be explicitly configured
# OpenSearch configuration
-INDEX_NAME = "documents"
+INDEX_NAME = os.getenv("OPENSEARCH_INDEX_NAME", "documents")
VECTOR_DIM = 1536
EMBED_MODEL = "text-embedding-3-small"
diff --git a/src/tui/managers/env_manager.py b/src/tui/managers/env_manager.py
index f869e257d..bd0b05a4f 100644
--- a/src/tui/managers/env_manager.py
+++ b/src/tui/managers/env_manager.py
@@ -29,6 +29,7 @@ class EnvConfig:
# Core settings
openai_api_key: str = ""
opensearch_password: str = ""
+ opensearch_index_name: str = "documents"
langflow_secret_key: str = ""
langflow_superuser: str = "admin"
langflow_superuser_password: str = ""
@@ -169,6 +170,7 @@ class EnvManager:
"WATSONX_ENDPOINT": "watsonx_endpoint",
"WATSONX_PROJECT_ID": "watsonx_project_id",
"OPENSEARCH_PASSWORD": "opensearch_password", # pragma: allowlist secret
+ "OPENSEARCH_INDEX_NAME": "opensearch_index_name",
"LANGFLOW_SECRET_KEY": "langflow_secret_key", # pragma: allowlist secret
"LANGFLOW_SUPERUSER": "langflow_superuser",
"LANGFLOW_SUPERUSER_PASSWORD": "langflow_superuser_password", # pragma: allowlist secret
@@ -386,6 +388,7 @@ class EnvManager:
f.write(f"LANGFLOW_URL_INGEST_FLOW_ID={self._quote_env_value(self.config.langflow_url_ingest_flow_id)}\n")
f.write(f"NUDGES_FLOW_ID={self._quote_env_value(self.config.nudges_flow_id)}\n")
f.write(f"OPENSEARCH_PASSWORD={self._quote_env_value(self.config.opensearch_password)}\n")
+ f.write(f"OPENSEARCH_INDEX_NAME={self._quote_env_value(self.config.opensearch_index_name)}\n")
# Expand $HOME in paths before writing to .env
# This ensures paths work with all compose implementations (docker, podman)
@@ -597,6 +600,12 @@ class EnvManager:
"False",
False,
),
+ (
+ "opensearch_index_name",
+ "OpenSearch Index Name",
+ "documents",
+ False,
+ ),
(
"webhook_base_url",
"Webhook Base URL (optional)",
diff --git a/src/tui/screens/config.py b/src/tui/screens/config.py
index 6852b4801..e62004f59 100644
--- a/src/tui/screens/config.py
+++ b/src/tui/screens/config.py
@@ -614,6 +614,22 @@ class ConfigScreen(Screen):
self.inputs["opensearch_data_path"] = input_widget
yield Static(" ")
+ # OpenSearch Index Name
+ yield Label("OpenSearch Index Name")
+ yield Static(
+ "Name of the index to use in OpenSearch",
+ classes="helper-text",
+ )
+ current_value = getattr(self.env_manager.config, "opensearch_index_name", "documents")
+ input_widget = Input(
+ placeholder="documents",
+ value=current_value,
+ id="input-opensearch_index_name",
+ )
+ yield input_widget
+ self.inputs["opensearch_index_name"] = input_widget
+ yield Static(" ")
+
# Langflow Auth Settings - These are automatically configured based on password presence
# Not shown in UI; set in env_manager.setup_secure_defaults()