Skip to main content

Configuration documentation coverage

This page tracks the current state of DIAL configuration documentation — what is fully covered, what has known gaps, and what is planned. It exists to prevent readers from searching for documentation that does not yet exist.

Fully documented​

These configuration areas have dedicated reference pages with verified settings, working examples, and Docker Compose context:

TopicPageSource verified against
DIAL Core configuration model (config files, platform bucket, merge, reload)How DIAL Core is configuredepam/ai-dial-core development docs and README, config-store spec
DIAL Core Configuration API (CRUD, validate, apply, migrate, health, export)Configuration APIconfig-store spec, admin system export doc
DIAL Core static settings (12 groups, including Code Interpreter, analytics, tracing, background jobs)Static settingsepam/ai-dial-core development docs and README, bundled aidial.settings.json
DIAL Core logginggflog.xmldial-docker-compose/settings/gflog.xml
DIAL Core models, interfaces, features, pricingModelsepam/ai-dial-core development docs and README
DIAL Core load balancing (upstreams, tiers, weights, retries)Load balancing and upstreamsepam/ai-dial-core development docs and README, deployment-origin spec
DIAL Core translatorsTranslatorsepam/ai-dial-core development docs and README
DIAL Core applications and application type schemasApplications, Application type schemasepam/ai-dial-core development docs and README, application type meta-schema
DIAL Core interceptors, routes, toolsetsInterceptors, Routes, Toolsetsepam/ai-dial-core development docs and README
DIAL Core roles, keys, global settingsRoles, Keys, Global settingsepam/ai-dial-core development docs and README
DIAL Core catalog schemasCatalog schemasCatalog meta-schema, config-store spec
DIAL Chat 1.x environment variables (server, authentication, features, generation, limits, CSP, observability)How DIAL Chat is configuredepam/ai-dial-chat development README, apps/chat-api README and .env.template
DIAL Chat Overlay (Chat settings, @epam/ai-dial-chat-overlay options, methods, events, feature keys)Chat Overlaylibs/chat-overlay README, Chat Overlay Migration Guide
DIAL Chat Themes (service, config.json format, color tokens, custom theme)DIAL Chat Themesepam/ai-dial-chat-themes README and image, DIAL Chat Theme Customization guide
DIAL Model Provider (served paths, process settings, shared variables, migration with interfaces)DIAL Model Providerepam/ai-dial-model-provider 0.1.0-rc.0 README, Dockerfile, entrypoint scripts, and sources; DIAL Core 0.49.4 routing sources
DIAL OpenAI Adapter (upstreams, Responses API, embeddings, capabilities, environment variables)DIAL OpenAI Adapterepam/ai-dial-adapter-openai development README
DIAL Bedrock Adapter (supported models, Claude clients, guardrails, caching, session tags, translator)DIAL Bedrock Adapterepam/ai-dial-adapter-bedrock development README
DIAL Vertex AI Adapter (supported models, thinking, grounding, caching, regions, authentication)DIAL Vertex AI Adapterepam/ai-dial-adapter-vertexai development README
Auth Helper (application.yaml, API endpoints, Keycloak prerequisites)Auth Helper configurationepam/ai-dial-auth-helper README
Admin Frontend environment variables and administrator accessDIAL Admin configurationAdvanced setup sample and frontend source
Optional Admin Backend environment variablesAdmin Backend configurationdial-docker-compose-advanced/dial-2.x/docker-compose-base.yml
DIAL Analytics (databases, ingestion, queries, pipelines, security, and telemetry)DIAL Analytics configurationAnalytics 0.23.0-rc.1 configuration and source, prerelease
DIAL Analytics Enrichment Runner (upstreams, scheduler, workers, budgets, security, and telemetry)Enrichment Runner configurationRunner 0.23.0-rc.1 configuration and source, prerelease
DIAL Log Parser (CLI, environment variables, storage, output schema, and reruns)DIAL Log Parser configurationLog Parser 0.3.0 command and writer
DIAL Scheduler (API and worker environment, database authentication, application registration, offline delegation, and Chat integration)DIAL Scheduler configurationScheduler settings and deployment sources
Deployment Manager Backend and MCP proxy imagesDIAL Deployment Manager configurationBackend 0.22.0 configuration and source, MCP proxy 0.1.0 Dockerfiles
DIAL Helm chart values, dependencies, and release migrationsDIAL HelmPublished chart metadata, values, templates, and release notes
DIAL OpenAPI to MCP (environment variables, application type registration, application properties, external-service credentials)DIAL OpenAPI to MCP configurationBridge 0.2.1 source and docs, DIAL Core 0.49.4 MCP proxy source
DIAL Generic RAG (backend and frontend environment variables, application type registration, channel configuration)DIAL Generic RAG configurationBackend 0.3.3 source, Frontend 0.1.0 source
DIAL App Controller (Kubernetes clients, registry, image builds, Knative deployment, and session pods)App Controller configurationController 0.5.1 configuration and source, Core 0.49.4 controller client
DIAL App Builder Python (source downloads, templates, requirements, and package validation)App Builder Python configurationBuilder 0.1.0 source, image, and template
DIAL Code Interpreter (environment variables, Core session lifecycle, and Quick Apps calculation tool)Code Interpreter configurationInterpreter 0.2.0, Core 0.49.4, Quick Apps Backend 0.13.2
DIAL Deep Research (backend environment, Core registration, MCP sources, research limits, report structure, and client rules)Deep Research configurationBackend 0.4.0 settings, property models, and registration templates
Keycloak realm configurationrealm-config.jsondial-docker-compose-advanced/dial-2.x/keycloak/import/realm-config.json
Docker Compose deployment filesDocker Composedial-docker-compose/ and dial-docker-compose-advanced/dial-2.x/
Publications feature enablement (Core access rules, Chat feature flags)Enable publicationsepam/ai-dial-chat README
DIAL-to-DIAL Adapter (local development against a remote DIAL Core)Use the DIAL-to-DIAL adapter for local developmentepam/ai-dial-adapter-dial

Partially documented​

These areas are covered but have known gaps:

TopicWhat existsWhat is missing
Interceptors configurationInterceptor registration documented in DIAL Core dynamic settings.SDK-side configuration for building interceptors is a developer topic, covered under Building with DIAL rather than here.
OpenAI Adapter advanced featuresEnv vars and basic upstream examples documented.Detailed operational guides for: configurable models (DALL-E parameters, Responses API reasoning configuration), tokenization algorithms, and API versioning strategies.
Secrets management patternsManage secrets covers Kubernetes Secrets and the Secrets Store CSI driver, with a complete Azure Key Vault example and short steps for AWS Secrets Manager and Google Secret Manager.HashiCorp Vault integration, and complete examples for AWS Secrets Manager and Google Secret Manager.
DIAL Core budgets and org unitsspendingLimits modes and orgUnits.enabled are documented in Global settings and Access.The fields of budget policies and policy assignments, and the org units API (preview). The DIAL Core documentation does not describe them yet.

Not yet documented​

These configuration areas are planned but do not have pages yet:

TopicPlanned locationBlocking on
Multi-environment strategiesOperating DIAL > Production ReadinessPatterns for managing dev/staging/prod configuration drift

How this page is maintained​

This page is updated each time configuration documentation is added or revised. The last_verified date in each reference page's frontmatter indicates when its content was last cross-checked against the source repository.

Further reading​