sandbox: rename lakebox → sandbox across CLI surface#5487
Merged
akshaysingla-db merged 1 commit intoJun 9, 2026
Merged
Conversation
Contributor
Waiting for approvalBased on git history, these people are best suited to review:
Eligible reviewers: Suggestions based on git history. See OWNERS for ownership rules. |
akshaysingla-db
force-pushed
the
akshay/lakebox-to-sandbox-rename
branch
from
June 9, 2026 19:14
282154a to
04ebdf2
Compare
User-visible rename. The command is now `databricks sandbox …` instead of `databricks lakebox …`. Internals follow the same naming: Go package, directory, identifiers, state file, SSH key file, SSH config alias, and managed include file all switch from "lakebox" to "sandbox". The wire-format API path is the one exception — `sandboxAPIPath` and `sandboxKeysAPIPath` still point at `/api/2.0/lakebox/...` because the server-side rename is happening separately. A comment on the const block flags this as the sole intentional "lakebox" string in the codebase. Specifically renamed: - `cmd/lakebox/` → `cmd/sandbox/` (Go package + 25 files, identifiers like `lakeboxAPI` → `sandboxAPI`, `lakeboxKeyPath` → `sandboxKeyPath`, `newLakeboxAPI` → `newSandboxAPI`, etc.) - `acceptance/cmd/lakebox/` → `acceptance/cmd/sandbox/` (20 test scenarios, scripts say `$CLI sandbox …`, server stubs still match `/api/2.0/lakebox/...`) - `~/.databricks/lakebox.json` → `~/.databricks/sandbox.json` (state) - `~/.ssh/lakebox_ed25519` → `~/.ssh/sandbox_ed25519` (key) - `~/.ssh/databricks-lakebox` → `~/.ssh/databricks-sandbox` (managed include file) - `Host lakebox-gw` → `Host sandbox-gw` (SSH config alias). Workspace UI needs to be updated to match. - `# >>> databricks lakebox >>>` / `# <<< databricks lakebox <<<` → `databricks sandbox` markers in the include block. Existing CLI users (snapshot installs from internal/bugbash/install.sh) will need to re-register on first use after the upgrade — old key, state, and SSH-config entries are orphaned under the lakebox names. Low risk because we haven't shipped publicly yet. cmd/cmd.go import + AddCommand updated; cmd/fuzz_panic_test.go manual-roots skip-list updated. Co-authored-by: Isaac
akshaysingla-db
force-pushed
the
akshay/lakebox-to-sandbox-rename
branch
from
June 9, 2026 19:17
04ebdf2 to
6aaf271
Compare
2 tasks
akshaysingla-db
merged commit Jun 9, 2026
dc588c1
into
databricks:demo-lakebox
13 of 20 checks passed
2 tasks
akshaysingla-db
added a commit
to akshaysingla-db/cli
that referenced
this pull request
Jun 9, 2026
The lakebox → sandbox rename PR (databricks#5487) did a bulk sed that incorrectly rewrote 14 documentation comments naming the actual HTTP endpoints. The wire path is `/api/2.0/lakebox/...` (server-side rename pending — see the sandboxAPIRoot constant), but the docstrings on list/get/create/update/delete/start/stop/registerKey/listKeys/ deleteKey/listResponse/registerKeyRequest were left saying `/api/2.0/sandbox/...`, misleading any reader who treats the comment as canonical. Also restores the keyhash_test.go header comment that mentions where the algorithm was verified. Behavior unchanged; comments now match the actual `Pattern` strings in the acceptance tests and the live URLs the CLI sends. Co-authored-by: Isaac
akshaysingla-db
added a commit
that referenced
this pull request
Jun 9, 2026
## Summary Follow-up to #5487. The bulk sed in that PR incorrectly rewrote 14 documentation comments that name the actual HTTP endpoints — the wire path is `/api/2.0/lakebox/...` (server-side rename pending; see the `sandboxAPIRoot` const), but the doc comments on `list` / `get` / `create` / `update` / `delete` / `start` / `stop` / `registerKey` / `listKeys` / `deleteKey` / `listResponse` / `registerKeyRequest` were left saying `/api/2.0/sandbox/...`. That mismatch is misleading — any reader treating the comment as canonical would look for a non-existent endpoint. Restoring all 14 to the actual wire path. Also restores the `keyhash_test.go` header comment that documents where the algorithm was verified. Behavior unchanged; comments now match the `[[Server]] Pattern` strings in the acceptance tests and the URLs the CLI actually sends. ## Test plan - [x] `go test ./cmd/sandbox/...` passes - [x] `go build ./...` clean ## Note This is stacked on #5487 (`lakebox` → `sandbox` rename). Until that merges, the diff here shows the rename + the doc-comment fix together. After #5487 lands on `demo-lakebox`, this PR's diff collapses to just the 14 doc-comment line edits. This pull request and its description were written by Isaac.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
User-visible rename. The command is now
databricks sandbox …instead ofdatabricks lakebox …. Internals follow the same naming: Go package, directory, identifiers, state file, SSH key file, SSH config alias, and managed include file all switch fromlakeboxtosandbox.The wire-format API path is the one exception —
sandboxAPIPathandsandboxKeysAPIPathstill point at/api/2.0/lakebox/...because the server-side rename is happening separately. A comment on the const block inapi.goflags this as the sole intentionallakeboxstring in the codebase.What changed
databricks lakebox …databricks sandbox …cmd/lakebox/(25 files)cmd/sandbox/lakeboxAPI,newLakeboxAPI,lakeboxKeyPath, etc.sandboxAPI,newSandboxAPI,sandboxKeyPath, etc.~/.databricks/lakebox.json~/.databricks/sandbox.json~/.ssh/lakebox_ed25519~/.ssh/sandbox_ed25519~/.ssh/databricks-lakebox~/.ssh/databricks-sandboxHost lakebox-gwHost sandbox-gw# >>> databricks lakebox >>># >>> databricks sandbox >>>acceptance/cmd/lakebox/(20 scenarios)acceptance/cmd/sandbox//api/2.0/lakebox/sandboxesand/api/2.0/lakebox/ssh-keyscmd/cmd.goimport +AddCommandupdated;cmd/fuzz_panic_test.gomanual-roots skip-list updated. Workspace UI needs a matching update to the SSH alias (lakebox-gw→sandbox-gw) so the "First time setup?" disclosure and the editor deep-links stay in sync — flagging for the UI side.Migration impact
Existing CLI users (snapshot installs from
internal/bugbash/install.sh) will need to re-register on first use after the upgrade — old key, state, and SSH-config entries are orphaned under the lakebox names. Low risk because we haven't shipped publicly yet.Test plan
go test ./cmd/sandbox/...passes (22 unit tests)go test ./acceptance -run TestAccept/cmd/sandboxpasses (20 acceptance tests, all goldens regenerated)go test ./cmd/...passes overall (no other suite indexed the lakebox name)go build ./...clean./task lintcleangrep -rE '\blakebox\b'outsideinternal/bugbash/returns only the intentional/api/2.0/lakeboxAPI-path valuesThis pull request and its description were written by Isaac.