Install Docker On Docker Container

Docker Engine is an open source containerization technology for building and containerizing your applications. Docker Engine acts as a client-server application with: A server with a long-running daemon process dockerd. The preferred choice for millions of developers that are building containerized apps. Docker Desktop is an application for MacOS and Windows machines for the building and sharing of containerized applications. Access Docker Desktop and follow the guided onboarding to build your first containerized application in minutes.

Applies to: SQL Server (all supported versions) - Linux

Note

The examples shown below use the docker.exe but most of these commands also work with Podman. It provides the CLI similar to Docker container Engine. You can read more about podman here.

In this quickstart, you use Docker to pull and run the SQL Server 2017 container image, mssql-server-linux. Then connect with sqlcmd to create your first database and run queries.

Tip

If you want to run SQL Server 2019 containers, see the SQL Server 2019 version of this article.

Note

Starting with SQL Server 2019 CU3, Ubuntu 18.04 is supported.

In this quickstart, you use Docker to pull and run the SQL Server 2019 container image, mssql-server. Then connect with sqlcmd to create your first database and run queries.

Tip

This quickstart creates SQL Server 2019 containers. If you prefer to create SQL Server 2017 containers, see the SQL Server 2017 version of this article.

Install Docker-compose On Docker Image

This image consists of SQL Server running on Linux based on Ubuntu 18.04. It can be used with the Docker Engine 1.8+ on Linux or on Docker for Mac/Windows. This quickstart specifically focuses on using the SQL Server on Linux image. The Windows image is not covered, but you can learn more about it on the mssql-server-windows-developer Docker Hub page.

Prerequisites

• Docker Engine 1.8+ on any supported Linux distribution or Docker for Mac/Windows. For more information, see Install Docker.
• Docker overlay2 storage driver. This is the default for most users. If you find that you are not using this storage provider and need to change, see the instructions and warnings in the docker documentation for configuring overlay2.
• Minimum of 2 GB of disk space.
• Minimum of 2 GB of RAM.
• System requirements for SQL Server on Linux.

Pull and run the 2017 container image

Before starting the following steps, make sure that you have selected your preferred shell (bash, PowerShell, or cmd) at the top of this article.

1. Pull the SQL Server 2017 Linux container image from Microsoft Container Registry.

   Tip

   If you want to run SQL Server 2019 containers, see the SQL Server 2019 version of this article.

   The previous command pulls the latest SQL Server 2017 container image. If you want to pull a specific image, you add a colon and the tag name (for example, mcr.microsoft.com/mssql/server:2017-GA-ubuntu). To see all available images, see the mssql-server Docker hub page.

   For the bash commands in this article, sudo is used. On macOS, sudo might not be required. On Linux, if you do not want to use sudo to run Docker, you can configure a docker group and add users to that group. For more information, see Post-installation steps for Linux.

2. To run the container image with Docker, you can use the following command from a bash shell (Linux/macOS) or elevated PowerShell command prompt.

   Note

   If you are using PowerShell Core, replace the double quotes with single quotes.

   Note

   The password should follow the SQL Server default password policy, otherwise the container can not setup SQL server and will stop working. By default, the password must be at least 8 characters long and contain characters from three of the following four sets: Uppercase letters, Lowercase letters, Base 10 digits, and Symbols. You can examine the error log by executing the docker logs command.

   By default, this creates a container with the Developer edition of SQL Server 2017. The process for running production editions in containers is slightly different. For more information, see Run production container images.

   The following table provides a description of the parameters in the previous docker run example:

   Parameter	Description
   -e 'ACCEPT_EULA=Y'	Set the ACCEPT_EULA variable to any value to confirm your acceptance of the End-User Licensing Agreement. Required setting for the SQL Server image.
   -e 'SA_PASSWORD='	Specify your own strong password that is at least 8 characters and meets the SQL Server password requirements. Required setting for the SQL Server image.
   -p 1433:1433	Map a TCP port on the host environment (first value) with a TCP port in the container (second value). In this example, SQL Server is listening on TCP 1433 in the container and this is exposed to the port, 1433, on the host.
   --name sql1	Specify a custom name for the container rather than a randomly generated one. If you run more than one container, you cannot reuse this same name.
   -h sql1	Used to explicitly set the container hostname, if you don't specify it, it defaults to the container ID which is a randomly generated system GUID.
   -d	Run the container in the background (daemon)
   mcr.microsoft.com/mssql/server:2017-latest	The SQL Server 2017 Linux container image.

