Skip To Content

Update a multimachine ArcGIS Enterprise deployment on AWS

Updating software on your multimachine ArcGIS Enterprise deployment on Amazon Web Services (AWS) is similar to updating software on-premises. You can download software updates from My Esri onto your Amazon Elastic Compute Cloud (EC2) instances, and apply the updates directly to your existing deployment. All ArcGIS Enterprise components on each machine must be running the same software version.

Note:

If you created your deployment with an AWS CloudFormation template, you may be able to use a CloudFormation template to upgrade. See ArcGIS upgrades on Amazon Web Services to determine if the software version you want to upgrade can be achieved with a CloudFormation template.

Prepare to update components

Before you upgrade your ArcGIS Enterprise deployment, create a backup of the deployment.

  1. Download new versions of Portal for ArcGIS, ArcGIS Web Adaptor, ArcGIS Server, and ArcGIS Data Store from My Esri. Also obtain new licenses from Esri
  2. Ensure that ports 5701-5703, 7005, 7099, 7199, 7654, 7120, 7220, 29079-29090, and 4369 are allowed by your firewall and not currently in use by another application. Highly available deployments use these ports for intermachine communications and synchronization.
  3. Confirm you have a shared directory configured for tile cache data store backups. If you do not have one, configure one before upgrading. Only file shares are supported on AWS at this time.
  4. Make sure no one is connected to your ArcGIS Enterprise portal or ArcGIS Server sites.
    Caution:

    Do not stop the Portal for ArcGIS, ArcGIS Server, or ArcGIS Data Store services. If you stop those services, the webgisdr utility will fail to create a backup of your deployment.

  5. Create a full backup of your deployment using the webgisdr utility installed with Portal for ArcGIS. This is your backup that you can use to redeploy the previous software versions if any issues arise during the upgrade process.

    Note:

    If you have a spatiotemporal big data store in your deployment, use the ArcGIS Data Store backupdatastore utility to create a backup of it, as it is not included in the backup created by the webgisdr tool.

Upgrade Portal for ArcGIS

First, upgrade Portal for ArcGIS.

  1. Make a remote desktop connection (Microsoft Windows) or SSH (Linux) connection to your Portal for ArcGIS machine on AWS. If your portal is highly available, connect to one of the Portal for ArcGIS machines on AWS. Connect as the arcgis user.

    If this is the first time you are upgrading Portal for ArcGIS on Windows on AWS, change the arcgis user's password. You must do this for every machine in the deployment, and the password must be the same for all machines.

    If you deployed ArcGIS Enterprise 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.

  2. Place the new Portal for ArcGIS and ArcGIS Web Adaptor installations and (if applicable) your new Portal for ArcGIS license file on this machine.
  3. If your portal contains only one Portal for ArcGIS machine, follow the steps to upgrade Portal for ArcGIS to update the portal machine and its web adaptor, and, if necessary, authorize Portal for ArcGIS with your new license file.
  4. If your portal is highly available, repeat steps 1 and 2 for the second Portal for ArcGIS machine. Next, follow the steps to upgrade a highly available portal to update software and, if necessary, authorize Portal for ArcGIS on each machine with your new license file.
    Note:
    At 10.6, a highly available portal uses available ports between 5701 and 5703 to keep item, group, and user information synchronized between machines. This range is narrower than previous versions. When upgrading a highly available portal, open these ports to enable communication between machines.

Upgrade ArcGIS Server

Upgrade your portal's hosting server and any additional ArcGIS Server sites you federated with your portal.

If you are upgrading from 10.4.1 or an earlier release, provide an ArcGIS GIS Server license when upgrading the portal's hosting server. Which license you provide when upgrading federated servers depends on the role the ArcGIS Server fills in your deployment.

Note:

You must upgrade ArcGIS Server sites before upgrading ArcGIS Data Store.

  1. Make a remote desktop connection (Windows) or SSH (Linux) connection as the arcgis user to the ArcGIS Server SITEHOST machine for your portal's hosting server.
  2. Place the new ArcGIS Server and ArcGIS Web Adaptor installations and your ArcGIS GIS Server license file on this machine.
  3. If your ArcGIS Server site contains only one machine, follow the instructions in Upgrade ArcGIS Server to upgrade a single-machine site.
  4. If your ArcGIS Server site contains multiple machines, repeat steps 1 and 2 on each machine. Next, follow the instructions in Upgrade ArcGIS Server to upgrade a multiple-machine site.
  5. If you manually federated additional ArcGIS Server sites with your portal, connect to those machines and upgrade the software and licenses for those sites as well.

Upgrade ArcGIS Data Store

If you have more than one type of data store configured with your portal's hosting server, upgrade each of them.

When upgrading a highly available relational or tile cache data store, upgrade the primary machine before you upgrade the standby machine.

  1. Make a remote desktop connection (Windows) or SSH (Linux) connection as the arcgis user to each machine where ArcGIS Data Store is installed.
  2. Place the ArcGIS Data Store installation file on each machine.
  3. If your deployment is running on Windows on AWS, follow the steps in Upgrade ArcGIS Data Store to update each type of data store.
  4. If you are upgrading a 10.5 or newer deployment on Linux on AWS, follow the steps in Upgrade ArcGIS Data Store to update each type of data store.
  5. 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 on each machine before you begin upgrading. Follow these steps to copy the file and upgrade ArcGIS Data Store:
    1. On each ArcGIS Data Store machine, change directories to <ArcGIS Data Store installation directory>/arcgis/datastore/framework/etc.
    2. Make a copy of the hostidentfier.properties file for each machine and place the copy in a safe location.
    3. Install the new version of ArcGIS Data Store on each machine, but do not run the Data Store Configuration wizard.
    4. Run the stopdatastore.sh command on each machine to stop ArcGIS Data Store.

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

    5. One each machine, 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 on each machine to start ArcGIS Data Store.

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

    7. For relational and tile cache data stores, use either the Data Store Configuration wizard or the configuredatastore command utility on the primary machine to upgrade. You can run the Data Store Configuration wizard or the configuredatastore command utility from any machine in a spatiotemporal big data store to upgrade it.
    8. Test the upgraded deployment.

After upgrading ArcGIS Data Store to 10.8

At 10.8, highly available tile cache data stores should contain at least three machines. If you require a highly available tile cache data store, follow these steps to add another tile cache data store EC2 instance to your ArcGIS Enterprise deployment and redistribute the scene cache data.

If you perform these steps, be sure no one is publishing or altering scene layers until you finish this process.

  1. Launch an EC2 instance in the same region as the other instances in your deployment.
  2. Connect to the instance and install ArcGIS Data Store.
  3. Configure a tile cache data store with the hosting ArcGIS Server site in your ArcGIS Enterprise deployment.
  4. Use the backupdatastore utility to create a backup of the tile cache data store.
  5. Use the restoredatastore utility with the replicatedata option set to true to overwrite the contents of the tile cache data store and rebalance the content across all the machines.
  6. Run the ArcGIS Server validate REST command to confirm that your scene cache data is highly available.

Test the upgraded deployment

Test the upgraded ArcGIS Enterprise deployment to be sure all services are running and accessible and your normal workflows still work.

Once testing is successfully completed, you can delete the backup you created before upgrading as it cannot be used to restore to your upgraded machines.

Tip:

Create a full backup of the successfully upgraded deployment using the webgisdr utility so that you have a base backup of this version of your deployment.