You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit fa16d01
Browse filesBrowse the repository at this point in the historyBrowse files
Update docs and comments for the direct-only engine (#6939)
## Changes
Docs, comments, schema descriptions and agent guides still described two
deployment engines.
- `docs/direct.md`: Terraform state is migrated automatically; `engine:
terraform` errors (stay on CLI v1.19.x to keep Terraform); fix backup
file names.
- Drop "direct engine only" qualifiers from
`libraries`/`lifecycle.started` schema descriptions (schema + Python
docstrings regenerated) and from `--plan` help in `bundle deploy`/`apps
deploy`.
- Stale comments referring to tfdyn, terraform deploys or both engines;
explain why the empty apps `description` is still kept (removing a
description from config must clear it remotely).
- Agent guides/skills: remove the two-engine matrix instructions.
This pull request and its description were written by Isaac.
---------
Co-authored-by: Isaac <no-reply@databricks.com>
Copy file name to clipboardExpand all lines: .agents/rules/telemetry.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ The deploy payload is declared twice: the proto in the universe repo (`proto/log
25
25
## Adding a new metric
26
26
27
27
1. Add the field to the relevant message in `libs/telemetry/protos/`, and populate it in `bundle/phases/telemetry.go`.
28
-
2. Refresh the acceptance golden: `go test ./acceptance -run '^TestAccept/bundle/telemetry' -update`. Anything engine-dependent belongs in a per-engine `out.*.$DATABRICKS_BUNDLE_ENGINE.txt` file rather than the engine-agnostic `out.telemetry.txt`; see the comments in that test's `script`.
28
+
2. Refresh the acceptance golden: `go test ./acceptance -run '^TestAccept/bundle/telemetry' -update`.
29
29
3. Send the universe PR adding the same field to the proto, with a `compliance.data_label` annotation matching the neighbouring fields.
30
30
31
31
**RULE: Never send a resource name, path, or any other user-authored string.** Names are PII. Resource identity goes through the numeric/UUID ID lists (`resource_job_ids` and friends), and only for types that have such an ID.
@@ -37,7 +37,7 @@ Other things worth knowing:
37
37
- A one-off boolean needs no proto change: add a key constant to `bundle/metrics/metrics.go` (snake_case, matching the constant name) and call `b.Metrics.SetBoolValue(...)`. It lands in `experimental.bool_values`.
38
38
- Metrics that may be removed later belong in `BundleDeployExperimental`, which carries no compatibility guarantees.
39
39
- Positional encodings such as the `upload_file_sizes` histogram are frozen once the metric has adoption: changing a bucket bound silently changes the meaning of every previously reported entry.
40
-
-Anything measured from the deployment state is engine-dependent. The direct engine keeps per-resource state in `resources.json` and reports sizes; the terraform path leaves `StateSizeBytes` zero and reports only counts.
40
+
-Per-resource state sizes come from the direct engine's state in `resources.json`.
Copy file name to clipboardExpand all lines: .agents/skills/bump-sdk/SKILL.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,8 +50,8 @@ go test ./acceptance -run '^TestAccept$' -timeout=60m # MUST pass on its o
50
50
```
51
51
52
52
The verify pass is not optional.
53
-
Bundle tests run under an `EnvMatrix`of both engines (`terraform`, `direct`).
54
-
When a schema change makes one engine error while the other succeeds, the variants produce different output; `-update` runs both and each overwrites the other's `output.txt`, so it can silently settle on the passing variant and report `ok` while the golden is actually wrong.
53
+
Many bundle tests run under an `EnvMatrix`(e.g. `DMS`, `READPLAN`).
54
+
When a schema change makes one variant error while another succeeds, the variants produce different output; `-update` runs all of them and each overwrites the other's `output.txt`, so it can silently settle on the passing variant and report `ok` while the golden is actually wrong.
55
55
Only the non-update run catches this.
56
56
(Ignore `rejecting_proxy.go: blocking proxy` log lines, which are normal.
57
57
A test that times out under full parallel load but passes when run alone is a flake, not a regression.)
@@ -84,9 +84,7 @@ GIT_EDITOR=true GIT_SEQUENCE_EDITOR=true VISUAL=true GIT_PAGER=cat git rebase or
84
84
85
85
**Mutators**: Transform bundle configuration through a pipeline. Located in `bundle/config/mutator/` and `bundle/mutator/`. Each mutator implements the `Mutator` interface.
86
86
87
-
**Direct vs Terraform Deployment**: The CLI supports two deployment modes controlled by `DATABRICKS_BUNDLE_ENGINE` environment variable:
88
-
-`direct` (default) - Direct API calls without Terraform
89
-
-`terraform` - Uses Terraform for resource management
87
+
**Direct deployment engine**: Bundles are deployed by the direct engine (`bundle/direct/`), which calls the APIs without Terraform. The Terraform engine was removed in v1.20.0: `bundle.engine: terraform` and `DATABRICKS_BUNDLE_ENGINE=terraform` are rejected, and existing Terraform state is migrated to the direct engine before the command runs.
0 commit comments