Edit

Share via

Use Docker containers with Synapse VS Code extension

  • Article

To use the Synapse VS Code extension, certain prerequisites, such as a ready JDK environment, must be met. To simplify the setup process, we developed a new feature that integrates with the VS Code Dev Container. This feature enables you to open the Synapse VS Code extension in a container with all necessary prerequisites already installed, making it easier for users to get started.

The Synapse VS Code extension seamlessly integrates with Docker containers, providing a consistent development environment across different platforms. This feature allows you to work with supported Fabric items, such as notebooks, within a containerized environment that is isolated from your local machine. The containerized environment ensures that all necessary dependencies are installed and configured correctly. It allows you to focus on developing your notebooks without concerns about the environment setup.

A docker image is provided by Synapse to support the VS Code extension. The docker image contains all the required dependencies to run the Synapse VS Code extension, including the Java Development Kit (JDK), Conda, and the Jupyter extension for VS Code. This image is hosed on the Microsoft Artifact Registry and can be pulled from the following location: . To make it easier for users to get started, we have created a sample with devcontainer.json file that you can use to open the Synapse VS Code extension in a container. Follow the steps below to get started.

Synapse provides a Docker image to support the VS Code extension. The Docker image includes all the necessary dependencies like the Java Development Kit (JDK), Conda, and the Jupyter extension for VS Code. This image is hosted on the Microsoft Artifact Registry. To help you get started quickly, a sample with devcontainer.json file can be used to open the Synapse VS Code extension in a container as described in the next sections.

Prerequisites

The following prerequisites should be met to use the Docker containers with the Synapse VS Code extension:

Getting started

  1. Clone the Synapse VS Code Dev Container sample.

  2. Open the sample folder in VS Code, and you'll see a prompt asking you to reopen the folder in a container. Select the Reopen in Container button.

  3. The VS Code Remote Development extension starts building the Docker image and container. This may take a few minutes to complete.

  4. Once the container is up and running, the Extensions view will have a separate section for the extensions running in the container. You can see the Synapse VS Code extension running in the container. You can now start working with the extension as you would on your local machine. Screenshot of extension list with Dev Container running.

  5. You can either create a new notebook or open an existing one to start running code cells. The notebook operates within a containerized environment, separate from your local machine. You can install other Python packages using the Conda package manager, which will only affect the container environment and not your local system. To check the current runtime environment, open a terminal in VS Code and run the command cat /etc/os-release. The output displays the OS version and other relevant information.

  6. To stop the container, select the green icon in the bottom left corner of the VS Code window and select Remote-Containers: Reopen Locally. This stops the container and return you to your local machine.

  7. You can also customize the devcontainer.json file to add other dependencies or configurations to the container. For more information on customizing the devcontainer.json file, see VS Code Dev Container documentation.

Related content