Implementation:Apache Druid OverlordDynamicConfigDialog
| Knowledge Sources | |
|---|---|
| Domains | Web_Console, Overlord_Configuration |
| Last Updated | 2026-02-10 10:00 GMT |
Overview
OverlordDynamicConfigDialog is a React dialog component that allows editing the Druid Overlord dynamic configuration at runtime with form and JSON editing modes.
Description
The OverlordDynamicConfigDialog component loads the current Overlord dynamic configuration from the /druid/indexer/v1/worker API endpoint and presents it in a SnitchDialog wrapper that provides audit trail functionality. Users can edit the configuration using either an AutoForm with predefined OVERLORD_DYNAMIC_CONFIG_FIELDS or a raw JSON editor with OVERLORD_DYNAMIC_CONFIG_COMPLETIONS for autocomplete. The dialog also loads configuration history for review. On save, it posts the updated config with X-Druid-Author and X-Druid-Comment headers for audit tracking.
Usage
Used from the services or cluster management view when an administrator needs to modify Overlord task assignment strategies, auto-scaling settings, or other dynamic configuration parameters.
Code Reference
Source Location
- Repository: Apache Druid
- File: web-console/src/dialogs/overlord-dynamic-config-dialog/overlord-dynamic-config-dialog.tsx
- Lines: 1-144
Signature
export interface OverlordDynamicConfigDialogProps {
onClose(): void;
}
export const OverlordDynamicConfigDialog = React.memo(function OverlordDynamicConfigDialog(
props: OverlordDynamicConfigDialogProps,
): JSX.Element;
Import
import { OverlordDynamicConfigDialog } from 'web-console/src/dialogs/overlord-dynamic-config-dialog/overlord-dynamic-config-dialog';
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| onClose | () => void | Yes | Callback invoked when the dialog is closed (after save or cancel) |
Outputs
| Name | Type | Description |
|---|---|---|
| rendered dialog | JSX.Element | A SnitchDialog wrapping a form/JSON editor for the Overlord dynamic config, with history viewing capability and audit comment on save |
Usage Examples
Opening the Config Dialog
<OverlordDynamicConfigDialog
onClose={() => setShowOverlordConfig(false)}
/>