On this page

Bundle configuration

Bundle support turns on whenever a databricks.yml file is present in the project root. Pass --no-bundle to lhp generate or lhp validate to disable it. Bundle support never reads or modifies databricks.yml; it only detects the file’s presence and writes pipeline resource YAML under resources/lhp/. LHP reads bundle.uuid and targets.<env>.mode from databricks.yml only for anonymous usage telemetry; it never modifies the file.

See also

How-to guides: Validate and ship pipelines in CI, Deploy and run.

Activation flags

Flag

Command

Behavior

--no-bundle

generate, validate

Skip bundle detection and resource sync even when databricks.yml exists.

-pc, --pipeline-config

generate, validate

Path (relative to project root) to the pipeline_config.yaml file. Required when bundle support is enabled.

--force

generate

Deprecated no-op. Every run fully regenerates; the flag is hidden and ignored.

When bundle support is enabled and -pc / --pipeline-config is omitted, both generate and validate fail up-front with LHP-CFG-023 before any files are written. Supply the flag, or pass --no-bundle to skip bundle resource generation entirely.

databricks.yml

User-owned; LHP never modifies it. Bundle support reads only the file’s presence; telemetry additionally reads bundle.uuid and targets.<env>.mode (see Telemetry). These fields govern how the Databricks CLI picks up LHP-generated resources.

Field

Type

Description

bundle.name

string

Bundle name used by the Databricks CLI for deploy paths.

bundle.uuid

string

Written by lhp init --bundle. Read only by telemetry, and sent only as a salted hash (see Telemetry).

include

list[string]

Resource-file globs. Must cover resources/lhp/*.yml so the Databricks CLI loads LHP-generated pipeline resources.

targets

mapping

One entry per deployment target. Each target name must match an LHP environment — a substitutions/<env>.yaml file with the same name.

 
bundle:
  name: my_project

include:
  - resources/*.yml
  - resources/lhp/*.yml

targets:
  dev:
    mode: development
    default: true
    workspace:
      host: <databricks_host>
  prod:
    mode: production
    workspace:
      host: <databricks_host>

config/pipeline_config.yaml

See pipeline_config.yaml for the full file syntax, selectors, fields and merge rules. Use Configure and deploy bundles to configure and deploy a project.

Wheel packaging

Set packaging: wheel on a pipeline (or under project_defaults) to ship its generated code as a built wheel instead of source files. Wheel mode requires a wheel.artifact_volume in lhp.yaml.

Key (lhp.yaml)

Type

Description

wheel.artifact_volume

string

Unity Catalog volume path where built wheels are uploaded. After substitution it must start with /Volumes/; otherwise wheel packaging fails with LHP-CFG-061. Supports ${token}.

 
wheel:
  artifact_volume: "/Volumes/${catalog}/artifacts/wheels"

Generated output

Each generated pipeline produces one resource file resources/lhp/<pipeline_name>.pipeline.yml carrying a # Generated by LakehousePlumber header. Every lhp generate run wipes resources/lhp/ and rewrites it — manual edits are lost.

Path

Contents

resources/lhp/<pipeline_name>.pipeline.yml

Pipeline resource; declares a <pipeline_name>_pipeline resource key.

resources/lhp/_wheels.bundle.yml

Written only when at least one pipeline uses packaging: wheel; points the bundle’s artifact upload path at wheel.artifact_volume.