Install container engine for ArcGIS Notebook Server (Linux containers)

The steps below describe how to download, install, and configure the Docker container allocation software required by ArcGIS Notebook Server. See Docker and ArcGIS Notebook Server for an introduction to Docker and how it's used in ArcGIS Notebook Server.

Docker editions

Docker is available as Docker Desktop.

Operating system	Docker edition	Notebook runtime (Container) image type	Additional requirements
Windows Server 2019 Standard and Datacenter Windows Server 2022 Standard and Datacenter	Docker Desktop on Windows version 4.24.2	Linux	Hyper-V required

Note:

Docker is a third-party software component, and this topic may not provide the full process for installing it. See the Docker site for more information on the installation process.

Install Docker Desktop

Complete the following steps to install Docker Desktop:

1. Verify that Hyper-V is installed on your Windows machine by searching for the Hyper-V Manager application. If it's not, install it before proceeding. See the following Microsoft documentation for steps:
   • If your OS is Windows Server 2022 or Windows Server 2019, see Install the Hyper-V role on Windows Server.
   • If your OS is Windows 10, see Install Hyper-V on Windows 10.

   ArcGIS Notebook Server requires Docker Desktop for Windows (version 4.24.2).

2. In a browser, go to the Docker Desktop (Windows) download page in the Docker Hub store.
3. Sign in to your existing Docker Hub account, or sign up for a new account.
4. Download the Docker Desktop software.
5. Double-click Docker for Windows Installer to run it.
6. On the Configuration dialog box of the installer, uncheck Use WSL2 instead of Hyper-V.
7. Close the installer when it has completed.
8. Click the Docker Desktop button in the Start menu to start Docker.
9. Verify that Docker has started using one of the following methods:
   • Check the status of the Docker icon in the Windows system tray (typically located in the lower right corner of your screen).
   • Open the Command Prompt window and run the following commands:
     docker version
     docker run hello-world

     The first command provides the version of Docker on your machine; the second verifies that Docker can access and run container images.

Configure Docker settings

After Docker is installed on your machine, modify the settings described below.

Configure general settings

You'll use the Docker Remote API, which requires the use of port 2375. This port will only be used internally by ArcGIS Notebook Server and should be protected from external use.

1. Right-click the Docker button in the Windows system tray, and click Settings.
2. On the General page, check Expose daemon on tcp://localhost:2375 without TLS.

   You may receive a security warning. Ensure that your system administrator is aware that this port is used internally, and that no external access should be permitted to the port.

3. Uncheck Use the WSL2 based engine if it is checked.

Change the default Docker image installation location

To change the default Docker image installation location, follow the steps below:

1. Open the Docker Desktop settings.
2. Click Resources > Advanced.
3. Set the Disk image location to the chosen local directory path on your machine.

Set up file sharing

The Docker container must have access to the local drive that will be configured as the workspace directory or to a custom data directory for the notebook server. Perform the steps below during initial installation, and repeat them whenever the credentials for your Run As account change, or if the Run As account itself changes. If you create an account during ArcGIS Notebook Server installation, you'll be referred back to these steps.

1. Right-click the Docker button in the Windows system tray and click Settings.
2. From the settings menu, click Resources > File sharing.
3. Add the drive or directory path that will be used for your ArcGIS Notebook Server workspace or custom data directory.

   Note:

   If a workspace directory or a custom data directory does not currently exist—for example, C:\arcgisnotebookserver—create an ArcGIS Notebook Server site or register a data directory before performing this step.

   Note:

   Docker for Windows only supports local directories on Windows that are to be shared with Linux containers.

Configure advanced resources

You can use the Docker Desktop settings panel to limit the resources available to ArcGIS Notebook Server and the containers running in your server site.

1. Right-click the Docker button in your Windows system tray and click Settings. From the settings menu, click Resources > Advanced.
2. Change the following settings:
   • CPUs—The number of CPU cores available to containers on your machine. By default, this is set to two cores. You can update this value depending on the resources available on the machine and the CPU limits set for the notebook runtimes.
   • Memory—The amount of memory available to containers on your machine. By default, this is set to 2 GB. Increase this to a minimum of 6 GB. You may want to increase this value, depending on the resources available on the machine and the memory limits set for the notebook runtimes.
   • Swap—The amount of disk space that containers can use for memory if the above limit is reached.
   • Disk image size—The size of the disk image. Review and update this value as needed if installing Docker container images for Notebooks results in an out of disk space error.
   • Disk image location—The directory where containers and images are stored.

   Note:

   Revisit this step anytime you make updates to CPU or memory resources configured for notebook runtimes.

3. When you're satisfied with the resource limits you've set, click Apply.

Once the Docker component is installed, restart your machine. You must restart the machine each time you install or upgrade the Docker component.

You are now ready to install ArcGIS Notebook Server on your machine.