3. To view your Docker containers, use the docker ps command.

   You should see output similar to the following screenshot:

4. If the STATUS column shows a status of Up, then SQL Server is running in the container and listening on the port specified in the PORTS column. If the STATUS column for your SQL Server container shows Exited, see the Troubleshooting section of the configuration guide.

The -h (host name) parameter as discussed above, changes the internal name of the container to a custom value. This is the name you'll see returned in the following Transact-SQL query:

Setting -h and --name to the same value is a good way to easily identify the target container.

1. As a final step, change your SA password because the SA_PASSWORD is visible in ps -eax output and stored in the environment variable of the same name. See steps below.

Pull and run the 2019 container image

Before starting the following steps, make sure that you have selected your preferred shell (bash, PowerShell, or cmd) at the top of this article.

1. Pull the SQL Server 2019 Linux container image from Microsoft Container Registry.

   Note

   If you are using PowerShell Core, replace the double quotes with single quotes.

   Tip

   This quickstart uses the SQL Server 2019 Docker image. If you want to run the SQL Server 2017 image, see the SQL Server 2017 version of this article.

   The previous command pulls the SQL Server 2019 container image based on Ubuntu. To instead use container images based on RedHat, see Run RHEL-based container images. To see all available images, see the mssql-server-linux Docker hub page.

   For the bash commands in this article, sudo is used. On macOS, sudo might not be required. On Linux, if you do not want to use sudo to run Docker, you can configure a docker group and add users to that group. For more information, see Post-installation steps for Linux.

2. To run the container image with Docker, you can use the following command from a bash shell (Linux/macOS) or elevated PowerShell command prompt.

   Note

   The password should follow the SQL Server default password policy, otherwise the container can not setup SQL server and will stop working. By default, the password must be at least 8 characters long and contain characters from three of the following four sets: Uppercase letters, Lowercase letters, Base 10 digits, and Symbols. You can examine the error log by executing the docker logs command.

   By default, this creates a container with the Developer edition of SQL Server 2019.

   The following table provides a description of the parameters in the previous docker run example:

   Parameter	Description
   -e 'ACCEPT_EULA=Y'	Set the ACCEPT_EULA variable to any value to confirm your acceptance of the End-User Licensing Agreement. Required setting for the SQL Server image.
   -e 'SA_PASSWORD='	Specify your own strong password that is at least 8 characters and meets the SQL Server password requirements. Required setting for the SQL Server image.
   -p 1433:1433	Map a TCP port on the host environment (first value) with a TCP port in the container (second value). In this example, SQL Server is listening on TCP 1433 in the container and this is exposed to the port, 1433, on the host.
   --name sql1	Specify a custom name for the container rather than a randomly generated one. If you run more than one container, you cannot reuse this same name.
   -h sql1	Used to explicitly set the container hostname, if you don't specify it, it defaults to the container ID which is a randomly generated system GUID.
   mcr.microsoft.com/mssql/server:2019-latest	The SQL Server 2019 Ubuntu Linux container image.

3. To view your Docker containers, use the docker ps command.

   You should see output similar to the following screenshot:

4. If the STATUS column shows a status of Up, then SQL Server is running in the container and listening on the port specified in the PORTS column. If the STATUS column for your SQL Server container shows Exited, see Troubleshooting SQL Server Docker containers.

The -h (host name) parameter as discussed above, changes the internal name of the container to a custom value. This changes the internal name of the container to a custom value. This is the name you'll see returned in the following Transact-SQL query:

Setting -h and --name to the same value is a good way to easily identify the target container.

1. As a final step, change your SA password because the SA_PASSWORD is visible in ps -eax output and stored in the environment variable of the same name. See steps below.

Change the SA password

The SA account is a system administrator on the SQL Server instance that gets created during setup. After creating your SQL Server container, the SA_PASSWORD environment variable you specified is discoverable by running echo $SA_PASSWORD in the container. For security purposes, change your SA password.

1. Choose a strong password to use for the SA user.

