Upgrade deployments

A new version of ArcGIS Enterprise Cloud Builder for Microsoft Azure is available with each ArcGIS release. Images that contain the latest version of ArcGIS software are also available at each release. The images and ArcGIS Enterprise Cloud Builder for Microsoft Azure versions you use must match. For example, to deploy ArcGIS Enterprise using 10.8.1 images or to manage 10.8.1 deployments, you must use the 10.8.1 version of ArcGIS Enterprise Cloud Builder for Microsoft Azure.

You can use ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.8 or 10.8.1 to upgrade deployments you created with ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.6.x or 10.7.x. These deployments are now considered version 1 (V1) deployments. You can use ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.8.1 to upgrade deployments you created using ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.8. These are considered version 2 (V2) deployments. When you access an earlier deployment from a later version of ArcGIS Enterprise Cloud Builder for Microsoft Azure, the only management options available are to connect to, delete, or upgrade.

Tip:

You can have different versions of ArcGIS Enterprise Cloud Builder for Microsoft Azure on the same machine, allowing you to manage version-specific deployments.

For deployments earlier than 10.6, no management options are available from ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.8.1.

Upgrade 10.8 deployments using Cloud Builder

If you created a 10.8 deployment using ArcGIS Enterprise Cloud Builder for Microsoft Azure, you can use ArcGIS Enterprise Cloud Builder for Microsoft Azure to upgrade it to the current release.

Follow these steps to upgrade a 10.8 deployment you launched with ArcGIS Enterprise Cloud Builder for Microsoft Azure:

1. Download and install the latest version of ArcGIS Enterprise Cloud Builder for Microsoft Azure.
2. Start ArcGIS Enterprise Cloud Builder for Microsoft Azure.
3. Sign in to Microsoft Azure.

   If you want to use the Microsoft Azure Government cloud and have an Azure Government subscription, check U.S. Government Cloud.

4. Choose the Azure subscription that contains the ArcGIS Server site or ArcGIS Enterprise deployment you want to upgrade and click next.
5. Show V2 Sites and, in the Deployments list, open the details for the deployment you want to upgrade.
6. Click the Upgrade Deployment button .

   When you start the upgrade process from any part of an ArcGIS Enterprise deployment, Cloud Builder upgrades the whole deployment. For example, if you clicked the Upgrade Deployment button for an ArcGIS GeoAnalytics Server site that is federated with your ArcGIS Enterprise portal, ArcGIS Enterprise is upgraded in its entirety, not just the ArcGIS GeoAnalytics Server site.

7. Provide the user name and password of the machine administrator.

   Use the same account you used when you created the instances in your deployment.

8. If your machines are part of an existing Windows domain in your Azure environment, click Domain Join Options.
   1. On the Domain Join Options dialog box, be sure the Join Existing Windows Domain? option is checked.
   2. Provide the name of the Active Directory domain.
   3. Provide the user name and password for the domain administrator.
   4. Click apply.
9. Click next to proceed to the License and Credentials page.
10. Under Site License, provide the current license files.
    • If you are upgrading an ArcGIS Enterprise portal, browse to the Portal for ArcGIS license file for the Portal License and choose the user type for the license. The user type affects what apps portal members can use.
    • If you are upgrading an ArcGIS Enterprise portal (which always includes a hosting server) or a stand-alone ArcGIS GIS Server site, browse to the ArcGIS GIS Server license for the Server License.
11. Type the user name and password for Site Administrator.

    You created this account when you created your deployment. Use the same user name and password.

12. Type the user name and password for ArcGIS Service Account.

    You created this account when you created your deployment. Use the same user name and password.

13. Click next to proceed to Deployment Options.
14. Choose or create a storage account to hold the artifacts Cloud Builder creates during the upgrade process. To create a storage account, follow these steps:
    1. Type a name for the storage account. Names must be unique. Click Check Availability to confirm the storage account name is unique.
    2. Choose the Azure region where your storage will reside.
    3. Choose an existing resource group or create one.
    4. Choose the type of redundancy for your storage account: Geo-Redundant, Locally Redundant, or Read-Access Geo-Redundant.

       See Azure Storage redundancy in the Microsoft Azure documentation for a description of each redundancy option.

    5. Once the storage account is created, click close.
15. Click next.
16. If you are upgrading an ArcGIS Enterprise portal that includes federated servers, provide the ArcGIS Service Account user name and password for each federated server. Click next when you finish.

    Be sure the licenses you provide are for the correct role for each federated server.

17. Review the settings in the Summary pane. If anything needs to be changed, click back to go to the page where you need to change the information.

    Tip:

    Click save summary to save your upgrade information to a text file so you can refer to it for information such as license file location and the names of machines that were upgraded.

18. Click save automation artifacts to export an archive (.zip) file containing information and files you can use in automation scripts to perform future upgrades of this deployment.
    1. Browse to a location on the local disk where the archive file will be created and type a name for the file.
    2. Choose the type of automation format you'll use.
    3. Click generate to create the file.
    4. To automate future upgrades, run the Upgrade-ArcGISSite.ps1 script in an Azure PowerShell console or, to upgrade with Azure CLI on Bash, run the upgradeArcGISSite.sh script in a bash shell.
19. When all settings are correct and you have saved the files you need, click finish to upgrade.

    Note:

    Upgrades can take up to five hours to complete, depending on the size of your deployment. Do not close ArcGIS Enterprise Cloud Builder for Microsoft Azure until the upgrade process finishes for all components in the deployment.

    If you encounter problems upgrading, see the log files created in the %temp% directory on the machine where Cloud Builder is installed. By default, that directory is C:\Users\<your login>\AppData\local\temp.

20. If your deployment contains a federated ArcGIS Notebook Server site, you must complete the following steps after the deployment upgrade successfully finishes:
    1. Make a remote desktop connection to the virtual machine where ArcGIS Notebook Server is running. Connect using the machine administrator credentials you specified when you created the deployment.
    2. Copy the new ArcGIS Docker images to the ArcGIS Notebook Server machine and run the postinstallation utility.

Upgrade 10.6 to 10.7.1 deployments using Cloud Builder

If you created a 10.6, 10.6.1, 10.7, or 10.7.1 deployment using ArcGIS Enterprise Cloud Builder for Microsoft Azure, you can use ArcGIS Enterprise Cloud Builder for Microsoft Azure to upgrade it to the current release; however, these deployments remain V1 deployments.

Note:

Before you upgrade, read the following information and complete the preparatory tasks that are applicable to your deployment and upgrade path:

• Ensure that at least 20 percent of your operating system disk is free on all virtual machines before you upgrade. In many cases, a disk size of 128 GB is sufficient. If you do not have sufficient free disk space, add more space. If your deployment is using HDD disks and you need more than 128 GB of space, you must upgrade the disk to SSD before you can add more space.
• If you created a multimachine deployment using Cloud Builder 10.6 or 10.6.1, you must update the load balancer probe port setting from 7080 to 7443 to account for the changes in the software to ensure network communication uses Transport Layer Security (TLS). To change the load balancer probe port setting, sign in to your account in the Microsoft Azure Portal and locate the Azure internal load balancer associated with machines where Portal for ArcGIS is running. The load balancers are typically named InternalLoadBalancer-Portal. Change the lbprobe port value from 7080 to 7443. For further instructions on editing ports for internal load balancers, see the Microsoft Azure documentation.

• You must open ports 29079-29090 and 4369 in the firewall of a multimachine ArcGIS Enterprise deployment before upgrading. You also must confirm a shared file location is set for tile cache data store backups before upgrading.

• Even if you upgrade a 10.6.x or 10.7.x deployment to 10.8.1, it is still considered a V1 deployment because it was created with the earlier deployment framework.

Follow these steps to upgrade a deployment you launched with ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.6, 10.6.1, 10.7, or 10.7.1:

1. Download and install the latest version of ArcGIS Enterprise Cloud Builder for Microsoft Azure.
2. Start ArcGIS Enterprise Cloud Builder for Microsoft Azure.
3. Sign in to Microsoft Azure.

   If you want to use the Microsoft Azure Government cloud and have an Azure Government subscription, check U.S. Government Cloud.

4. Choose the Azure subscription that contains the ArcGIS Server site or ArcGIS Enterprise deployment you want to upgrade and click next.
5. Show V1 Sites and, in the Deployments list, open the details for the deployment you want to upgrade.
6. Click the Upgrade Deployment button .

   When you start the upgrade process from any part of an ArcGIS Enterprise deployment, Cloud Builder upgrades the whole deployment. For example, if you clicked the Upgrade Deployment button for an ArcGIS GeoAnalytics Server site that is federated with your ArcGIS Enterprise portal, ArcGIS Enterprise is upgraded in its entirety, not just the ArcGIS GeoAnalytics Server site.

7. Provide the user name and password of the machine administrator.

   Use the same account you used when you created the instances in your deployment.

8. If your machines are part of an existing Windows domain in your Azure environment, click Domain Join Options.
   1. On the Domain Join Options dialog box, be sure the Join Existing Windows Domain? option is checked.
   2. Provide the name of the Active Directory domain.
   3. Provide the user name and password for the domain administrator.
   4. Click apply.
9. Click next to proceed to the License and Credentials page.
10. Under Site License, provide current license files.
    • If you are upgrading an ArcGIS Enterprise portal, browse to the Portal for ArcGIS license file for the Portal License and choose the user type for the license. The user type affects what apps portal members can use.
    • If you are upgrading an ArcGIS Enterprise portal (which always includes a hosting server) or a stand-alone ArcGIS GIS Server site, browse to the ArcGIS GIS Server license for the Server License.
11. Type the user name and password for Site Administrator.

    You created this account when you created your deployment. Use the same user name and password.

12. Type the user name and password for ArcGIS Service Account.

    You created this account when you created your deployment. Use the same user name and password.

13. Click next to proceed to Deployment Options.
14. Choose or create a storage account to hold the artifacts Cloud Builder creates during the upgrade process. To create a storage account, follow these steps:
    1. Type a name for the storage account. Names must be unique. Click Check Availability to confirm the storage account name is unique.
    2. Choose the Azure region where your storage will reside.
    3. Choose an existing resource group or create one.
    4. Choose the type of redundancy for your storage account: Geo-Redundant, Locally Redundant, or Read-Access Geo-Redundant.

       See Azure Storage redundancy in the Microsoft Azure documentation for a description of each redundancy option.

    5. Once the storage account is created, click close.
15. Click next.
16. If you are upgrading an ArcGIS Enterprise portal that includes federated servers, provide the license file and ArcGIS Service Account user name and password for each federated server. Click next when you finish.

    Be sure the licenses you provide are for the correct role for each federated server.

17. Review the settings in the Summary pane. If anything needs to be changed, click back to go to the page where you need to change the information.

    Tip:

    Click save summary to save your upgrade information to a text file so you can refer to it for information such as license file location and the names of machines that were upgraded.

18. Click save automation artifacts to export an archive (.zip) file containing information and files you can use in automation scripts to perform future upgrades of this deployment.
    1. Browse to a location on the local disk where the archive file will be created and type a name for the file.
    2. Choose the type of automation format you'll use.
    3. Click generate to create the file.
    4. To automate future upgrades, run the Upgrade-ArcGISSite.ps1 script in an Azure PowerShell console or, to upgrade with Azure CLI on Bash, run the upgradeArcGISSite.sh script in a bash shell.
19. When all settings are correct and you have saved the files you need, click finish to upgrade.

    Note:

    Upgrades can take up to five hours to complete, depending on the size of your deployment. Do not close ArcGIS Enterprise Cloud Builder for Microsoft Azure until the upgrade process finishes for all components in the deployment.

    If you encounter problems upgrading, see the log files created in the %temp% directory on the machine where Cloud Builder is installed. By default, that directory is C:\Users\<your login>\AppData\local\temp.

20. If your deployment contains a federated ArcGIS Notebook Server site, you must complete the following steps after the deployment upgrade successfully finishes:
    1. Make a remote desktop connection to the virtual machine where ArcGIS Notebook Server is running. Connect using the machine administrator credentials you specified when you created the deployment.
    2. Copy the new ArcGIS Docker images to the ArcGIS Notebook Server machine and run the postinstallation utility.

Upgrade 10.5.1 or earlier deployments

If you created your deployment using ArcGIS Enterprise Cloud Builder for Microsoft Azure 10.5.1 or earlier versions, you need to upgrade the ArcGIS software just as you do on-premises installations. Even if your deployment is currently on 10.8, if you created it at an earlier release and upgraded it to 10.8, you need to continue manually upgrading the components.

See the following upgrade topics for each component you need to upgrade:

• Portal for ArcGIS
• ArcGIS Server
• ArcGIS Data Store
• ArcGIS Pro
• ArcGIS Desktop

Once you've upgraded the software, do not use ArcGIS Enterprise Cloud Builder for Microsoft Azure for postdeployment operations such as registering databases with ArcGIS Server, installing CA-issued-certificates, managing machines, or upgrading.

Upgrade registered databases that contain geodatabases

If you have managed databases registered with your ArcGIS Server site or you enabled a geodatabase in any of the databases you registered to your ArcGIS Server site, you can upgrade the geodatabase after upgrading ArcGIS Server or ArcGIS Pro in your Azure deployment. See Upgrade an enterprise geodatabase in SQL Server in the ArcGIS Pro help for instructions.