Skip to content

Commit 735c376

Browse files
TanishqDatabricksdenik
authored andcommitted
experimental/ssh: drop [EXPERIMENTAL] tag and clean up help copy (#5342)
## Summary - Replace verbose disclaimer with lightweight tag, then drop [EXPERIMENTAL] entirely - Hide env-version flag, fix alignment in help text - Replace tabs with spaces, update `<connection>` to `<name>` in examples Supersedes #5325 and #5326 (fork PRs that couldn't run CI). ## Test plan - [ ] Verify `databricks ssh --help`, `databricks ssh connect --help`, `databricks ssh setup --help` output - [ ] CI passes (including `test-exp-ssh`)
1 parent f7d0218 commit 735c376

4 files changed

Lines changed: 22 additions & 34 deletions

File tree

experimental/ssh/cmd/connect.go

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ import (
1212
func newConnectCommand() *cobra.Command {
1313
cmd := &cobra.Command{
1414
Use: "connect",
15-
Short: "Connect to Databricks compute via SSH",
16-
Long: `Connect to Databricks compute via SSH.
15+
Short: "Connect to your Databricks compute and workspace via SSH",
16+
Long: `Connect to your Databricks compute and workspace via SSH.
1717
18-
This command establishes an SSH connection to Databricks compute, setting up
19-
the SSH server and handling the connection proxy.
18+
Connect to serverless:
19+
databricks ssh connect
20+
databricks ssh connect --accelerator=<GPU_type> # AI Runtime
2021
21-
` + disclaimer,
22+
Connect to a dedicated cluster:
23+
databricks ssh connect --cluster=<cluster-id>`,
2224
}
2325

2426
var clusterID string
@@ -38,17 +40,14 @@ the SSH server and handling the connection proxy.
3840
var environmentVersion int
3941
var autoApprove bool
4042

41-
cmd.Flags().StringVar(&clusterID, "cluster", "", "Databricks cluster ID (for dedicated clusters)")
43+
cmd.Flags().StringVar(&clusterID, "cluster", "", "Databricks dedicated cluster ID")
4244
cmd.Flags().DurationVar(&shutdownDelay, "shutdown-delay", defaultShutdownDelay, "Delay before shutting down the server after the last client disconnects")
4345
cmd.Flags().IntVar(&maxClients, "max-clients", defaultMaxClients, "Maximum number of SSH clients")
4446
cmd.Flags().BoolVar(&autoStartCluster, "auto-start-cluster", true, "Automatically start the cluster if it is not running")
4547

46-
cmd.Flags().StringVar(&connectionName, "name", "", "Connection name (for serverless compute)")
47-
cmd.Flags().MarkHidden("name")
48-
cmd.Flags().StringVar(&accelerator, "accelerator", "", "GPU accelerator type (GPU_1xA10 or GPU_8xH100)")
49-
cmd.Flags().MarkHidden("accelerator")
48+
cmd.Flags().StringVar(&connectionName, "name", "", "Connection name to reuse across sessions (serverless only)")
49+
cmd.Flags().StringVar(&accelerator, "accelerator", "", "Serverless GPU accelerator type (GPU_1xA10 or GPU_8xH100)")
5050
cmd.Flags().StringVar(&ide, "ide", "", "Open remote IDE window (vscode or cursor)")
51-
cmd.Flags().MarkHidden("ide")
5251

5352
cmd.Flags().BoolVar(&proxyMode, "proxy", false, "ProxyCommand mode")
5453
cmd.Flags().MarkHidden("proxy")
@@ -69,7 +68,7 @@ the SSH server and handling the connection proxy.
6968
cmd.Flags().BoolVar(&skipSettingsCheck, "skip-settings-check", false, "Skip checking and updating IDE settings")
7069
cmd.Flags().MarkHidden("skip-settings-check")
7170

72-
cmd.Flags().IntVar(&environmentVersion, "environment-version", defaultEnvironmentVersion, "Environment version for serverless compute")
71+
cmd.Flags().IntVar(&environmentVersion, "environment-version", defaultEnvironmentVersion, "Environment version for AI Runtime")
7372
cmd.Flags().MarkHidden("environment-version")
7473

7574
cmd.Flags().BoolVar(&autoApprove, "auto-approve", false, "Skip confirmation prompts, installing IDE extensions and applying IDE settings without asking")

experimental/ssh/cmd/server.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ func newServerCommand() *cobra.Command {
1616
Long: `Run SSH tunnel server.
1717
1818
This command starts an SSH tunnel server that accepts WebSocket connections
19-
and proxies them to local SSH daemon processes.
20-
21-
` + disclaimer,
19+
and proxies them to local SSH daemon processes.`,
2220
// This is an internal command spawned by the SSH client running the "ssh-server-bootstrap.py" job
2321
Hidden: true,
2422
}

experimental/ssh/cmd/setup.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,12 @@ import (
1212
func newSetupCommand() *cobra.Command {
1313
cmd := &cobra.Command{
1414
Use: "setup",
15-
Short: "Setup SSH configuration for Databricks compute",
16-
Long: `Setup SSH configuration for Databricks compute.
15+
Short: "Setup SSH configuration for dedicated (single-user) clusters",
16+
Long: `Setup SSH configuration for dedicated (single-user) clusters.
1717
18-
This command configures SSH to connect to Databricks compute by adding
19-
an SSH host configuration to your SSH config file.
18+
After running setup, you can connect with ` + "`ssh <name>`" + `.
2019
21-
` + disclaimer,
20+
For serverless connections, use ` + "`databricks ssh connect`" + ` (no setup step needed).`,
2221
}
2322

2423
var hostName string

experimental/ssh/cmd/ssh.go

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,19 @@ import (
44
"github.com/spf13/cobra"
55
)
66

7-
const disclaimer = `WARNING! This is an experimental feature:
8-
- The product is in preview and not intended to be used in production;
9-
- The product may change or may never be released;
10-
- While we will not charge separately for this product right now, we may charge for it in the future. You will still incur charges for DBUs;
11-
- There's no formal support or SLAs for the preview - so please reach out to your account or other contact with any questions or feedback;`
12-
137
func New() *cobra.Command {
148
cmd := &cobra.Command{
159
Use: "ssh",
16-
Short: "Connect to Databricks compute with ssh",
10+
Short: "Connect to your Databricks compute and workspace via SSH",
1711
Hidden: true,
18-
Long: `Connect to Databricks compute with ssh.
19-
20-
SSH commands let you setup and establish ssh connections to Databricks compute.
12+
Long: `Connect to your Databricks compute and workspace via SSH.
2113
2214
Common workflows:
23-
databricks ssh connect --cluster=<cluster-id> --profile=<profile-name> # connect to a cluster without any setup
24-
databricks ssh setup --name=my-compute --cluster=<cluster-id> # update local ssh config
25-
ssh my-compute # connect to the compute using ssh client
15+
databricks ssh connect --ide=cursor # connect to serverless through Cursor
16+
databricks ssh setup --name=<name> --cluster=<cluster-id> # update ~/.ssh/config so you can reconnect to a dedicated cluster
17+
ssh <name> # connect to dedicated cluster after setup
2618
27-
` + disclaimer,
19+
Use ` + "`databricks ssh connect --help`" + ` to see all available flags.`,
2820
}
2921

3022
cmd.AddCommand(newSetupCommand())

0 commit comments

Comments
 (0)