OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
OPENSEARCH_NODE_COUNT_CHECK_ENABLED as deafult flag (#1975)
Edwin Jose8a5a757c5981
diff --git a/.env.example b/.env.exampleindex 01e404ed9..97a3f47a4 100644--- a/.env.example+++ b/.env.example@@ -113,6 +113,8 @@ OPENSEARCH_PORT=9200# LANGFLOW_OPENSEARCH_HOST=opensearch# LANGFLOW_OPENSEARCH_PORT=9200OPENSEARCH_USERNAME=admin+# Disable the OpenSearch node-count readiness gate for single-node local setups.+OPENSEARCH_NODE_COUNT_CHECK_ENABLED=false# OpenSearch index name for storing documents# Default: documentsdiff --git a/docker-compose.yml b/docker-compose.ymlindex 4d15fb04d..51a9875b2 100644--- a/docker-compose.yml+++ b/docker-compose.yml@@ -75,7 +75,7 @@ services:- OPENSEARCH_PASSWORD=${OPENSEARCH_PASSWORD}# Single-node compose clusters don't meet the multi-node readiness counts,# so default the node-count check off here (override to re-enable).- - OPENSEARCH_NODE_COUNT_CHECK=${OPENSEARCH_NODE_COUNT_CHECK:-false}+ - OPENSEARCH_NODE_COUNT_CHECK_ENABLED=${OPENSEARCH_NODE_COUNT_CHECK_ENABLED:-false}- OPENAI_API_KEY=${OPENAI_API_KEY}- ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY}- WATSONX_API_KEY=${WATSONX_API_KEY}diff --git a/docs/docs/reference/configuration.mdx b/docs/docs/reference/configuration.mdxindex 7b05b897a..a69bdeb18 100644--- a/docs/docs/reference/configuration.mdx+++ b/docs/docs/reference/configuration.mdx@@ -148,6 +148,7 @@ Configure OpenSearch database authentication.| Variable | Default | Description ||----------|---------|-------------|| `OPENSEARCH_PASSWORD` | Not set | Required. OpenSearch administrator password. Must adhere to the [OpenSearch password complexity requirements](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). You must set this directly in the `.env` or in the terminal's [**Reconfigure**](/install-uvx#setup) option. |+| `OPENSEARCH_NODE_COUNT_CHECK_ENABLED` | `false` in local single-node setups; otherwise `true` | Enables the startup readiness gate that waits for the expected OpenSearch node counts. Keep this `false` for local single-node compose/dev environments. || `OPENSEARCH_INDEX_NAME` | `documents` | The name of the [OpenSearch index](/knowledge#index). || `OPENSEARCH_HOST` | `localhost` | OpenSearch service host. || `OPENSEARCH_PORT` | `9200` | OpenSearch service port. |diff --git a/src/config/settings.py b/src/config/settings.pyindex 8c411414c..5e593fc39 100644--- a/src/config/settings.py+++ b/src/config/settings.py@@ -42,7 +42,7 @@ OPENSEARCH_PASSWORD = os.getenv("OPENSEARCH_PASSWORD")# Gate the OpenSearch node-count readiness check ("OS node_count" flag).# Enabled by default; set to false on small/single-node clusters.OPENSEARCH_NODE_COUNT_CHECK_ENABLED = os.getenv(- "OPENSEARCH_NODE_COUNT_CHECK", "true"+ "OPENSEARCH_NODE_COUNT_CHECK_ENABLED", "true").strip().lower() in ("true", "1", "yes")# Expected cluster size, used only when the node-count check is enabled.diff --git a/tests/unit/config/test_opensearch_node_count_check_enabled.py b/tests/unit/config/test_opensearch_node_count_check_enabled.pynew file mode 100644index 000000000..3e10eb090--- /dev/null+++ b/tests/unit/config/test_opensearch_node_count_check_enabled.py@@ -0,0 +1,37 @@+"""Regression tests for the OpenSearch node-count readiness toggle."""++import os+import subprocess+import sys+from pathlib import Path++ROOT = Path(__file__).resolve().parent.parent.parent.parent+SRC = ROOT / "src"+++def _python_env(env: dict[str, str]) -> dict[str, str]:+ merged = os.environ.copy()+ merged.update(env)+ return merged+++def test_settings_reads_canonical_node_count_env_var():+ env = _python_env(+ {+ "OPENSEARCH_NODE_COUNT_CHECK_ENABLED": "false",+ "PYTHONPATH": str(SRC),+ }+ )+ result = subprocess.run(+ [+ sys.executable,+ "-c",+ "from config import settings; print(settings.OPENSEARCH_NODE_COUNT_CHECK_ENABLED)",+ ],+ capture_output=True,+ text=True,+ check=True,+ env=env,+ cwd=str(ROOT),+ )+ assert result.stdout.splitlines()[-1].strip() == "False"diff --git a/tests/unit/test_opensearch_wait_node_count.py b/tests/unit/test_opensearch_wait_node_count.pyindex c5efbdc0e..850c15136 100644--- a/tests/unit/test_opensearch_wait_node_count.py+++ b/tests/unit/test_opensearch_wait_node_count.py@@ -1,6 +1,6 @@"""The OpenSearch readiness probe (wait_for_opensearch) gates on data-node,-cluster-manager, and coordinating-node counts behind the OPENSEARCH_NODE_COUNT_CHECK-flag.+cluster-manager, and coordinating-node counts behind the+OPENSEARCH_NODE_COUNT_CHECK_ENABLED flag.Cases:* Flag on, all counts met (>= expected): returns without raising.