Commit 42bd421
authored
Add SPOG bundle support: account_id, host URL parsing, workspace_id disambiguation (#4825)
## Why
SPOG (Single Pane of Glass) hosts serve multiple workspaces from a
single URL (e.g. `api.databricks.com` instead of separate per-workspace
hosts). Bundles need to support this model so users can:
1. Set `account_id` in their bundle workspace config.
2. Paste SPOG URLs with query parameters (e.g.
`https://host.databricks.com/?o=12345`) directly into `databricks.yml`.
3. Have profile resolution work when multiple profiles share the same
SPOG host.
Without this, bundles on SPOG hosts fail with "multiple profiles
matched" errors because the CLI can't distinguish between profiles that
share the same host.
## Changes
**Before:** Bundles had no `account_id` field, no query parameter
parsing from host URLs, and profile resolution only matched by host
(erroring on duplicates with no way to disambiguate).
**Now:** Three capabilities added:
### 1. `account_id` field in workspace config
Added `AccountID` to the `Workspace` struct, passed through to the SDK
config. Users can now write:
```yaml
workspace:
host: https://api.databricks.com
account_id: "abc123"
workspace_id: "6051921418418893"
```
### 2. Host URL query parameter extraction
`Workspace.Client()` now calls `NormalizeHostURL()` before building the
SDK config. This extracts `?o=` (workspace_id), `?a=` (account_id), and
their long-form aliases from the host URL, then strips the query params.
**Why in `Client()` and not just in the mutator pipeline?** The bundle
flow calls `WorkspaceClientE()` (which calls `Client()`) in
`configureBundle` *before* `phases.Initialize()` runs. If extraction
only happened in the Initialize mutator, workspace_id would be empty
when the profile loader runs, and disambiguation would fail. The mutator
is kept as a secondary pass to ensure the bundle config stays clean for
any code that reads `b.Config.Workspace.Host` directly.
**Why explicit fields take precedence over URL params?** A user who
writes both `workspace_id: "111"` and `host: https://x/?o=222` clearly
intended the explicit field. URL params are a convenience for copy-paste
from browser URLs.
### 3. Profile resolution by workspace_id
When multiple profiles match the same host, the loader now uses
`workspace_id` to disambiguate. The matching order is: host first, then
workspace_id as a fallback.
**Why host first, not workspace_id first?** Most existing configs don't
have workspace_id set yet. Running host matching first preserves
existing behavior for the long tail of configs. workspace_id only kicks
in when host matching is ambiguous. This was discussed with @pietern and
@andrewnester, who preferred keeping the same detection logic with an
additional disambiguation fallback over two separate code paths.
**Why fall back to the original error when workspace_id doesn't match?**
If a user has two profiles for host X with workspace_ids 111 and 222,
but the bundle specifies workspace_id 999, the "multiple profiles
matched" error is more helpful than "no matching profiles" since it
tells them which profiles exist.
### Other changes
- Added `workspace_id` and `account_id` to the auth interpolation
warning in `NoInterpolationInAuthConfig`. These fields now participate
in profile resolution at auth time, so `workspace_id: ${var.my_ws_id}`
would be unresolved and cause silent failures.
- Updated bundle JSON schema and annotations for the new `account_id`
field.
## Test plan
- [x] Unit tests for `NormalizeHostURL` mutator (8 cases: empty, no
params, ?o=, ?a=, ?account_id=, ?workspace_id=, explicit precedence)
- [x] Unit tests for `Workspace.NormalizeHostURL()` method
- [x] Regression test:
`TestWorkspaceClientNormalizesHostBeforeProfileResolution` verifies that
`Client()` normalizes the host URL and populates workspace_id before
profile resolution runs (the critical path)
- [x] Unit tests for workspace_id disambiguation in the profile loader
(5 cases: disambiguate to first/second profile, same workspace_id error,
no workspace_id fallback, no match fallback)
- [x] `make checks` passes
- [x] `make lintfull` passes (0 issues)
- [x] All existing tests continue to pass1 parent 720e2af commit 42bd421
File tree
9 files changed
+260
-2
lines changed- bundle
- config
- validate
- internal/schema
- schema
- libs/databrickscfg
- profile
- testdata
9 files changed
+260
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
45 | 49 | | |
46 | 50 | | |
47 | 51 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
| |||
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
| 47 | + | |
46 | 48 | | |
47 | 49 | | |
48 | 50 | | |
| |||
124 | 126 | | |
125 | 127 | | |
126 | 128 | | |
| 129 | + | |
127 | 130 | | |
128 | 131 | | |
129 | 132 | | |
| |||
137 | 140 | | |
138 | 141 | | |
139 | 142 | | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
140 | 159 | | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
141 | 165 | | |
142 | 166 | | |
143 | 167 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
76 | 157 | | |
77 | 158 | | |
78 | 159 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
415 | 415 | | |
416 | 416 | | |
417 | 417 | | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
418 | 421 | | |
419 | 422 | | |
420 | 423 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
102 | 116 | | |
103 | 117 | | |
104 | 118 | | |
| |||
120 | 134 | | |
121 | 135 | | |
122 | 136 | | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
123 | 164 | | |
124 | 165 | | |
125 | 166 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
164 | 164 | | |
165 | 165 | | |
166 | 166 | | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
| 73 | + | |
74 | 74 | | |
75 | 75 | | |
76 | 76 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
0 commit comments