2. Use docker exec to run sqlcmd to change the password using Transact-SQL. In the following example, replace the old password, , and the new password, , with your own password values.

Connect to SQL Server

The following steps use the SQL Server command-line tool, sqlcmd, inside the container to connect to SQL Server.

1. Use the docker exec -it command to start an interactive bash shell inside your running container. In the following example sql1 is name specified by the --name parameter when you created the container.

2. Once inside the container, connect locally with sqlcmd. Sqlcmd is not in the path by default, so you have to specify the full path.

   Tip

   You can omit the password on the command-line to be prompted to enter it.

3. If successful, you should get to a sqlcmd command prompt: 1>.

Create and query data

The following sections walk you through using sqlcmd and Transact-SQL to create a new database, add data, and run a query.

Create a new database

The following steps create a new database named TestDB.

1. From the sqlcmd command prompt, paste the following Transact-SQL command to create a test database:

2. On the next line, write a query to return the name of all of the databases on your server:

3. The previous two commands were not executed immediately. Type GO on a new line to execute the previous commands:

Insert data

Next create a new table, Inventory, and insert two new rows.

Install Docker On Docker Container Linux

1. From the sqlcmd command prompt, switch context to the new TestDB database:

2. Create new table named Inventory:

3. Insert data into the new table:

4. Type GO to execute the previous commands:

Select data

Now, run a query to return data from the Inventory table.

1. From the sqlcmd command prompt, enter a query that returns rows from the Inventory table where the quantity is greater than 152:

2. Execute the command:

Exit the sqlcmd command prompt

1. To end your sqlcmd session, type QUIT:

2. To exit the interactive command-prompt in your container, type exit. Your container continues to run after you exit the interactive bash shell.

Connect from outside the container

You can also connect to the SQL Server instance on your Docker machine from any external Linux, Windows, or macOS tool that supports SQL connections.

The following steps use sqlcmd outside of your container to connect to SQL Server running in the container. These steps assume that you already have the SQL Server command-line tools installed outside of your container. The same principles apply when using other tools, but the process of connecting is unique to each tool.

1. Find the IP address for the machine that hosts your container. On Linux, use ifconfig or ip addr. On Windows, use ipconfig.

2. For this example, install the sqlcmd tool on your client machine. For more information, see Install sqlcmd on Windows or Install sqlcmd on Linux.

3. Run sqlcmd specifying the IP address and the port mapped to port 1433 in your container. In this example, that is the same port, 1433, on the host machine. If you specified a different mapped port on the host machine, you would use it here. You will also need to open the appropriate inbound port on your firewall to allow the connection.

4. Run Transact-SQL commands. When finished, type QUIT.

Other common tools to connect to SQL Server include:

Install Docker On Docker Image

Remove your container

If you want to remove the SQL Server container used in this tutorial, run the following commands:

Warning

Stopping and removing a container permanently deletes any SQL Server data in the container. If you need to preserve your data, create and copy a backup file out of the container or use a container data persistence technique.

Docker demo

After you have tried using the SQL Server container image for Docker, you might want to know how Docker is used to improve development and testing. The following video shows how Docker can be used in a continuous integration and deployment scenario.

Next steps

For a tutorial on how to restore database backup files into a container, see Restore a SQL Server database in a Linux Docker container. Explore other scenarios, such as running multiple containers, data persistence, and troubleshooting.

Also, check out the mssql-docker GitHub repository for resources, feedback, and known issues.

Docker Engine is an open source containerization technology for building andcontainerizing your applications. Docker Engine acts as a client-serverapplication with:

• A server with a long-running daemon process dockerd.
• APIs which specify interfaces that programs can use to talk to andinstruct the Docker daemon.
• A command line interface (CLI) client docker.

The CLI uses Docker APIs to control or interact with the Dockerdaemon through scripting or direct CLI commands. Many other Docker applicationsuse the underlying API and CLI. The daemon creates and manage Docker objects,such as images, containers, networks, and volumes.

For more details, see Docker Architecture.

Docker user guide

To learn about Docker in more detail and to answer questions about usage andimplementation, check out the overview page in 'get started'.

Installation guides

The installation section shows you how to install Dockeron a variety of platforms.

Release notes

