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-license-manager cookbook arcgis-mission cookbook arcgis-notebooks cookbook arcgis-pro cookbook arcgis-repository cookbook arcgis-video 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-license-manager template arcgis-mission-server template arcgis-notebook-server template arcgis-portal template arcgis-pro template arcgis-server template arcgis-video-server 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-workflow-manager Deployment Template #

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

System Requirements #

Consult the ArcGIS Workflow Manager Server 11.4 system requirements documentation for the required/recommended hardware specification.

  • Chef Client 18, or
  • Cinc Client 18
  • 5.1.0

Supported Platforms #

  • Windows
    • Windows Server 2016 Standard and Datacenter
    • Windows Server 2019 Standard and Datacenter
    • Windows Server 2022 Standard and Datacenter
  • Linux
    • Ubuntu Server 22.04 LTS
    • Ubuntu Server 24.04 LTS
    • Red Hat Enterprise Linux Server 8
    • Red Hat Enterprise Linux Server 9
    • SUSE Linux Enterprise Server 15
    • Oracle Linux 8
    • Oracle Linux 9
    • Rocky Linux 8
    • Rocky Linux 9
    • AlmaLinux 9

For Linux deployments, 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:

Windows

  • ArcGIS_Server_Windows_114_192938.exe
  • ArcGIS_Server_Windows_114_192938.exe.001
  • ArcGIS_Workflow_Manager_Server_114_192956.exe

Linux

  • ArcGIS_Server_Linux_114_192977.tar.gz
  • ArcGIS_Workflow_Manager_Server_114_192994.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 arcgis-workflow-manager cookbook README file.

File Server Machine # 

chef-client -z -j workflow-manager-fileserver.json

First ArcGIS Workflow Manager Server Machine # 

chef-client -z -j workflow-manager-server.json

To federate ArcGIS Workflow Manager Server with Portal for ArcGIS and enable Workflow Manager Server function, run the following:

chef-client -z -j workflow-manager-server-federation.json

Additional ArcGIS Workflow Manager Server Machines # 

chef-client -z -j workflow-manager-server-node.json

ArcGIS Web Adaptor Machines #

If ArcGIS Web Adaptor is required, use arcgis-webadaptor deployment template to install and configure it before federating ArcGIS Workflow Manager Server with Portal for ArcGIS.

Install ArcGIS Workflow Manager Server Patches and Updates #

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

chef-client -z -j workflow-manager-server-patches.json

Check the list of patches specified by the arcgis.workflow_manager_server.patches attribute in the workflow-manager-server-patches-apply.json file, and apply the patches:

chef-client -z -j workflow-manager-server-patches-apply.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.

workflow-manager-fileserver #

Configures file shares for the ArcGIS Workflow Manager Server configuration store and server directories.

Required attribute changes:

  • arcgis.run_as_password - (Windows only) password of ‘arcgis’ Windows user account

workflow-manager-server-install #

Installs ArcGIS Workflow Manager Server without configuring it.

Required attribute changes:

  • arcgis.run_as_password - (Windows only) password of ‘arcgis’ Windows user account

workflow-manager-server-patches #

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

workflow-manager-server-patches-apply #

Applies ArcGIS Workflow Manager Server patches.

workflow-manager-server #

Installs and configures ArcGIS Workflow Manager Server.

Required attribute changes:

  • arcgis.run_as_password - (Windows only) password of ‘arcgis’ Windows user account.
  • arcgis.server.admin_username - Specify primary site administrator account user name.
  • arcgis.server.admin_password - Specify primary site administrator account password.
  • arcgis.server.authorization_file - Specify path to the ArcGIS Server software authorization file.
  • arcgis.server.directories_root - Replace ‘FILESERVER’ with the file server machine hostname or static IP address.
  • arcgis.server.config_store_connection_string - Replace ‘FILESERVER’ with the file server machine hostname or static IP address.
  • arcgis.workflow_manager_server.authorization_file - Specify path to the ArcGIS Workflow Manager Server role software authorization file.
  • arcgis.server.system_properties.WebSocketContextURL - Specify the ArcGIS Workflow Manager Server WebSocket context URL.
  • arcgis.server.system_properties.WebContextURL - Specify the ArcGIS Workflow Manager Server web context URL.

workflow-manager-server-node #

Installs ArcGIS Workflow Manager Server on the machine, authorizes the software, and joins the machine to an existing site.

Required attribute changes:

  • arcgis.run_as_password - (Windows only) password of ‘arcgis’ Windows user account
  • arcgis.server.admin_username - Specify ArcGIS Server primary site administrator account user name.
  • arcgis.server.admin_password - Specify ArcGIS Server primary site administrator account password.
  • arcgis.server.authorization_file - Specify path to the ArcGIS Server role software authorization file.
  • arcgis.server.primary_server_url - Specify URL of the ArcGIS Server site to join.
  • arcgis.workflow_manager_server.authorization_file - Specify path to the ArcGIS Workflow Manager Server role software authorization file.

workflow-manager-server-federation #

Federates ArcGIS Workflows Manager Server with Portal for ArcGIS and enables the Workflow Manager Server function.

Required attribute changes:

  • arcgis.server.admin_username - Specify ArcGIS Server primary site administrator account user name.
  • arcgis.server.admin_password- Specify ArcGIS Server primary site administrator account password.
  • arcgis.server.private_url - Specify ArcGIS Server private URL that will be used as the admin URL during federation.
  • arcgis.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.

workflow-manager-files #

The role downloads ArcGIS Workflow Manager 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

workflow-manager-s3files #

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

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