Skip To Content

Upgrade a single-machine ArcGIS Enterprise deployment on AWS

How you upgrade depends on how and when you created the ArcGIS Enterprise deployment on Amazon Web Services (AWS).

  • Any ArcGIS Enterprise deployment on AWS can be upgraded using a manual upgrade procedure. If you created the site before 10.8, you must use the manual procedure to upgrade.
  • If you created the base ArcGIS Enterprise deployment using a 10.8 or 10.8.1 single machine (arcgis-enterprise-allinone.template.json) Esri Amazon Web Services CloudFormation template, you can upgrade using Chef scripts.
  • If you created the base ArcGIS Enterprise deployment using the single machine ArcGIS Enterprise 10.9 Esri CloudFormation template (arcgis-enterprise-allinone.template.json), you can use a 10.9.1 CloudFormation template to upgrade it.
  • If you created the ArcGIS Enterprise deployment using 10.9 ArcGIS Enterprise Cloud Builder for Amazon Web Services, you can use 10.9.1 ArcGIS Enterprise Cloud Builder for AWS to upgrade it.

Before you upgrade

No matter which upgrade method you use, review the following information before you upgrade your deployment:

Upgrade using manual upgrade procedures

The manual upgrade procedure for updating software on your single-machine ArcGIS Enterprise deployment on Amazon Web Services is similar to updating software on-premises; download software updates from My Esri onto your Amazon Elastic Compute Cloud (EC2) instance, and apply the updates directly to your existing deployment. All ArcGIS Enterprise components must be running the same software version. The main difference in updating on AWS is how you create a backup of your existing deployment.

  1. Sign in to AWS Management Console and create an Amazon Machine Image (AMI) from your existing instance.

    This is your backup that you can use to redeploy if any issues arise during upgrading. If you have to redeploy, you must deploy using the same portal URL.

  2. If you are upgrading from 10.8.1 or earlier, obtain new Portal for ArcGIS and ArcGIS GIS Server licenses from Esri.
  3. Download new versions of Portal for ArcGIS, ArcGIS Web Adaptor, ArcGIS Server, and ArcGIS Data Store from My Esri.
  4. Make a remote desktop connection (Microsoft Windows) or SSH (Linux) connection to the machine on AWS. Connect as the arcgis user. Place all the software downloads on this machine.

    If this is the first time you are upgrading a deployment on a Windows AWS instance, change the arcgis user's password.

    If you deployed the ArcGIS Enterprise on this machine using the AWS Management Console, be sure this machine is allowed to create Amazon Simple Storage Service (S3) buckets in your AWS account, as the Portal for ArcGIS upgrade procedure creates an S3 bucket for temporary storage of the content directory. If you deployed using a CloudFormation template provided by Esri, the template already configured this.

  5. Follow the steps in Upgrade Portal for ArcGIS to update your portal and its web adaptor, and update your Portal for ArcGIS license (if required).
  6. Follow the single-machine site steps in Upgrade ArcGIS Server to update ArcGIS Server and its web adaptor, and update your ArcGIS Server site with an ArcGIS GIS Server license (if required).
  7. Note:

    You must upgrade ArcGIS Server before upgrading ArcGIS Data Store.

  8. If your deployment is on a Windows instance on AWS, follow the steps in Upgrade ArcGIS Data Store to update the data store.
  9. If you are upgrading a 10.5 or newer deployment on Linux on AWS, follow the steps in Upgrade ArcGIS Data Store to update the data store.
  10. If you are upgrading a 10.3.1, 10.4, or 10.4.1 deployment on Linux on AWS, you must make a copy of the hostidentifier.properties file before you begin upgrading. Follow these steps to copy the file and upgrade ArcGIS Data Store:
    1. Change directories to <ArcGIS Data Store installation directory>/arcgis/datastore/framework/etc.
    2. Make a copy of the hostidentfier.properties file and place the copy in a safe location.
    3. Install the new version of ArcGIS Data Store, but do not run the Data Store Configuration wizard.
    4. Run the stopdatastore.sh command to stop ArcGIS Data Store.

      The command is located in <ArcGIS Data Store installation directory>/arcgis/datastore.

    5. Replace the hostidentfier.properties file in <ArcGIS Data Store installation directory>/arcgis/datastore/framework/etc with the copy of the file you made in step b.
    6. Run the startdatastore.sh command to start ArcGIS Data Store.

      The command is located in <ArcGIS Data Store installation directory>/arcgis/datastore.

    7. Open the Data Store Configuration wizard or run the configuredatastore command utility to upgrade the data store.
  11. When you finish upgrading and testing your updated deployment, you can delete your backup AMI.

