Deploy an ArcGIS Notebook Server site on many machines

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.

This workflow guides you through the first-time installation of ArcGIS Notebook Server on two or more machines.

When the PowerShell DSC for ArcGIS module is finished, your deployment will have the following components installed and configured:

• Two ArcGIS Notebook Server instances, in a single site, that is federated with an ArcGIS Enterprise portal that you specify
• One ArcGIS Web Adaptor registered with the ArcGIS Notebook Server site

Prerequisites

• Install Docker for ArcGIS Notebook Server and Hyper-V role on each machine that will host ArcGIS Notebook Server
• Configure a Distributed File System (DFS) for replication

Prepare your deployment

Before you run the command to the module in PowerShell DSC, you’ll need to obtain the necessary files and resources and add them to your local machine.

Note: We recommend using Windows Management Framework 5.x for the best experience.

Log in to the machine(s) on which you'll be installing ArcGIS Notebook Server. You should have administrative authority on the machine(s).

Use one of the following options to prepare the files either through GitHub or using the PowerShell Gallery:

Option 1: Prepare your deployment using GitHub

1. Clone this repository to each machine.
2. Add the "ArcGIS" modules folder to your PsModulePath, or copy the modules into the default PowerShell Modules folder (For example, C:\Program Files\WindowsPowerShell\Modules).
3. Log in to My Esri. Download your ArcGIS Notebook Server software installation files, ArcGIS Docker Image installation files (Advanced or Standard) and licenses.
4. Because you’re planning a multiple-machine deployment of ArcGIS Notebook Server, you will need to place the software installation files and licenses on each machine. You can do this in one of two ways:

• a) Add the files to a file share. Grant permissions on the file share to the LocalSystem Account of each machine that will be in the deployment. The LCM (Local Configuration Manager) component of PowerShell DSC runs as the Windows LocalSystem Account.
• b) Manually copy software installation files and licenses to each machine.

Option 2: Prepare your deployment using the PowerShell Gallery

1. Log in to my.esri.com. Download your ArcGIS Notebook Server software installation files, ArcGIS Docker Image installation files (Advanced or Standard) and licenses.
2. Because you’re planning a multiple-machine deployment of ArcGIS Notebook Server, you will need to place the software installation files and licenses on each machine. You can do this in one of two ways:

• a) Add the file to a file share. Grant permissions on the file share to the LocalSystem Account of each machine that will be in the deployment. The LCM (Local Configuration Manager) component of PowerShell DSC runs as the Windows LocalSystem Account.
• b) Manually copy software installation files and licenses to each machine.

3. In a PowerShell cmdlet, on each machine, use the command Install-Module arcgis to install the ArcGIS module from the PowerShell Gallery.
4. Download the SampleConfigs files from the GitHub repository.

Edit the configuration file

1. Open the GISServer-Notebook-MultiMachine.json file from the SampleConfigs folder on your local machine.
2. Replace the placeholder variables in brackets with your deployment properties and parameters. Refer to the Variables reference page for a full list.

Install your deployment

In PowerShell DSC, run the Invoke-ArcGISConfiguration cmdlet and provide the path to the configuration file as an input parameter. Mode, Credential, DebugSwitch and MappedDriveOverrideFlag are optional arguments.

Invoke-ArcGISConfiguration -ConfigurationParametersFile [[Path to Configuration JSON File]] -Mode [Install | InstallLicense | InstallLicenseConfigure | Uninstall | Upgrade] -Credential [Config RunAs - Optional] -MappedDriveOverrideFlag [$True | $False] -DebugSwitch

or

Invoke-ArcGISConfiguration [[Path to Configuration json File]] [Install | InstallLicense | InstallLicenseConfigure | Uninstall | Upgrade] -Credential [Config RunAs - Optional] -MappedDriveOverrideFlag [$True | $False] -DebugSwitch