ArcGIS Cookbook

repository·main·Indexed 43 days ago

https://github.com/esri/arcgis-cookbook

A collection of Chef cookbooks and deployment templates for automating the installation, configuration, and deployment of ArcGIS software. Includes the arcgis-enterprise cookbook for components like ArcGIS Server, Portal for ArcGIS, and ArcGIS Data Store, as well as the arcgis-egdb cookbook for automating enterprise geodatabases in SQL Server and PostgreSQL.

Tokens
230.6K
Snippets
334
Records
818
Agent score
54%

What's inside ArcGIS Cookbook

  1. Overview of arcgis-enterprise-base Deployment Template

    main

    The arcgis-enterprise-base template provides Chef Zero JSON files containing sample recipes and attributes for deploying ArcGIS Enterprise 11.1. It supports both single-machine and multi-machine architectures.

    The template automates the deployment of the following components:

    • Portal for ArcGIS
    • ArcGIS Server (configured as the hosting server for the portal)
    • ArcGIS Data Store (configured as both relational and tile cache data stores)
    • ArcGIS Web Adaptor:
      • Windows: Configures Microsoft IIS and installs ArcGIS Web Adaptor for Microsoft IIS.
      • Linux: Installs Apache Tomcat and ArcGIS Web Adaptor (Java Platform).
  2. Overview of ArcGIS Chef Cookbooks

    main
    The arcgis-cookbook repository provides Chef cookbooks designed to automate the installation and configuration of various ArcGIS components using the Chef IT automation tool. These cookbooks allow for repeatable, code-driven deployments of ArcGIS software and supporting infrastructure.
  3. Overview of the arcgis-egdb cookbook

    main

    The arcgis-egdb cookbook automates the creation of enterprise geodatabases (EGDB) in SQL Server or PostgreSQL databases. It also handles the registration of these databases with an ArcGIS Server site as the site's managed database.

    Supported Platforms

    • Windows: Windows 11, Windows Server 2016, 2019, 2022, 2025
    • Linux: Ubuntu Server (20.04, 22.04, 24.04 LTS), Red Hat Enterprise Linux Server (8, 9), SUSE Linux Enterprise Server 15, Oracle Linux (8, 9), Rocky Linux (8, 9), AlmaLinux 9

    Supported Database Servers

    • Amazon RDS for SQL Server
    • Amazon RDS for PostgreSQL
    • Amazon Aurora PostgreSQL-compatible
  4. Overview of the arcgis-enterprise-base Deployment Template

    main

    The arcgis-enterprise-base template provides Chef Zero JSON files and sample recipes for deploying base ArcGIS Enterprise environments. It supports both single-machine and multi-machine architectures.

    Included Components:

    • Portal for ArcGIS
    • ArcGIS Server (configured as the hosting server for the portal)
    • ArcGIS Data Store (configured as relational and tile cache data stores)
    • ArcGIS Web Adaptor (two installations: one for the portal and one for the hosting server)
      • Windows: Configures Microsoft IIS and installs ArcGIS Web Adaptor for Microsoft IIS.
      • Linux: Installs Apache Tomcat and ArcGIS Web Adaptor (Java Platform).
  5. Configure the esri-iis cookbook

    main

    The esri-iis cookbook automates the enablement of IIS, installation of features required by ArcGIS Web Adaptor (IIS), HTTPS configuration, and starting the IIS service.

    To use this cookbook, you must ensure the following dependencies are present in your Chef run list:

    • openssl
    • windows

    Supported platforms include Windows 11 and Windows Server versions 2016, 2019, 2022, and 2025.

    {
      "arcgis": {
        "iis": {
          "domain_name": "domain.com",
          "keystore_file": "C:\\chef\\cache\\domain.com.pfx",
          "keystore_password": "<password>"
        }
      },
      "run_list": [
        "recipe[esri-iis]"
      ]
    }
  6. Configure machine roles for ArcGIS Notebook Server deployment

    main

    The ArcGIS Notebook Server deployment template uses Chef recipes to manage different machine roles. Depending on your deployment architecture, you will use one or more of the following roles:

    Storage and Files

    • notebook-server-fileserver: Installs NFS and configures shares for the ArcGIS Notebook Server configuration store and server directories.
    • notebook-server-files: Downloads ArcGIS Notebook Server setup archives from https://downloads.arcgis.com to the local repository defined by arcgis.repository.local_archives.
    • notebook-server-s3files: Downloads setup archives from a specific S3 bucket defined by arcgis.repository.server.s3bucket.

    Installation and Management

    • notebook-server-install: Installs ArcGIS Notebook Server without performing any configuration.
    • notebook-server: Installs Docker and ArcGIS Notebook Server, authorizes the software, and creates a new site.
    • notebook-server-node: Installs Docker and ArcGIS Notebook Server, authorizes the software, and joins the machine to an existing site.
    • 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.

    Patching

    • notebook-server-patches: Downloads patches from the global ArcGIS software repository into a local folder.
    • notebook-server-patches-apply: Applies downloaded ArcGIS Notebook Server patches.