The Esri arcgis-datastore-cluster-upgrade.template.json Amazon Web Services (AWS) CloudFormation template upgrades a tile cache or spatiotemporal ArcGIS Data Store 10.9, 10.9.1, 11.0, 11.1, or 11.2 on multiple Amazon Elastic Compute Cloud (EC2) instances that you created using the template described in Deploy ArcGIS Data Store in cluster mode using CloudFormation.
The arcgis-datastore-cluster-upgrade.template.json template upgrades ArcGIS Data Store on multiple EC2 instances.
Prerequisites
Prerequisites can be grouped by the items—such as files and accounts—that you must obtain and the tasks you must perform before running the CloudFormation template.
Required items
You need the following before running this template:
- An Amazon Web Services account with access to the deployment to be upgraded.
- An existing ArcGIS Data Store deployment in cluster mode that you created using the Esri Amazon Web Services CloudFormation template arcgis-datastore-cluster.template.json.
- The upgrade CloudFormation template, arcgis-datastore-cluster-upgrade.template.json.
Note:
To upgrade your deployment, run this upgrade CloudFormation template, which will create a new CloudFormationstack. Do not update the existing deployment CloudFormation stack using this template.
Required tasks
Complete the following tasks before running this template:
- You must upgrade the ArcGIS GIS Server site (hosting server) that this data store is registered with before you upgrade ArcGIS Data Store.
- Configure passwords in AWS Secrets Manager (optional but recommended).
You can configure the passwords for accounts such as the site administrator username and the Windows arcgis user password in AWS Secrets Manager. This provides you with a secret Amazon Resource Name (ARN). Use the ARN in place of a password in the template parameters when you launch a stack. If you don't use AWS Secrets Manager for storing passwords, you must type passwords in plain text in the template parameter when launching the stack.
Note:
When creating a secret ARN in AWS Secrets Manager for a password to be used with Esri CloudFormation templates, you must use the Other types of secrets secret type and use the Plaintext option. For more information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS.
Tip:
By default, CloudFormation deletes partially created resources if stack creation fails. This is helpful because it removes unusable deployments from your account, but it can make it difficult to troubleshoot. To retain the stack in its failed state, disable the Rollback on failure CloudFormation stack creation option before launching the stack. See Setting AWS CloudFormation options in the AWS help for more information.
Parameters
Refer to the following tables for descriptions of the parameters used in this CloudFormation template. Tables are grouped by parameter type.
ArcGIS Data Store Configuration
| Parameter name | Required or not | Parameter description |
|---|---|---|
Platform Type | Required | Choose the platform type of your existing ArcGIS Data Store deployment.
|
AutoScaling Group Name | Required | Provide the name of the Auto Scaling group where your existing ArcGIS Data Store cluster is configured. If you created the existing deployment using an Esri CloudFormation template or Cloud Builder, you can find the Auto Scaling group name in the existing CloudFormation stack's Resources section in AWS Management Console. The logical ID of the resource is AutoScalingGroup. |
Type | Required | Choose the data store type of your existing ArcGIS Data Store deployment. Valid values are tileCache or spatiotemporal. |
Windows arcgis user password | Conditional | This password is only required if you deployed on Windows. Provide the password for the arcgis user of your existing deployment. You can either enter a plain text password or the ARN of your secret ID from AWS Secrets Manager. It's a best practice to manage your passwords in AWS Secrets Manager. For information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS. |
ArcGIS Server Configuration
| Parameter name | Required or not | Parameter description |
|---|---|---|
Site Administrator User Name | Required | Provide the username for the ArcGIS Server primary site administrator of your existing site. |
Site Administrator User Password | Required | Provide a password for the ArcGIS Server primary site administrator. You can either type a plain text password or the ARN of your secret ID from AWS Secrets Manager. For more information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS. The password or secret ID you provide must match that of the existing primary site administrator. |
ArcGIS Server EC2 Instance ID | Required | Choose an EC2 instance ID from the ArcGIS Server site with which the data store is configured. Note:If the data store is registered with a multimachine ArcGIS Server site, you can choose any EC2 instance ID from the ArcGIS Server site. Do not choose a file server EC2 instance. |
Outputs
When your stack is created successfully, you can see the following output parameters on the Outputs tab of the CloudFormation stack in AWS Management Console.
| Output name | Output description |
|---|---|
DeploymentLogsURL | This is the URL for the Amazon CloudWatch logs where all deployment logs are stored. You can refer to these logs for troubleshooting purposes if your deployment fails. |
Considerations
The following are important points to consider after creating a CloudFormation stack containing ArcGIS deployments:
- Once your stack is created successfully (in other words, the stack status is CREATE_COMPLETE), that means your ArcGIS Data Store deployment is upgraded successfully. You can validate this by signing in to ArcGIS Server Manager and validating the data store.
- If the CloudFormation stack failed to create successfully (in other words, the stack status is CREATE_FAILED), you can troubleshoot the error as mentioned in the page linked to from the Troubleshooting section below. After pinpointing the root cause of the error and taking required action, you can delete the failed stack and create a new one to upgrade the existing ArcGIS Data Store deployment.
Troubleshooting
If you observe any failures when creating this CloudFormation stack, see Troubleshoot ArcGIS deployments on AWS.