Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 4.43 KB

README.md

File metadata and controls

98 lines (62 loc) · 4.43 KB

Docker (docker-outside-of-docker) (docker-outside-of-docker)

Re-use the host docker socket, adding the Docker CLI to a container. Feature invokes a script to enable using a forwarded Docker socket within a container to run Docker commands.

Example Usage

"features": {
    "ghcr.io/bartventer/arch-devcontainer-features/docker-outside-of-docker:1": {}
}

Options

Options Id Description Type Default Value
version Select or enter a Docker/Moby CLI version. (Availability can vary by OS version.) string latest
dockerDashComposeVersion Compose version to use for docker-compose (v1 or v2 or none) string v2
installDockerBuildx Install Docker Buildx boolean true
installDockerComposeSwitch Install Compose Switch (provided docker compose is available) which is a replacement to the Compose V1 docker-compose (python) executable. It translates the command line into Compose V2 docker compose then runs the latter. boolean true
enableDockerAutocompletion Enable Docker CLI autocompletion boolean true

Customizations

VS Code Extensions

  • ms-azuretools.vscode-docker

Limitations

  • As the name implies, the Feature is expected to work when the host is running Docker (or the OSS Moby container engine it is built on). It may be possible to get running in other container engines, but it has not been tested with them.
  • The host and the container must be running on the same chip architecture. You will not be able to use it with an emulated x86 image with Docker Desktop on an Apple Silicon Mac, for example.
  • This approach does not currently enable bind mounting the workspace folder by default, and cannot support folders outside of the workspace folder. Consider whether the Docker-in-Docker Feature would better meet your needs given it does not have this limitation.

Supporting bind mounts from the workspace folder

A common question that comes up is how you can use bind mounts from the Docker CLI from within the a dev container using this Feature (e.g. via -v). If you cannot use the Docker-in-Docker Feature, the only way to work around this is to use the host's folder paths instead of the container's paths. There are 2 ways to do this

1. Use the ${localWorkspaceFolder} as environment variable in your code

  1. Add the following to devcontainer.json:
"remoteEnv": { "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}" }
  1. Usage with Docker commands
docker run -it --rm -v ${LOCAL_WORKSPACE_FOLDER}:/workspace archlinux bash
  1. Usage with Docker-compose
version: '3.9'

services:
    archlinux:
        image: archlinux
        volumes:
            - ${LOCAL_WORKSPACE_FOLDER:-./}:/workspace
  • The defaults value ./ is added so that the docker-compose.yaml file can work when it is run outside of the container

2. Change the workspace to ${localWorkspaceFolder}

  • This is useful if we don't want to edit the docker-compose.yaml file
  1. Add the following to devcontainer.json
"workspaceFolder": "${localWorkspaceFolder}",
"workspaceMount": "source=${localWorkspaceFolder},target=${localWorkspaceFolder},type=bind"
  1. Rebuild the container.
  2. When the container first started with this settings, select the Workspace with the absolute path to the working directory inside the container
  3. Docker commands with bind mount should work as they did outside of the devcontainer

Note: There is no ${localWorkspaceFolder} when using the Clone Repository in Container Volume command in the VS Code Dev Containers extension (info).

OS Support

This Feature should work on recent versions of Arch Linux-based distributions with the pacman package manager installed.

bash is required to execute the install.sh script.

Acknowledgments

This project makes use of code from the devcontainers/features project. We thank the authors of devcontainers/features for their work and for making their code available for reuse.

Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.