A summary of the changes in each release in the current series can now be foundon the separate Release Notes page

Feature Deprecation Policy

As changes are made to Docker there may be times when existing featuresneed to be removed or replaced with newer features. Before an existingfeature is removed it is labeled as 'deprecated' within the documentationand remains in Docker for at least 3 stable releases unless specifiedexplicitly otherwise. After that time it may be removed.

Users are expected to take note of the list of deprecated features eachrelease and plan their migration away from those features, and (if applicable)towards the replacement features as soon as possible.

The complete list of deprecated features can be found on theDeprecated Features page.

Licensing

Docker is licensed under the Apache License, Version 2.0. SeeLICENSE for the fulllicense text.

Select data

Now, run a query to return data from the Inventory table.

1. From the sqlcmd command prompt, enter a query that returns rows from the Inventory table where the quantity is greater than 152:

2. Execute the command:

Exit the sqlcmd command prompt

1. To end your sqlcmd session, type QUIT:

2. To exit the interactive command-prompt in your container, type exit. Your container continues to run after you exit the interactive bash shell.

Connect from outside the container

You can also connect to the SQL Server instance on your Docker machine from any external Linux, Windows, or macOS tool that supports SQL connections.

The following steps use sqlcmd outside of your container to connect to SQL Server running in the container. These steps assume that you already have the SQL Server command-line tools installed outside of your container. The same principles apply when using other tools, but the process of connecting is unique to each tool.

1. Find the IP address for the machine that hosts your container. On Linux, use ifconfig or ip addr. On Windows, use ipconfig.

2. For this example, install the sqlcmd tool on your client machine. For more information, see Install sqlcmd on Windows or Install sqlcmd on Linux.

3. Run sqlcmd specifying the IP address and the port mapped to port 1433 in your container. In this example, that is the same port, 1433, on the host machine. If you specified a different mapped port on the host machine, you would use it here. You will also need to open the appropriate inbound port on your firewall to allow the connection.

4. Run Transact-SQL commands. When finished, type QUIT.

Other common tools to connect to SQL Server include:

Install Docker On Docker Image

Remove your container

If you want to remove the SQL Server container used in this tutorial, run the following commands:

Warning

Stopping and removing a container permanently deletes any SQL Server data in the container. If you need to preserve your data, create and copy a backup file out of the container or use a container data persistence technique.

Docker demo

After you have tried using the SQL Server container image for Docker, you might want to know how Docker is used to improve development and testing. The following video shows how Docker can be used in a continuous integration and deployment scenario.

Next steps

For a tutorial on how to restore database backup files into a container, see Restore a SQL Server database in a Linux Docker container. Explore other scenarios, such as running multiple containers, data persistence, and troubleshooting.

Also, check out the mssql-docker GitHub repository for resources, feedback, and known issues.

Docker Engine is an open source containerization technology for building andcontainerizing your applications. Docker Engine acts as a client-serverapplication with:

• A server with a long-running daemon process dockerd.
• APIs which specify interfaces that programs can use to talk to andinstruct the Docker daemon.
• A command line interface (CLI) client docker.

The CLI uses Docker APIs to control or interact with the Dockerdaemon through scripting or direct CLI commands. Many other Docker applicationsuse the underlying API and CLI. The daemon creates and manage Docker objects,such as images, containers, networks, and volumes.

For more details, see Docker Architecture.

Docker user guide

To learn about Docker in more detail and to answer questions about usage andimplementation, check out the overview page in 'get started'.

Installation guides

The installation section shows you how to install Dockeron a variety of platforms.

Release notes

A summary of the changes in each release in the current series can now be foundon the separate Release Notes page

Feature Deprecation Policy

As changes are made to Docker there may be times when existing featuresneed to be removed or replaced with newer features. Before an existingfeature is removed it is labeled as 'deprecated' within the documentationand remains in Docker for at least 3 stable releases unless specifiedexplicitly otherwise. After that time it may be removed.

Users are expected to take note of the list of deprecated features eachrelease and plan their migration away from those features, and (if applicable)towards the replacement features as soon as possible.

The complete list of deprecated features can be found on theDeprecated Features page.

Licensing

Docker is licensed under the Apache License, Version 2.0. SeeLICENSE for the fulllicense text.