Edit-Build-Run in a Container with VS Code

Do you want to try out new technologies without installing a bunch of software inside your local machine?  Do you wish to edit, build and debug code on commonly available Docker containers without having to build custom development containers? Visual Studio Code with  remote extensions let you do just that.

I wanted to play with Machine Learning, Jupyter Notebooks and TensorFlow without mucking up my local machine. ML tooling is large and complicated to install. The easiest way to do this is to run Anaconda/Jupyter/tensor-flow in containers derived from unadulterated publicly available Docker images.

Jupyter notebooks are great but sometimes I want an IDE. VS Code Remote lets me use a standard IDE while developing in a remote sandbox. It provides command line access without forcing me to command line based tooling.

Visual Studio Code can build, run and debug on a remote machine via their various remote extensionsRemote Extension for Docker lets you edit/compile/debug code sitting in Docker containers from your main laptop experience.  Visual Studio Code essentially runs headless inside the Docker container with the local Visual Studio acting as a viewport into the remote VS Code server.  Many of the standard VS Code extensions can be installed in the remote/container VS Code so that they run inside the remote Docker container.

VS Code and Docker components and connectivity

Microsoft has a lot of documentation that describes how to use their Docker Images for various development platforms. I wanted to use VS Code with non Microsoft derived images.  I couldn't find anything that told me how to use VSCode with already deployed containers.
This walk-through demonstrates remotely connecting to a publicly sourced container that were created without VS code in mind. We pattern lets us develop images originating from anywhere we allow.

Using VS Code with source on a Docker container

This approach opens two VS Code windows, the original launch window and a window for the remote session on the Docker container. All the development happens in the 2nd window, the one connected to the Docker container.  I'm sure there are other ways to do this.

Assumptions

  1. VS Code is installed locally.
    1. VS Code Docker extension is installed.
    2. VS Code Remote - Development extension pack is installed.
  2. Docker is installed and running locally
  3. Our target container is running in it.
  4. Source code is available inside the Docker container either via a volume mount or some other method like local version control.  The VS Code Remote extension can clone code from version control into named volumes to simplify this.

Connect to a remote container

  1. Run your Docker container.
  2. Run Visual Studio Code
  3. Select the Docker Plugin
    1. Right mouse on the container you wish to edit / build / run on
    2. Select Attach Visual Studio Code from the drop down
    3. New window will open  with a purple bar on the bottom.
      1. VSCode attempts to install the server.
      2. You will see Opening Remote... Installing Dev Components... 
      3. The remote green box in the lower corner will have your container name.
      4. A container name string , [Container xxxx/yyy]  , will appear in the title bar
    4. A new shell prompt will open on that container

Install Remote components

You have to install the Visual Studio remote components one time per target Docker container
  1. Click on the Extensions button on the left side.
  2. Find the plugins required for remote debugging.
    1. Select Install in Container xxxx for your desired plugin
      1. In my case I installed the Python extension.
  3. Click on Reload Required  if the plugin asks for it.  The workspace will refresh as the remote side restarts
Remote extension installed

Open a folder on the remote side.

  1. Select the Explorer button on the left
  2. You should see No Folder Opened
  3. Click on Open Folder button
  4. Select the folder on the Docker container that contains the code to develop
  5. The bar at the bottom will change from purple to blue
Opening a remote folder

Remote folder opened

Build and run program on container

There are 3 ways to do this for a python program.  Other languages probably have at least two of these approaches.

Using the Debug menu

  1. Select the file to run
  2. Menu Debug --> Run without debugging

From the context menu, in a terminal

    1. Right mouse on a python file
      1. Select Run Python file in terminal
      2. It should open a terminal window and run the program

    From the context menu, in a python interactive (Jupyter style) interface

    1. Right mouse on a python file 
      1. Select Run current file in python interactive window
      2. Interactive panel will come up and run 

    Remote session connected to a stock Tensorflow/Tensorflow:latest container

    Python notes

    People using Python can select the version of Python by clicking on the version string on the bottom. If you can't the version at the bottom that then you have to select the version of python in the toaster panel the first time you run a program.

    Function Availability


    Utility Connection
    Type
    VS Code
    Extensions
    Files via
    Utility VS Code
    Remote
    Remote
    Shell
    Installed

    Not
    Installed
    Volume
    mount
    GIT

    Best X
    [2][4]
    [5][7][9]
    Best X [2][4]
    [6][8][10]
    Good X [3][4] [5][7][9]
    Good X
    [3][4]
    [6][8][10]
    OK
    X [3] [5][7][9]
    OK
    X [3] [6][8][10]


    1. n/a 
    2. Remote execution via IDE with debug
    3. Remote execution via remote shell without IDE integration
    4. Can edit in remote file system via VS Code
    5. Can edit files on development machine. Changes on host appear in container.
      1. Cannot edit files development machine.
      2. Must enable volume sharing. 
      3. Requires Git installation in container
      4. Does not work with remote cloud containers
      5. Works with remote containers where sharing isn't possible

      Comments