Web terminal

Preview

This feature is in Public Preview.

Databricks web terminal provides a convenient and highly interactive way for you to run shell commands and use editors, such as Vim or Emacs, on the Spark driver node. Unlike using SSH, web terminal can be used by many users on one cluster and does not require setting up keys. Example uses of the web terminal include monitoring resource usage and installing Linux packages.

Web terminal is disabled by default for all workspace users.

Warning

Databricks proxies the web terminal service from port 7681 on the cluster’s Spark driver. This web proxy is intended for use only with the web terminal. If the port is occupied when the cluster starts or if there is otherwise a conflict, the web terminal may not work as expected. If other web services are launched on port 7681, cluster users may be exposed to potential security exploits. Databricks is not responsible for any issues that result from the installation of unsupported software on a cluster.

Requirements

  • Databricks Runtime 7.0 and above.
  • Can Attach To permission on a cluster.
  • Your Databricks workspace must have web terminal enabled.

Use the web terminal

Do one of the following:

  • In a cluster detail page, click the Apps tab and then click Launch Web Terminal.

    Launch Web Terminal
  • In a notebook, click an attached cluster drop-down and then click Terminal.

    Launch Web Terminal Shortcut

A new tab opens with the web terminal UI and the Bash prompt, where you can run commands as root inside the container of the cluster driver node.

Web Terminal UI

Each user can have up to 100 active web terminal sessions (tabs) open. Idle web terminal sessions may time out and the web terminal web application will reconnect, resulting in a new shell process. If you want to keep your Bash session, Databricks recommends using tmux.

Limitations

Databricks web terminal is not available in the following cluster types: