Deploy an ArcGIS Notebook Server site on one machine

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 a single machine.

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

• One ArcGIS Notebook Server instance federated with an ArcGIS Enterprise portal that you specify
• One ArcGIS Web Adaptor registered with the ArcGIS Notebook Server

Prerequisites

• Install Docker for ArcGIS Notebook Server and Hyper-V role

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 on which you'll be installing ArcGIS Notebook Server. You should have administrative authority on the machine.

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 your local 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 to the 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 to the machine.
2. In a PowerShell cmdlet use the command Install-Module arcgis to install the ArcGIS module from the PowerShell Gallery.
3. Download the SampleConfigs files from the GitHub repository.

Edit the configuration file

1. Open the GISServer-Notebook.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