Chef Cookbooks for ArcGIS

Overview Overview Get Started About Chef Cookbooks About Deployment Templates Cookbooks Version Compatibility Changelog Chef Cookbooks arcgis-desktop cookbook arcgis-egdb cookbook arcgis-enterprise cookbook arcgis-geoevent cookbook arcgis-insights cookbook arcgis-mission cookbook arcgis-notebooks cookbook arcgis-pro cookbook arcgis-repository cookbook arcgis-workflow-manager cookbook esri-iis cookbook esri-tomcat cookbook Deployment Templates arcgis-datastore template arcgis-desktop template arcgis-egdb template arcgis-enterprise-base template arcgis-geoevent-server template arcgis-mission-server template arcgis-notebook-server template arcgis-portal template arcgis-pro template arcgis-server template arcgis-webadaptor template arcgis-workflow-manager template Tutorials Deploy Base ArcGIS Enterprise on Single Machine Deploy Highly Available ArcGIS Enterprise Patch base ArcGIS Enterprise on single machine Upgrade base ArcGIS Enterprise on single machine Video: Automate ArcGIS Enterprise deployments with Chef Support FAQs Reference Troubleshooting Tips
Versions:

arcgis-notebook-server Deployment Template #

The template contains Chef Zero JSON files with sample recipes and attributes for different ArcGIS Notebook Server machine roles.

System Requirements #

Consult the ArcGIS Notebook Server 11.0 system requirements documentation for the required/recommended hardware specification.

  • Chef Client 16, or
  • Cinc Client 16
  • 4.0.0

Supported Platforms #

  • Ubuntu Server 18.04 LTS
  • Ubuntu Server 20.04 LTS
  • Red Hat Enterprise Linux Server 8 (Mirantis Container Runtime must be installed before running Chef)

Enable running sudo without password for the user running the Chef client.

Required ArcGIS Software Repository Content #

The following ArcGIS setup archives must be available in the ArcGIS software repository directory for both initial deployments and upgrades:

  • ArcGIS_Notebook_Docker_Advanced_110_182934.tar.gz
  • ArcGIS_Notebook_Docker_Standard_110_182933.tar.gz
  • ArcGIS_Notebook_Server_Linux_110_183044.tar.gz
  • ArcGIS_Notebook_Server_Samples_Data_Linux_110_183049.tar.gz

The ArcGIS software repository directory is specified by the arcgis.repository.archives attribute. By default, it is set to local directory C:\Software\Archives on Windows and /opt/software/archives on Linux. However, it is recommended to create an ArcGIS software repository located on a separate file server that is accessible from all the machines in the deployment for the user account used to run the Chef client.

Ensure that the directory specified by the arcgis.repository.setups attribute has enough space for setups extracted from the setup archives.

Initial Deployment Workflow #

The following is the recommended initial deployment workflow for the template machine roles:

  1. Install the recommended version of Chef Client or Cinc Client.
  2. Download and extract ArcGIS Chef cookbooks into the Chef workspace directory.
  3. Update the required attributes within the template JSON files.
  4. Run the Chef client on the machines as administrator/superuser using the JSON files specific to the machine roles (one machine can be used in multiple roles).

For additional customization options, see the list of supported attributes described in the arcgis-notebooks cookbook README file.

File Server Machine # 

chef-client -z -j notebook-server-fileserver.json

First ArcGIS Notebook Server Machine # 

chef-client -z -j notebook-server.json

Additional ArcGIS Notebook Server Machines # 

chef-client -z -j notebook-server-node.json

After all the ArcGIS Notebook Server machines are configured, federate the Notebook Server site with Portal for ArcGIS.

chef-client -z -j notebook-server-federation.json

ArcGIS Web Adaptor Machine #

If ArcGIS Web Adaptor is required, use the arcgis-webadaptor deployment template to install and configure it.

Install ArcGIS Notebook Server Patches and Updates #

