Some Domino standard environments support launching Visual Studio Code (VSCode) in interactive Workspaces. VSCode is an open-source multi-language editor maintained by Microsoft. Domino can serve the VSCode application to your browser with the power of code-server from Coder.com.
VSCode support is available in the latest versions of the Domino standard environments:
- Domino Analytics Distribution for Python 2.7
-
-
quay.io/domino/base:Ubuntu18_DAD_Py2.7_R3.5-20190501
-
- Domino Analytics Distribution for Python 3.7
-
-
quay.io/domino/base:Ubuntu18_DAD_Py3.7_R3.5-20190501
-
- Domino Analytics Distribution for Python 3.6
-
-
quay.io/domino/base:Ubuntu18_DAD_Py3.6_R3.5-20190501
-
When using a VSCode-equipped Domino environment you can launch VSCode from the Workspaces Dashboard just as you would launch an RStudio or Jupyter workspace.
Option 1: Launch VSCode directly
You can launch VSCode directly from the Workspaces dashboard or Quick Action menu, the same way you would launch RStudio or Jupyter.
If launched this way, your Workspace will open with the Domino controls around a VSCode editor. You can work with your project files in VSCode, and commit and sync with the Domino Workspace UI as normal.
Option 2: Launch VSCode from JupyterLab
In VSCode-equipped environments, you will also find VS Code IDE as a notebook option in JupyterLab.
If launched this way, JupyterLab will open a new tab that will serve the VSCode application. This editor is running in the same Domino Run container as your JupyterLab application. However, the VSCode tab will not show the Domino Workspace controls. If you want to sync, commit, or stop your Workspace after working in VSCode, you must do so from the JupyterLab tab.
You can install VSCode extensions in the following ways:
-
Use the pre-run script.
-
Use VSCode’s Extensions Manager.
-
Go to the environment.
-
Click Edit Environment.
-
In Pre Run Script, paste the following:
code-server --install-extension <extension-name> --extensions-dir ${HOME}/.local/share/code-server/extensions -
Click Build.
Use the VSCode’s Extensions Manager to install extensions from the marketplace. You must build the extensions in your environment to make them available in every new VSCode workspace.
-
Find the extension you want to install in the Visual Studio Marketplace. For example, install the scala-lang extension.
-
Microsoft obscures the download URL for the extension by default. Open your browser’s development tools, then click Download extension.
-
Get the download URL for the extension from the request details in your browser’s development tools. It ends with
/vspackage. Copy this URL.
-
In Domino, create a new environment. As the base image, use one of the VSCode-equipped Domino Standard Environments, listed in the prerequisites.
-
Add the following instructions to your environment’s Dockerfile. Replace the folder names and example
/vspackageURL with the extension URL you retrieved previously. These commands download the extension, extract the required files, and adds them to the appropriate folder.
RUN apt-get update
RUN apt-get install -y bsdtar
RUN mkdir -p /home/ubuntu/.local/share/code-server/extensions/ms-python.python-2019.3.6558
RUN cd /home/ubuntu/.local/share/code-server/extensions/ms-python.python-2019.3.6558
RUN curl -JL https://marketplace.visualstudio.com/_apis/public/gallery/publishers/ms-python/vsextensions/python/2019.3.6558/vspackage | bsdtar -xvf - extension
RUN cd /home/ubuntu/.local/share/code-server/extensions/ms-python.python-2019.3.6558/extension/ && mv * ../
RUN chown ubuntu:ubuntu /home/ubuntu/.local/share/code-server/-
Click Build. After a successful build, you can use this new environment to launch VSCode Workspace sessions with the extensions already installed.
You can add VSCode to some older environments by adding the following to your compute environment. The base environment must be 2018-05-23 or newer.
-
Add the following to your compute environment docker file instructions:
#note: Make sure you are using the latest release if you'd like the latest version of the workspaces #https://github.com/dominodatalab/workspace-configs/releases RUN cd /tmp && wget https://github.com/dominodatalab/workspace-configs/archive/2019q2-v1.3.zip && \ unzip 2019q2-v1.3.zip && cp -Rf workspace-configs-2019q2-v1.3/vscode /var/opt/workspaces/vscode && \ rm -rf /var/opt/workspaces/workspace-logos && \ rm -rf /tmp/workspace-configs-2019q2-v1.3 RUN \ chmod +x /var/opt/workspaces/vscode/install && sleep 2 && \ /var/opt/workspaces/vscode/install -
Add the following to your compute environment’s Pluggable Workspace Tools:
vscode:
title: "vscode"
iconUrl: "https://raw.github.com/dominodatalab/workspace-configs/develop/workspace-logos/vscode.svg?sanitize=true"
start: [ "/var/opt/workspaces/vscode/start" ]
httpProxy:
port: 8888