Skip to content

README.md

Latest commit

 

History

History
90 lines (77 loc) · 5.08 KB

README.md

File metadata and controls

90 lines (77 loc) · 5.08 KB
Raw

Open Data Hub OGX Distribution Image

This image contains the official Open Data Hub OGX distribution, with all the packages and configuration needed to run an OGX server in a containerized environment.

The image is currently shipping with the Open Data Hub version of OGX version 1.2.2+rhaiv.0

You can see an overview of the APIs and Providers the image ships with in the table below.

API Provider External? Enabled by default? How to enable
batches inline::reference No ✅ N/A
file_processors inline::auto No ✅ N/A
file_processors inline::docling No Dependency only* Requires a custom config.yaml
file_processors inline::markitdown No Dependency only* Requires a custom config.yaml
file_processors inline::pypdf No Dependency only* Requires a custom config.yaml
file_processors remote::docling-serve No Dependency only* Requires a custom config.yaml
files inline::localfs No ✅ N/A
files remote::s3 No ❌ Set the ENABLE_S3 environment variable
inference inline::sentence-transformers No Dependency only* Requires a custom config.yaml
inference remote::anthropic No ❌ Set the ANTHROPIC_API_KEY environment variable
inference remote::azure No ❌ Set the AZURE_API_KEY environment variable
inference remote::bedrock No ❌ Set the ENABLE_BEDROCK environment variable
inference remote::gemini No ❌ Set the ENABLE_GEMINI environment variable
inference remote::openai No ❌ Set the OPENAI_API_KEY environment variable
inference remote::vertexai No ❌ Set the VERTEX_AI_PROJECT environment variable
inference remote::vllm No ❌ Set the VLLM_URL environment variable
inference remote::vllm No ❌ Set the VLLM_EMBEDDING_URL environment variable
inference remote::watsonx No ❌ Set the WATSONX_API_KEY environment variable
messages inline::builtin No ✅ N/A
responses inline::builtin No ✅ N/A
tool_runtime inline::file-search No ✅ N/A
tool_runtime remote::brave-search No ❌ Set the BRAVE_SEARCH_API_KEY environment variable
tool_runtime remote::model-context-protocol No ✅ N/A
tool_runtime remote::tavily-search No ❌ Set the TAVILY_SEARCH_API_KEY environment variable
vector_io inline::faiss No Dependency only* Requires a custom config.yaml
vector_io inline::milvus No Dependency only* Requires a custom config.yaml. Incompatible with multi-worker deployments
vector_io remote::milvus No ❌ Set the MILVUS_ENDPOINT environment variable
vector_io remote::pgvector No ❌ Set the ENABLE_PGVECTOR environment variable
vector_io remote::qdrant No ❌ Set the ENABLE_QDRANT environment variable

* Dependency only providers are not included in the default runtime config.yaml but their dependencies are pre-installed in the container image. To use them, pass a custom config.yaml at runtime that includes the provider definitions.

Mounting Secrets as Files

Instead of passing secrets directly as environment variables (which exposes them in /proc/1/environ and subprocess environments), you can mount them as files and point to them with _FILE-suffixed variables. At container startup, the entrypoint reads each file and populates the corresponding environment variable.

For example, to inject OPENAI_API_KEY from a mounted Kubernetes Secret:

env:
  - name: OPENAI_API_KEY_FILE
    value: /run/secrets/openai-api-key
volumeMounts:
  - name: openai-secret
    mountPath: /run/secrets/openai-api-key
    subPath: api-key
    readOnly: true
volumes:
  - name: openai-secret
    secret:
      secretName: openai-credentials

Setting both the base variable and its _FILE variant is an error (mutually exclusive).

Supported variables

  • ANTHROPIC_API_KEY → ANTHROPIC_API_KEY_FILE
  • AWS_ACCESS_KEY_ID → AWS_ACCESS_KEY_ID_FILE
  • AWS_BEDROCK_BEARER_TOKEN → AWS_BEDROCK_BEARER_TOKEN_FILE
  • AWS_SECRET_ACCESS_KEY → AWS_SECRET_ACCESS_KEY_FILE
  • AZURE_API_KEY → AZURE_API_KEY_FILE
  • BRAVE_SEARCH_API_KEY → BRAVE_SEARCH_API_KEY_FILE
  • DOCLING_SERVE_API_KEY → DOCLING_SERVE_API_KEY_FILE
  • GEMINI_ACCESS_TOKEN → GEMINI_ACCESS_TOKEN_FILE
  • GEMINI_API_KEY → GEMINI_API_KEY_FILE
  • MILVUS_TOKEN → MILVUS_TOKEN_FILE
  • OPENAI_API_KEY → OPENAI_API_KEY_FILE
  • PGVECTOR_PASSWORD → PGVECTOR_PASSWORD_FILE
  • POSTGRES_PASSWORD → POSTGRES_PASSWORD_FILE
  • QDRANT_API_KEY → QDRANT_API_KEY_FILE
  • TAVILY_SEARCH_API_KEY → TAVILY_SEARCH_API_KEY_FILE
  • VLLM_API_TOKEN → VLLM_API_TOKEN_FILE
  • VLLM_EMBEDDING_API_TOKEN → VLLM_EMBEDDING_API_TOKEN_FILE
  • WATSONX_API_KEY → WATSONX_API_KEY_FILE