To install software patches and updates after the initial installation or upgrade of ArcGIS Notebook Server, download ArcGIS Notebook Server patches from the global ArcGIS software repository into a local patches folder:

chef-client -z -j notebook-server-patches.json

Check the list of patches specified by the arcgis.notebook_server.patches attribute in the notebook-server-patches-apply.json file, and apply the patches:

chef-client -z -j notebook-server-patches-apply.json

Upgrade Workflow #

It’s not recommended to use the templates to upgrade if the sites were not initially deployed using the templates.

To upgrade an ArcGIS Notebook Server site deployed using the arcgis-notebook-server deployment template to the 11.0 version, you will need:

  • ArcGIS Notebook Server 11.0 setup archive,
  • ArcGIS Notebook server 11.0 samples data,
  • ArcGIS Notebook Server 11.0 Docker container images,
  • ArcGIS Web Adaptor 11.0 setup archive, if Web Adaptors were installed in the initial deployment,
  • ArcGIS Notebook Server 11.0 software authorization file,
  • The original JSON files used for the initial deployment or the last upgrade.

General Upgrade Notes #

Upgrading an ArcGIS Notebook Server deployment may take several hours. During that time, the deployment will be unavailable to the users.

Before you upgrade, it’s recommended that you make backups of your deployment. To prevent operating system updates during the upgrade process, it’s recommended to install all the recommended/required OS updates before upgrading ArcGIS Notebook Server.

The attributes defined in the upgrade JSON files must match the actual deployment configuration. To make upgrade JSON files, update the 11.0 template JSON files by copying the attribute values from the JSON files used for the initial deployment or the last upgrade.

In some cases, the difference between the original and the new deployment template JSON files will be only in the value of the arcgis.version attribute. In those cases, the easiest way to make the upgrade JSON files is to change the arcgis.version attribute values to the new version. But the new deployment templates might change recipes in the run_list, add new attributes, and introduce other significant changes. To keep the upgrade JSON files in sync with the new deployment templates version, it’s recommended to update the new deployment templates instead of the original JSON files.

The copy_attributes.rb tool can be used to copy attributes values from one JSON file to another. The tool copies only attibutes present in the destination template JSON file. The tool is located in the templates/tools directory in the ArcGIS cookbooks archive. To run copy_attributes.rb, use the chef-apply command that comes with the Chef/Cinc Client.

chef-apply ./templates/tools/copy_attributes.rb <source JSON file path> <destination template JSON file path>

After running the tool, update the destination JSON file attributes that are specific to the new JSON file template and attributes specific to the new ArcGIS Notebook Server version, such as software authorization files.

On each deployment machine, before upgrading the ArcGIS software, upgrade the configuration management subsystem components:

  1. Back up the original JSON files used for the initial deployment or the last upgrade into a local directory.
  2. Upgrade Chef Client or Cinc Client to the recommended version.
  3. Empty the Chef/Cinc workspace directory.
  4. Download and extract the recommended version of ArcGIS Chef cookbooks into the Chef/Cinc workspace directory.

Upgrade from 10.7.1, 10.8, or 10.8.1 #

Upgrading ArcGIS Notebook Server deployments to 11.0 requires upgrading all ArcGIS Notebook Server machines.

Note that in 11.0, ArcGIS Web Adaptor is installed using the new arcgis-webadaptor deployment template.

  1. Upgrade the first ArcGIS Notebook Server machine.

    Copy attributes from the original notebook-server-primary.json JSON file created from a 10.7.1-10.8.1 arcgis-notebook-server template to the notebook-server.json file of the 11.0 arcgis-notebook-server template.

    chef-apply ./templates/tools/copy_attributes.rb <original JSON files>/notebook-server-primary.json <arcgis--notebook-server 11.0 template>/notebook-server.json

    Verify that attributes are correct in notebook-server.json.

    On the first ArcGIS Notebook Server machine, run the following command:

    chef-client -z -j <arcgis--notebook-server 11.0 template>/notebook-server.json

  2. Upgrade the additional ArcGIS Notebook Server machines.

    Copy attributes from the original notebook-server-node.json JSON file created from a 10.7.1-10.8.1 arcgis-notebook-server template to the notebook-server-node.json file of the 11.0 arcgis-notebook-server template.

    chef-apply ./templates/tools/copy_attributes.rb <original JSON files>/notebook-server-node.json <arcgis-notebook-server 11.0 template>/notebook-server-node.json

    Verify that attributes are correct in notebook-server-node.json.

    On each additional ArcGIS Notebook Server machine in the site, run the following command to upgrade ArcGIS Notebook Server:

    chef-client -z -j <arcgis-notebook-server 11.0 template>/notebook-server-node.json

  3. Upgrade ArcGIS Web Adaptor used with ArcGIS Notebook Server.

    Copy attributes from the original notebook-server-primary.json JSON file created from a 10.7.1-10.8.1 arcgis-notebook-server template to the arcgis-notebook-server-webadaptor.json file of the 11.0 arcgis-webadaptor template.

    chef-apply ./templates/tools/copy_attributes.rb <original JSON files>/notebook-server-primary.json <arcgis-webadaptor 11.0 template>/arcgis-notebook-server-webadaptor.json

    Verify that attributes are correct in arcgis-notebook-server-webadaptor.json.

    Run the following command on the first ArcGIS Notebook Server machine to upgrade ArcGIS Web Adaptor:

    chef-client -z -j <arcgis-webadaptor 11.0 template>/arcgis-notebook-server-webadaptor.json

Upgrade from 10.9 or 10.9.1 #

Upgrading ArcGIS Notebook Server deployments from 10.9 or 10.9.1 to 11.0 requires upgrading all ArcGIS Notebook Server machines. The file server machine does not require any changes.

Note that in 11.0, ArcGIS Web Adaptor is installed using the new arcgis-webadaptor deployment template.

  1. Upgrade the first ArcGIS Notebook Server machine.

    Copy attributes from the original notebook-server.json JSON file created from the 10.9 or 10.9.1 arcgis-notebook-server template to the notebook-server.json file of the 11.0 arcgis-notebook-server template.

    chef-apply ./templates/tools/copy_attributes.rb <original JSON files>/notebook-server.json <arcgis-notebook-server 11.0 template>/notebook-server.json

    Verify that attributes are correct in notebook-server.json.

    On the first ArcGIS Notebook Server machine, run the following command:

    chef-client -z -j <arcgis-notebook-server 11.0 template>/notebook-server.json

  2. Upgrade the additional ArcGIS Notebook Server machines.

    Copy attributes from the original notebook-server-node.json JSON file created from the 10.9 or 10.9.1 arcgis-notebook-server template to the notebook-server-node.json file of the 11.0 arcgis-notebook-server template.

    chef-apply ./templates/tools/copy_attributes.rb <original JSON files>/notebook-server-node.json <arcgis-server 11.0 template>/notebook-server-node.json

    Verify that attributes are correct in notebook-server-node.json.

    On each additional ArcGIS Notebook Server machine, run the following command to upgrade ArcGIS Notebook Server:

    chef-client -z -j <arcgis-server 11.0 template>/notebook-server-node.json

  3. Upgrade ArcGIS Notebook Server Web Adaptors.

    Copy attributes from the original notebook-server-webadaptor.json JSON file created from the 10.9 or 10.9.1 arcgis-notebook-server template to the arcgis-notebook-server-webadaptor.json file of the 11.0 arcgis-webadaptor template.

    chef-apply ./templates/tools/copy_attributes.rb <original JSON files>/notebook-server-webadaptor.json <arcgis-webadaptor 11.0 template>/arcgis--notebook-server-webadaptor.json

    Verify that attributes are correct in arcgis--notebook-server-webadaptor.json.

    On each ArcGIS Notebook Server Web Adaptor machine, run the following command to upgrade ArcGIS Web Adaptor:

    chef-client -z -j <arcgis-webadaptor 11.0 template>/arcgis-notebook-server-webadaptor.json

Machine Roles #

The JSON files included in the template provide recipes for the deployment machine roles and the most important attributes used by the recipes.

notebook-server-fileserver #

Installs NFS and configures shares for the ArcGIS Notebook Server configuration store and server directories.

notebook-server-install #

Installs ArcGIS Notebook Server without configuring it.

notebook-server-patches #

Downloads ArcGIS Notebook Server patches from the global ArcGIS software repository into a local patch folder.

notebook-server-patches-apply #

Applies ArcGIS Notebook Server patches.

notebook-server #

Installs Docker and ArcGIS Notebook Server, authorizes the software, and creates a site.

Required attribute changes:

  • arcgis.notebook_server.admin_username - Specify primary site administrator account user name.
  • arcgis.notebook_server.admin_password - Specify primary site administrator account password.
  • arcgis.notebook_server.authorization_file - Specify path to the ArcGIS Notebook Server role software authorization file.
  • arcgis.notebook_server.directories_root - Replace ‘FILESERVER’ with the file server machine hostname or static IP address.
  • arcgis.notebook_server.config_store_connection_string - Replace ‘FILESERVER’ with the file server machine hostname or static IP address.

notebook-server-node #

Installs Docker and ArcGIS Notebook Server, authorizes the software, and joins the machine to the existing site.

Required attribute changes:

  • arcgis.notebook_server.admin_username - Specify primary site administrator account user name.
  • arcgis.notebook_server.admin_password - Specify primary site administrator account password.
  • arcgis.notebook_server.authorization_file - Specify path to the ArcGIS Notebook Server role software authorization file.
  • arcgis.server.primary_server_url - Specify URL of the ArcGIS Notebook Server site to join.

notebook-server-unregister-node #

Unregisters the machine from the ArcGIS Notebook Server site.

notebook-server-federation #

  • Federates ArcGIS Notebook Server with Portal for ArcGIS and enables the NotebookServer role.

Required attribute changes:

  • arcgis.notebook_server.admin_username - Specify ArcGIS Server primary site administrator account user name.
  • arcgis.notebook_server.admin_password- Specify ArcGIS Server primary site administrator account password.
  • arcgis.notebook_server.private_url - Specify ArcGIS Server private URL that will be used as the admin URL during federation.
  • arcgis.notebook_server.web_context_url - Specify ArcGIS Server Web Context URL that will be used as the services URL during federation.
  • arcgis.portal.admin_username - Specify Portal for ArcGIS administrator user name.
  • arcgis.portal.admin_password - Specify Portal for ArcGIS administrator password.
  • arcgis.portal.private_url - Specify Portal for ArcGIS private URL.

notebook-server-files #

The role downloads ArcGIS Notebook Server setup archives from https://downloads.arcgis.com to the local ArcGIS software repository specified by the arcgis.repository.local_archives attribute.

If the arcgis.repository.shared attribute is set to true, then a network share is created for the local software repository.

Required attribute changes:

  • arcgis.repository.server.username - ArcGIS Online user name
  • arcgis.repository.server.password - ArcGIS Online user password

notebook-server-s3files #

The role downloads ArcGIS Notebook Server setup archives from the S3 bucket specified by the arcgis.repository.server.s3bucket attribute to the local ArcGIS software repository.

The role requires AWS Tools for PowerShell to be installed on Windows machines and AWS Command Line Interface on Linux machines.

The following attributes are required unless the machine is an AWS EC2 instance with a configured IAM Role:

  • arcgis.repository.server.aws_access_key - AWS account access key id
  • arcgis.repository.server.aws_secret_access_key - AWS account secret access key