config_schema.json

{
  "fields": [
    {
      "name": "log-level",
      "description": "The log level: debug, info, warn, error",
      "isOps": true,
      "stringField": {
        "defaultValue": "info"
      }
    },
    {
      "name": "log-level-debug-expires-at",
      "description": "The timestamp indicating when debug-level logging should expire",
      "isOps": true,
      "stringField": {}
    },
    {
      "name": "session-store-maximum-size",
      "description": "The maximum size of the local in-memory session store cache in bytes.",
      "isOps": true,
      "intField": {
        "defaultValue": "15728640"
      }
    },
    {
      "name": "otel-collector-endpoint",
      "description": "The endpoint of the OpenTelemetry collector to send observability data to (used for both tracing and logging if specific endpoints are not provided)",
      "isOps": true,
      "stringField": {}
    },
    {
      "name": "otel-collector-endpoint-tls-cert-path",
      "description": "Path to a file containing a PEM-encoded certificate to use as a CA for TLS connections to the OpenTelemetry collector",
      "isOps": true,
      "stringField": {}
    },
    {
      "name": "otel-collector-endpoint-tls-cert",
      "description": "A PEM-encoded certificate to use as a CA for TLS connections to the OpenTelemetry collector",
      "isOps": true,
      "stringField": {}
    },
    {
      "name": "otel-collector-endpoint-tls-insecure",
      "description": "Allow insecure connections to the OpenTelemetry collector",
      "isOps": true,
      "boolField": {}
    },
    {
      "name": "otel-tracing-disabled",
      "description": "Disable OpenTelemetry tracing",
      "isOps": true,
      "boolField": {}
    },
    {
      "name": "otel-logging-disabled",
      "description": "Disable OpenTelemetry logging",
      "isOps": true,
      "boolField": {}
    },
    {
      "name": "health-check",
      "description": "Enable the HTTP health check endpoint",
      "isOps": true,
      "boolField": {}
    },
    {
      "name": "health-check-port",
      "description": "Port for the HTTP health check endpoint",
      "isOps": true,
      "intField": {
        "defaultValue": "8081"
      }
    },
    {
      "name": "health-check-bind-address",
      "description": "Bind address for health check server (127.0.0.1 for localhost-only)",
      "isOps": true,
      "stringField": {
        "defaultValue": "127.0.0.1"
      }
    },
    {
      "name": "http-timeout-seconds",
      "description": "HTTP client timeout in seconds (max 1800)",
      "isOps": true,
      "intField": {
        "defaultValue": "300",
        "rules": {
          "lte": "1800",
          "gte": "1"
        }
      }
    },
    {
      "name": "account-hostname",
      "displayName": "Account Hostname",
      "description": "The hostname used to connect to the Databricks account API. If not set, it will be calculated from the hostname field.",
      "stringField": {}
    },
    {
      "name": "account-id",
      "displayName": "Account ID",
      "description": "The Databricks account ID used to connect to the Databricks Account and Workspace API",
      "isRequired": true,
      "stringField": {
        "rules": {
          "isRequired": true
        }
      }
    },
    {
      "name": "databricks-client-id",
      "displayName": "OAuth2 Client ID",
      "description": "The Databricks service principal's client ID used to connect to the Databricks Account and Workspace API",
      "isRequired": true,
      "stringField": {
        "rules": {
          "isRequired": true
        }
      }
    },
    {
      "name": "databricks-client-secret",
      "displayName": "OAuth2 Client Secret",
      "description": "The Databricks service principal's client secret used to connect to the Databricks Account and Workspace API",
      "isRequired": true,
      "isSecret": true,
      "stringField": {
        "rules": {
          "isRequired": true
        }
      }
    },
    {
      "name": "hostname",
      "displayName": "Hostname",
      "description": "The Databricks hostname used to connect to the Databricks API",
      "stringField": {
        "defaultValue": "cloud.databricks.com"
      }
    },
    {
      "name": "workspaces",
      "displayName": "Workspaces",
      "description": "Limit syncing to the specified workspaces, by deployment name, not workspace ID. Required when using workspace tokens, in the same order as workspace-tokens. Mutually exclusive with databricks-exclude-workspaces.",
      "stringSliceField": {}
    },
    {
      "name": "workspace-tokens",
      "displayName": "Workspace Tokens",
      "description": "The Databricks personal access tokens scoped to specific workspaces used to connect to the Databricks Workspace API",
      "isRequired": true,
      "isSecret": true,
      "stringSliceField": {
        "rules": {
          "isRequired": true
        }
      }
    },
    {
      "name": "databricks-exclude-workspaces",
      "displayName": "Exclude Workspaces",
      "description": "Workspaces to exclude from sync, identified by workspace name, deployment name, or numeric workspace ID. Mutually exclusive with workspaces.",
      "stringSliceField": {}
    }
  ],
  "constraints": [
    {
      "kind": "CONSTRAINT_KIND_MUTUALLY_EXCLUSIVE",
      "fieldNames": [
        "workspaces",
        "databricks-exclude-workspaces"
      ]
    },
    {
      "kind": "CONSTRAINT_KIND_DEPENDENT_ON",
      "fieldNames": [
        "workspace-tokens"
      ],
      "secondaryFieldNames": [
        "workspaces"
      ]
    }
  ],
  "displayName": "Databricks",
  "helpUrl": "/docs/baton/databricks",
  "iconUrl": "/static/app-icons/databricks.svg",
  "fieldGroups": [
    {
      "name": "oauth2",
      "displayName": "OAuth2",
      "helpText": "Authenticate as a service principal using an OAuth2 client ID and secret.",
      "fields": [
        "account-id",
        "databricks-client-id",
        "databricks-client-secret",
        "hostname",
        "account-hostname",
        "workspaces",
        "databricks-exclude-workspaces"
      ],
      "default": true
    },
    {
      "name": "workspace-token",
      "displayName": "Workspace token",
      "helpText": "Authenticate with a personal access token scoped to each workspace.",
      "fields": [
        "account-id",
        "workspaces",
        "workspace-tokens",
        "hostname",
        "account-hostname",
        "databricks-exclude-workspaces"
      ]
    }
  ]
}