Updated November, 23 2023
Installing Docker#
To use the detailed assessment you must have docker installed on the system running Azure Data Studio.
Windows Installation Guide#
Docker for Windows can be installed using Docker Desktop for Windows.
Note
Docker for Windows requires the Windows Subsystem for Linux version 2 (WSL 2) in order to run Linux containers on Windows. This requires Virtualisation on the platform you are using. In the case of Azure this will require the use of nested virtualization.
The detailed assessment requires Linux container support to be available which, in turn, requires the use of Windows Subsystem for Linux. The Microsoft documentation linked by Docker for Windows describes the installation process of WSL to support this. However, the following summary should suffice for installations of Windows 10, Windows 11, Windows Server 2019 and Windows Server 2022:
1. The VirtualMachinePlatform must be available
This can be turned on by opening the Control Panel and clicking on the Programs and Features applet.
Alternatively, you can open a command shell and issue a dism.exe command:
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
2. The Windows Subsystem for Linux version 2 must be installed
Open a command shell and issue the following wsl command:
wsl --install
For Windows Server 2019 and Windows 10 this must be upgraded to the pre-release to function correctly:
wsl --update --pre-release
To check you have the latest version of WSL installed the following command can be used:
C:\Users\Administrator>wsl -v
WSL version: 2.0.1.0
Kernel version: 5.15.123.1-1
WSLg version: 1.0.58
MSRDC version: 1.2.4485
Direct3D version: 1.608.2-61064218
DXCore version: 10.0.25880.1000-230602-1350.main
Windows version: 10.0.20348.1970
3. Install docker
After the VirtualMachinePlatform and WSL are enabled Docker Desktop can be installed
using the Docker Desktop Installer.exe or with the following command:
start-process "Docker Desktop Installer.exe" "install --quiet" -Wait -NoNewWindow
Linux Installation Guide#
It is not necessary to use the full Docker Desktop installation on Linux to use the detailed assessment. However, the detailed assessment will work with this installation.
For most Linux systems the Docker CE edition can be installed using the system package manager. The following sections detail this procedure for the more common distributions:
Redhat (RHEL) and derivatives#
Modern RedHat (RHEL) and their derivatives use the dnf package manager
to install packages. For older releases the yum package manager may be
used in the same way by following the guides from Docker.
sudo dnf -y install dnf-plugins-core
Redhat (RHEL)#
sudo dnf config-manager \
--add-repo \
https://download.docker.com/linux/rhel/docker-ce.repo
CentOS#
sudo dnf config-manager \
--add-repo \
https://download.docker.com/linux/centos/docker-ce.repo
Fedora#
sudo dnf config-manager \
--add-repo \
https://download.docker.com/linux/fedora/docker-ce.repo
Installation and configuration#
sudo dnf install docker-ce docker-ce-cli containerd.io docker-compose-plugin
sudo systemctl enable --now docker
sudo usermod -aG docker $(id -un)
SuSe Enterprise Linux (SLES)#
Installation on SLES is carried out using the zypper tool only:
sudo zypper addrepo https://download.docker.com/linux/sles/docker-ce.repo
sudo zypper install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
sudo systemctl enable --now docker
sudo usermod -aG docker $(id -un)
Ubuntu and Debian#
Debian derivatives use the apt package manager to install packages. The following
code blocks setup the docker apt repository and use it to install the docker packages.
sudo apt-get install ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
Ubuntu#
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
Debian#
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
Installation and configuration#
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
sudo usermod -aG docker $(id -un)
Troubleshooting#
The following commands can be used to test the docker installation. Run all of these in order and check whether the output of any appears in the following sections:
docker run --platform linux/amd64 hello-world
docker info
docker inspect postgres:latest -f '{{ .Id }}'
docker inspect pgtranslator:latest -f '{{ .Id }}'
Service not running#
> docker run hello-world
docker: error during connect: in the default daemon configuration on Windows, the docker client
must be run with elevated privileges to connect: Post "http://%2F%2F.%2Fpipe%2Fdocker_engine/v1.24/containers/create":
open //./pipe/docker_engine: The system cannot find the file specified.
See 'docker run --help'.
This can be fixed by running the Docker Desktop application and ensuring that the docker engine is running.
Missing containers#
> docker inspect pgtranslator:latest -f '{{ .Id }}'
Error: No such object: pgtranslator:latest
This can be fixed by downloading and installing the latest pgtranslator.tar.gz and postgres.tar.gz
containers from Liberatii.
Linux OSType not enabled#
If Docker Desktop is not using virtualization via WSL 2 then it may not be possible to run Linux containers. In this case the following error may appear:
> docker run --platform linux/amd64 hello-world
image operating system "linux" cannot be used on this platform: operating system is not supported
To fix this, run:
wsl --install
wsl --update --pre-release
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
and reboot then reinstall Docker Desktop. This should allow docker desktop to use the Linux container type.
Permissions errors on Linux#
The following error indicates that the docker daemon is not accessible to the current user:
> docker run hello-world
docker: permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock:
Post "http://%2Fvar%2Frun%2Fdocker.sock/v1.24/containers/create": dial unix /var/run/docker.sock: connect: permission denied.
See 'docker run --help'.
This can usually be fixed by allowing the current user permission for the docker group:
sudo usermod -aG docker $(id -un)
newgrp docker
docker run hello-world