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.

Download and install Docker

There are two editions of Docker available for Linux systems: Docker Engine Community and Mirantis Container Runtime. ArcGIS Notebook Server supports both Red Hat Enterprise Linux and Ubuntu operating systems. The Docker edition you should use depends on the operating system (OS) your machine runs:

• If you're running Red Hat Enterprise Linux, only Mirantis Container Runtime is supported by ArcGIS Notebook Server.
• If you're running Ubuntu, you can use either Docker edition. See Docker and ArcGIS Notebook Server for more information about which edition is appropriate for your deployment.

Docker edition	Operating system	Notebook runtime (Container) image type
Docker Engine Community edition 20.10.13 or later	Ubuntu Server LTS 18.04 Ubuntu Server LTS 20.04 Ubuntu Server LTS 22.04 Rocky Linux 8.6	Linux
Mirantis Container Runtime version 20.10.13 or later	Ubuntu Server LTS 18.04 Ubuntu Server LTS 20.04 Ubuntu Server LTS 22.04 Red Hat Enterprise Linux Server 8.6 Oracle Linux 8.6 Rocky Linux 8.6	Linux

Note:

Because Docker is a third-party software component, this topic does not detail the complete steps to install Docker. Review and refer to the Docker website for the most up-to-date information.

Install Mirantis Container Runtime on Red Hat Enterprise Linux, Ubuntu, and Rocky Linux

To install Mirantis Container Runtime, you must obtain a trial or subscription for the software.

1. Uninstall any previous version of Docker on your machine.

   Refer to the Docker documentation for that version for complete uninstall steps.

2. Follow the steps in your Linux distribution's Mirantis Container Runtime install guide.

   Note:

   Currently Mirantis does not have a separate install guide for Rocky Linux, but the Red Hat Enterprise Linux install guide can be followed for installation on Rocky Linux.

   Note:

   The documents outlines the two methods you can use to install the software (from a Docker repository or through an RPM package).

3. Since Docker does not automatically start after installation and configuration, start the Docker daemon by running the following command:
   $ sudo systemctl start docker

4. Verify that Docker is properly installed and can access container images by running the following command:
   $ sudo docker run hello-world

Proceed to the Configure Docker settings and environments section below.

Install Docker Engine Community on Ubuntu

The Docker Engine Community edition is a free download but requires that you have a Docker account.

1. Uninstall any previous version of Docker on your machine.

   Refer to the Docker documentation for that version for complete uninstall steps.

2. Follow the steps in Get Docker CE for Ubuntu.

   The document outlines the two methods you can use to install the software (from a Docker repository or through a DEB package).

   The Docker daemon starts automatically after installation.

3. Verify that Docker is properly installed and can access container images by running the following command:
   $ sudo docker run hello-world

Proceed to the Configure Docker settings and environments section below.

Install Docker Engine Community on Rocky Linux

The Docker Engine Community edition is a free download but requires that you have a Docker account.

1. Uninstall any previous version of Docker on your machine.

   Refer to the Docker documentation for that version for complete uninstall steps.

2. Follow the steps in the Rocky Linux Docker guide.

   The Docker daemon starts automatically after installation.

3. Verify that Docker is properly installed and can access container images by running the following command:
   $ sudo docker run hello-world

Proceed to the Configure Docker settings and environments section below.

Configure Docker settings and environments

When the appropriate Docker edition is installed on your machine, configure Docker for use with ArcGIS Notebook Server.

1. Add your OS user account (or the account used to install ArcGIS Notebook Server) to the group named docker, which was automatically created at installation.

   $ sudo usermod -aG docker <ArcGIS Notebook Server install account>

2. Sign out and sign back in to the OS user account for the changes to take effect, and verify that you can run Docker commands from the account.

   $ docker run hello-world

   Docker uses the /var directory as its local registry for container images. During the upgrade process for subsequent releases, new images will be copied to the /var directory as well.

3. To avoid running out of disk space during future upgrades, ensure that the /var directory has at least 50 GB of disk space.
4. Switch to the root account. To change the directory Docker uses to store container images from /var/lib/docker to another directory, enter the commands below into a terminal (note that the commands will stop and restart Docker).

   In the following commands, the new target directory is /data/docker:

   1. systemctl stop docker.service
   2. mkdir /data/docker
   3. chmod 755 /var/lib/docker
   4. mv /var/lib/docker /data/docker
   5. ln -s /data/docker /var/lib/docker
   6. systemctl start docker.service

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