Attach to a running container
Visual Studio Code can create and start containers for you but that may not match your workflow and you may prefer to "attach" VS Code to an already running Docker container - regardless of how it was started. Once attached, you can install extensions, edit, and debug like you can when you open a folder in a container usingdevcontainer.json.
Attach to a Docker container
To attach to a Docker container, either selectDev Containers: Attach to Running Container... from the Command Palette (F1) or use theRemote Explorer in the Activity Bar and from theContainers view, select theAttach to Container inline action on the container you want to connect to.
Note: When using Alpine Linux containers, some extensions may not work due to
glibcdependencies in native code inside the extension.
Attached container configuration files
VS Code supports image or container name-level configuration files to speed up setup when you repeatedly connect to a given Docker container. Once attached, anytime you open a folder,install an extension, orforward a port, a local image-specific configuration file will automatically be updated to remember your settings so that when you attach again, everything is back to the right place.
By default, animage-level configuration is used. To view or update it after attaching, selectDev Containers: Open Container Configuration File from the Command Palette (F1).
If you would prefer to tie your configuration to acontainer name, selectDev Containers: Open Named Configuration File from the Command Palette (F1) after attaching. Any updates from this point forward will apply to this name-level configuration rather than at the image level.
Both of these files support a subset ofdevcontainer.json properties:
{ // Default path to open when attaching to a new container. "workspaceFolder":"/path/to/code/in/container/here", // Set *default* container specific settings.json values on container create. "settings": { "terminal.integrated.defaultProfile.linux":"bash" }, // Add the IDs of extensions you want installed when the container is created. "extensions": ["dbaeumer.vscode-eslint"], // An array port numbers to forward "forwardPorts": [8000], // Container user VS Code should use when connecting "remoteUser":"vscode", // Set environment variables for VS Code and sub-processes "remoteEnv": {"MY_VARIABLE":"some-value" }}See theattached container config reference for a complete list of properties and their uses.
Once saved, whenever you open a container for the first time with the same image / container name, these properties will be used to configure the environment.
Tip: If something is wrong with your configuration, you can also edit it when not attached to the container by selectingDev Containers: Open Attached Container Configuration File... from the Command Palette (F1) and then picking the image / container name from the presented list.
Finally, if you have extensions you want installed regardless of the container you attach to, you can updatesettings.json to specify a list ofextensions that should always be installed.
Attached container configuration reference
Attached container configuration files are similar todevcontainer.json and supports a subset of its properties.
| Property | Type | Description |
|---|---|---|
workspaceFolder | string | Sets the default path that VS Code should open when connecting to the container (which is often the path to a volume mount where the source code can be found in the container). Not set by default (an empty window is opened). |
extensions | array | An array of extension IDs that specify the extensions that should be installed inside the container when it is created. Defaults to[]. |
settings | object | Adds defaultsettings.json values into a container/machine specific settings file. |
forwardPorts | array | A list of ports that should be forwarded from inside the container to the local machine. |
portsAttributes | object | Object that maps a port number,"host:port" value, range, or regular expression to a set of default options. Seeport attributes for available options. For example:"portsAttributes": {"3000": {"label": "Application port"}} |
otherPortsAttributes | object | Default options for ports, port ranges, and hosts that aren't configured usingportsAttributes. Seeport attributes for available options. For example:"otherPortsAttributes": {"onAutoForward": "silent"} |
remoteEnv | object | A set of name-value pairs that sets or overrides environment variables for VS Code (or sub-processes like terminals) but not the container as a whole. Environment andpre-defined variables may be referenced in the values. For example: "remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path" } |
remoteUser | string | Overrides the user that VS Code runs as in the container (along with sub-processes like terminals, tasks, or debugging). Defaults to the user the container as a whole is running as (oftenroot). |
userEnvProbe | enum | Indicates the type of shell to use to "probe" for user environment variables to include in VS Code or other connected tool's processes:none,interactiveShell,loginShell, orloginInteractiveShell (default). The specific shell used is based on the default shell for the user (typically bash). For example, bash interactive shells will typically include variables set in/etc/bash.bashrc and~/.bashrc while login shells usually include variables from/etc/profile and~/.profile. Setting this property tologinInteractiveShell will get variables from all four files. |
postAttachCommand | string, array | A command string or list of command arguments to run after VS Code attaches to the container. Use&& in a string to execute multiple commands. For example,"yarn install" or"apt-get update && apt-get install -y curl". The array syntax["yarn", "install"] will invoke the command (in this caseyarn) directly without using a shell. Not set by default.Note that the array syntax will execute the command without a shell. You canlearn more about formatting string vs array properties. |
Variables in attached container configuration files
Variables can be referenced in certain string values in attached configuration files in the following format:${variableName}. The following table is a list of available variables you can use.
| Variable | Properties | Description |
|---|---|---|
${containerEnv:VAR_NAME} | remoteEnv | Value of an existing environment variable inside the container (in this case,VAR_NAME) once it is up and running. For example:"remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path" } |
Attach to a container in a Kubernetes cluster
To attach to a container in a Kubernetes cluster, selectDev Containers: Attach to Running Kubernetes Container... from the Command Palette (⇧⌘P (Windows, LinuxCtrl+Shift+P)). Alternatively, first install theKubernetes extension andkubectl along with the Dev Containers extension. Then select the Kubernetes explorer from the Activity Bar and expand the cluster and Pod where the container you want to attach to resides. Finally, right-click on the container and selectAttach Visual Studio Code from the context menu.
Note: Attached container configuration files are not yet supported for containers in a Kubernetes cluster.
Next steps
- Create a Dev Container - Create a custom container for your work environment.
- Advanced Containers - Find solutions to advanced container scenarios.
- devcontainer.json reference - Review the
devcontainer.jsonschema.