arcgis-repository cookbook #

arcgis-repository cookbook downloads ArcGIS software setup archives from remote to local repositories.

Supported ArcGIS versions #

• 10.7
• 10.7.1
• 10.8
• 10.8.1
• 10.9
• 10.9.1
• 11.0

Platforms #

• Windows 8 (8.1)
• Windows 10
• Windows Server 2008 (R2)
• Windows Server 2012 (R2)
• Windows Server 2016
• Windows Server 2019
• Windows Server 2022
• Ubuntu Server 18.04 and 20.04 LTS
• Red Hat Enterprise Linux Server 8
• SUSE Linux Enterprise Server 15
• Oracle Linux 8

Dependencies #

The following cookbooks are required:

• s3_file

Attributes #

• node['arcgis']['repository']['setups'] = Path to folder with the ArcGIS software setups. Default path is %USERPROFILE%\Documents on Windows and /opt/arcgis on Linux.
• node['arcgis']['repository']['archives'] = Local or network ArcGIS software repository path. The default path on Windows is %USERPROFILE%\\Software\\Esri. On Linux, it is /opt/software/esri.
• node['arcgis']['repository']['local_archives'] = Local ArcGIS software repository path. The default path on Windows is %USERPROFILE%\\Software\\Esri. On Linux, it is /opt/software/esri.
• node['arcgis']['repository']['shared'] = If true, a network share is created for the local repository path. Default value is false.
• node['arcgis']['repository']['patches'] = Path to folder with hot fixes and patches for ArcGIS Enterprise software. The default path on Windows is %USERPROFILE%\Software\Esri\patches. On Linux, it is /opt/software/esri/patches.
• node['arcgis']['repository']['server']['url'] = Remote ArcGIS software repository URL. The default URL is https://devops.arcgis.com/arcgis.
• node['arcgis']['repository']['server']['key'] = Remote ArcGIS software repository key.
• node['arcgis']['repository']['server']['s3bucket'] = Remote ArcGIS software repository S3 bucket name.
• node['arcgis']['repository']['server']['region'] = Remote ArcGIS software repository S3 bucket region id.
• node['arcgis']['repository']['server']['aws_access_key'] = AWS access key ID. IAM role credentials are used if access key is not specified.
• node['arcgis']['repository']['server']['aws_secret_access_key'] = AWS secret access key.
• node['arcgis']['repository']['files'] = File names mapped to SHA256 checksum and the remote path subfolder attributes. Default value is nil.
• node['arcgis']['repository']['patch_notification']['url'] = ArcGIS patch notification file URL. The default URL is https://downloads.esri.com/patch_notification/patches.json.
• node['arcgis']['repository']['patch_notification']['products'] = An array or ArcGIS product names used to filter downloaded patches. If the array is empty, patches are downloaded for all products. The default value is [].
• node['arcgis']['repository']['patch_notification']['versions'] = An array of ArcGIS versions used to filter downloaded patches. The default value is [node['arcgis']['version']].

Recipes #

default #

Calls arcgis-repository::files recipe.

files #

Downloads files from the ArcGIS software repository.

Attributes used by the recipe:

{
  "arcgis": {
    "repository": {
      "local_archives": "C:\\Software\\Archives",
      "server": {
        "url": "https://downloads.arcgis.com",
        "token_service_url": "https://www.arcgis.com/sharing/rest/generateToken",
        "username": "<ArcGIS Online username>",
        "password": "<ArcGIS Online>"
      },
      "files": {
        "<file name>": {
          "subfolder": "<folder>"
        }
      }
    }
  },
  "run_list": [
    "recipe[arcgis-repository::files]"
  ]
}

fileserver #

Creates a repository directory and a network share for it if the arcgis.repository.shared attribute is set to true.

{
   "arcgis":{
      "repository":{
         "shared": false,
         "local_archives":"C:\\Software\\Archives"
      }
   },
   "run_list":[
      "recipe[arcgis-repository::fileserver]"
   ]
}

patches #

Downloads patches for specific ArcGIS products and versions from the ArcGIS software repository.

Attributes used by the recipe:

{
  "arcgis": {
    "version": "10.9.1",
    "repository": {
      "local_patches": "C:\\Software\\Archives\\Patches",
      "patch_notification": {
        "products": ["ArcGIS Server"]
      }
    }
  },
  "run_list": [
    "recipe[arcgis-repository::patches]"
  ]
}

s3files #

Downloads files from the ArcGIS software repository in S3 to the local repository specified by the node[‘arcgis’][‘repository’][‘local_archives’] attribute.

Attributes used by the recipe:

{
   "arcgis":{
      "repository":{
         "local_archives":"C:\\Software\\Archives",
         "server":{
            "region": "us-east-1",
            "s3bucket":"arcgisstore-us-east-1",
            "aws_access_key":"<access_key>",
            "aws_secret_access_key":"<secret_key>"
         },
         "files": {
          "<file name>": {
            "subfolder": "<folder>"
          }
        }
      }
   },
   "run_list":[
      "recipe[arcgis-repository::s3files]"
   ]
}

s3files2 #

Downloads files from the ArcGIS software repository in S3 to the local repository specified by the node[‘arcgis’][‘repository’][‘local_archives’] attribute.

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

Attributes used by the recipe:

{
   "arcgis":{
      "repository":{
         "local_archives":"C:\\Software\\Archives",
         "server":{
            "region": "us-east-1",
            "s3bucket":"arcgisstore-us-east-1",
            "aws_access_key":"<access_key>",
            "aws_secret_access_key":"<secret_key>"
         },
         "files": {
          "<file name>": {
            "subfolder": "<folder>"
          }
        }
      }
   },
   "run_list":[
      "recipe[arcgis-repository::s3files2]"
   ]
}