ArcGIS Notebook Server is an ArcGIS Server role that is licensed and configured for the purpose of hosting notebooks. The server role uses containers to host and run ArcGIS Notebooks and provides a separate and secure environment for the notebooks without interfering with the host operating system.
If your ArcGIS Notebook Server site has been set up, refer to the software user guide or administrator guide.
Multiple machines can be joined in an ArcGIS Notebook Server site, allowing you to expand your machine resources for hosting and running notebooks. To deploy a multiple-machine site, additional steps are required, as detailed in Join a machine to an ArcGIS Notebook Server site (Windows containers) and Join additional machines to an ArcGIS Notebook Server site (Linux containers) .
Use this guide to install and configure the software. The installation process for ArcGIS Notebook Server is different from that for other ArcGIS Server roles. Read the installation guide carefully, and complete the installation steps in the order they are presented.
ArcGIS Notebook Server and Windows Containers
ArcGIS Notebook Server supports Windows Containers and Mirantis Container Runtime on Windows.
Note:
ArcGIS Notebook Server on Windows Server 2022 will default to using Windows containers.
For more information, see Mirantis Container Runtime and ArcGIS Notebook Server (Windows containers).
Prerequisites and constraints for Windows systems
If you deploy ArcGIS Notebook Server on Windows machines, there are a number of prerequisites and constraints to consider. These do not apply when deploying ArcGIS Notebook Server on Linux machines.
- ArcGIS Notebook Server uses the third-party components Mirantis Container Runtime (Windows containers) and Docker (Linux containers) to manage containers. When you deploy ArcGIS Notebook Server on Windows machines, you must either use Mirantis Container Runtime or the Docker Desktop edition of Docker, which does not include support or maintenance from Docker but is considered feature-complete.
- It's recommended that you use Windows Server 2022 or Windows Server 2019 machines in a production environment of ArcGIS Notebook Server. Windows 10 machines are only supported for development environments.
Note:
Starting at 11.1, ArcGIS Notebook Server on Windows Server 2022 will default to using Windows containers. To use Linux containers on Windows Server 2022, you must set the useWindowsContainers system property to false in System > Properties and reset the factory runtimes in Notebooks > Runtimes from the Notebook Server administrative directory to false.
Prerequisites and constraints for Windows containers
Consider the following when using Windows containers:
- ArcGIS Notebook Server on Windows containers uses Mirantis Container Runtime, which currently only supports Windows Server 2022.
- When ArcGIS Notebook Server and Mirantis Container Runtime are deployed on multiple machines, you no longer need to configure replication (DFS) for your workspace directory. The workspace directory can be shared as a path mounted on a drive with Mirantis Container Runtime.
Prerequisites and constraints for Linux containers
Consider the following when using Linux containers:
- If you deploy ArcGIS Notebook Server with Linux containers on Windows Server 2022 or Windows Server 2019, you can use Docker Desktop (version 4.24.2 or earlier). Note that the Docker documentation for the current version does not mention Windows Server 2022 or Windows Server 2019 in its system requirements.
Note:
To use Linux containers on Windows Server 2022, you must set the useWindowsContainers system property to false in System > Properties and reset the factory runtimes in Notebooks > Runtimes from the Notebook Server administrative directory to false.
- ArcGIS Notebook Server with Linux containers uses a Linux emulator named MobyLinuxVM, which is contained within the Hyper-V environment, to manage its containers.
- ArcGIS Notebook Server with Linux containers requires the Hyper-V role to already be installed on Windows Server and Windows 10.
- Certain virtualization environments do not allow Hyper-V to be enabled and operated in Windows. As a result, ArcGIS Notebook Server cannot be installed and operated in such environments. ArcGIS Notebook Server supports virtualized environments hosted on VMware vSphere 6.7 or later that have hardware-assisted virtualization (nested virtualization) enabled for the guest OS. Before you install ArcGIS Notebook Server, ensure that Docker is installed on your machine and supports Linux containers.
- ArcGIS Notebook Server supports multiple-machine sites. In Windows systems, Docker does not support mounting shared drives on containers, so the workspace directory must remain local on each machine. Because users can launch containers and open notebooks on each machine in a multiple-machine site, it's necessary that the content in the workspace directory be synchronized across machines. The steps to configure one method of replication are provided in Configure DFS replication for ArcGIS Notebook Server.
Software installation
An overview of the steps to install ArcGIS Notebook Server is below. Complete each step in order, and review all sections of the installation guide documentation as you go.
- Read the following introductory material in this guide to become familiar with the software:
- Complete your ArcGIS Enterprise base deployment. Whether you are upgrading from an earlier version or installing a new deployment, you must have all software components—the ArcGIS Enterprise portal, an ArcGIS Server site designated as the hosting server, and an instance of ArcGIS Data Store—installed and running the 11.3 software.
- Review the system requirements and make any necessary adjustments to the machine you'll be using. Read the entire system requirements topic.
- Obtain your materials from the My Esri website: the software installer and the container images corresponding to your license level.
Note:
The ArcGIS Notebook Server Standard license is included with both the ArcGIS Enterprise Standard and Advanced licenses. The ArcGIS Notebook Server Advanced license requires an additional purchase.
Note:
For users with a Standard license, download the Standard container image. For users with an Advanced license, download both the Standard and the Advanced container images.
- Install the ArcGIS Notebook Server software on your machine. You can do this using the provided installer or install silently. There are separate help topics for these two options.
- Configure your ArcGIS Notebook Server site after installation (Windows containers)
- Configure your ArcGIS Notebook Server site (Linux containers). The three primary steps are as follows:
- Create a site for your ArcGIS Notebook Server machine.
- Add your OS account to a Docker group.
- Run the post installation utility to configure Docker with ArcGIS Notebook Server.
- Join any additional machines (Windows containers) to your new site
- Join any additional machines (Linux containers) to your new site. This help topic also explains other requisites for multiple-machine site setup.
- If you're setting up a multiple-machine site, you must configure a replication method for the workspace directory. An explanation of this process and steps for a particular replication method are provided in Configure DFS replication for ArcGIS Notebook Server.
- Install and configure an instance of ArcGIS Web Adaptor with your ArcGIS Notebook Server site. To use a reverse proxy server with the site, there are instructions to do so as well.
- Configure your site with your ArcGIS Enterprise portal. Federate the server site with the portal, and designate it as the portal's notebook server. This allows you to create ArcGIS Notebooks that run in your ArcGIS Notebook Server site. Finally, create one or more custom portal member roles to grant your notebook authors the necessary privileges.