Upgrade using Chef scripts

If you created the ArcGIS Server site using a 10.8 or 10.8.1 Esri Amazon Web Services CloudFormation template, you can upgrade using Chef scripts.

Upgrade steps are different for deployments on Microsoft Windows and Ubuntu. Follow the instructions applicable to the operating system of your deployment.

Upgrade a single-machine ArcGIS Enterprise deployment on Windows

Follow these steps to use Chef to upgrade ArcGIS Enterprise on a single Amazon Elastic Compute Cloud (EC2) instance.

  1. Make a remote desktop connection to the EC2 instance.
  2. Download and install Chef or Cinc client 16.16.13. If you have an older version of Chef installed, update it to version 16.16.13.
  3. Download the 10.9.1 installation files from your account in My Esri and upload the files to a folder on the EC2 instance:

    • ArcGIS_Web_Adaptor_for_Microsoft_IIS_1091_180055.exe
    • Portal_for_ArcGIS_Windows_1091_180052.exe
    • ArcGIS_Server_Windows_1091_180041.exe
    • ArcGIS_DataStore_Windows_1091_180054.exe
    • Portal_for_ArcGIS_Web_Styles_Windows_1091_180053.exe

  4. If you are upgrading from 10.8 or 10.8.1, obtain the Portal for ArcGIS 10.9.1 authorization file (.json) and ArcGIS Server authorization licensed for ArcGIS GIS Server (.epc or .prvc) and place them on the EC2 instance.
  5. Download the ArcGIS Cookbook version 3.8.0 (arcgis-3.8.0-cookbooks.zip) to the EC2 instance, unzip the file, and place the contents of the unzipped file in the C:\chef folder.
  6. Delete the following folders:

    • C:\chef\nodes
    • C:\Users\Administrator\.chef\local-mode-cache

  7. Create a copy of the C:\chef\node.json file and rename it to upgrade_base_enterprise_allinone_windows.json.
  8. Open the upgrade_base_enterprise_allinone_windows.json file in a text editor and modify the following parameters:

    • Set the ArcGIS version to 10.9.1.
      "arcgis" : {
          "version": "10.9.1",
    • Set the ArcGIS archive repository to the folder where you placed the software files on the EC2 instance.
      "arcgis" : {
          "repository": {
      	  "archives": "<drive>\\<folder>"
    • Set the server authorization to the location of your ArcGIS Server 10.9.1 authorization file.
      "server" : {
          "authorization_file" : "<drive>:\\<folder path>\\My_New_Server.prvc"
    • Set the portal authorization to the location of your Portal for ArcGIS 10.9.1 authorization file.
      "portal" : {
          "authorization_file" : "<drive>:\\<folder path>\\my_new_portal.json",
    • Modify the run list to use the following recipes:
      "recipe[arcgis-enterprise::install_portal]",
      	   "recipe[arcgis-enterprise::webstyles]",
      	   "recipe[arcgis-enterprise::portal]",
          "recipe[arcgis-enterprise::portal_wa]",
          "recipe[arcgis-enterprise::server]",
          "recipe[arcgis-enterprise::server_wa]",
          "recipe[arcgis-enterprise::datastore]"

  9. Save and close the upgrade_base_enterprise_allinone_windows.json file.
  10. Open a command line window as an administrator, change directory to C:\chef, and run the following command: chef-client -z -j c:\chef\upgrade_base_enterprise_allinone_windows.json

The script runs to upgrade your deployment. This can take up to several hours, depending on the size of your deployment.

If the deployment upgrade fails, contact Esri support (in the United States) or your distributor (outside the United States) to help you troubleshoot.

Upgrade a single-machine ArcGIS Enterprise deployment on Ubuntu

Follow these steps to use Chef to upgrade ArcGIS Enterprise on a single EC2 instance.

  1. SSH to the EC2 instance as the ubuntu user.
  2. Use one of the following commands to download and install Chef or Cinc client 16.16.13. If you have an older version of Chef installed, update it to version 16.16.13.
    • Chef client: sudo curl -L https://omnitruck.chef.io/install.sh | sudo bash -s -- -v 16.16.13
    • Cinc client: sudo curl -L https://omnitruck.cinc.sh/install.sh | sudo bash -s -- -v 16.16.13
  3. Download the 10.9.1 installation files from your account in My Esri and upload the files to a folder on the EC2 instance:

    • ArcGIS_Web_Adaptor_Java_Linux_1091_180206.tar.gz
    • Portal_for_ArcGIS_Linux_1091_180199.tar.gz
    • ArcGIS_Server_Linux_1091_180182.tar.gz
    • ArcGIS_DataStore_Linux_1091_180204.tar.gz
    • Portal_for_ArcGIS_Web_Styles_Linux_1091_180201.tar.gz

  4. If you are upgrading from 10.8 or 10.8.1, obtain the Portal for ArcGIS 10.9.1 authorization file (.json) and ArcGIS Server authorization licensed for ArcGIS GIS Server (.epc or .prvc) and place them on the EC2 instance.
  5. Download the ArcGIS Cookbook version 3.8.0 (arcgis-3.8.0-cookbooks.tar.gz) to the EC2 instance, untar and unzip the file, and place the files contents in the /var/chef directory.
  6. Delete the /var/chef/nodes directory.
  7. Create a copy of the /etc/chef/node.json file and rename it to upgrade_base_enterprise_allinone_ubuntu.json.
  8. Open the upgrade_base_enterprise_allinone_ubuntu.json file in a text editor and modify the following parameters:

    • Set the ArcGIS version to 10.9.1.
      "arcgis" : {
          "version": "10.9.1",
    • Set the ArcGIS archive repository to the folder where you placed the software files on the EC2 instance.
      "arcgis" : {
          "repository": {
      	  "archives": "/<path and folder>"
    • Set the server authorization to the location of your ArcGIS Server 10.9.1 authorization file.
      "server" : {
          "authorization_file" : "/<path>/my_new_server.prvc"
    • Set the portal authorization to the location of your Portal for ArcGIS 10.9.1 authorization file.
      "portal" : {
          "authorization_file" : "/<path>/my_new_portal.json",
    • Modify the run list to use the following recipes:
      "recipe[arcgis-enterprise::install_portal]",
      	   "recipe[arcgis-enterprise::webstyles]",
      	   "recipe[arcgis-enterprise::portal]",
          "recipe[arcgis-enterprise::portal_wa]",
          "recipe[arcgis-enterprise::server]",
          "recipe[arcgis-enterprise::server_wa]",
          "recipe[arcgis-enterprise::datastore]"

  9. Save and close the upgrade_base_enterprise_allinone_ubuntu.json file.
  10. As the ubuntu user, change directory to /var/chef, and run the following command: sudo chef-client -z -j /etc/chef/upgrade_base_enterprise_allinone_ubuntu.json

The script runs to upgrade your deployment. This can take up to several hours, depending on the size of your deployment.

If the deployment upgrade fails, contact Esri support (in the United States) or your distributor (outside the United States) to help you troubleshoot.

Upgrade using a CloudFormation template

If you used the 10.9 arcgis-enterprise-allinone.template.json CloudFormation template to create a highly available base ArcGIS Enterprise deployment, you can use the 10.9.1 arcgis-enterprise-allinone-upgrade.template.json file to upgrade it. See Upgrade base ArcGIS Enterprise on one machine using CloudFormation for instructions.