The Esri arcgis-datastore-primarystandby.template.json Amazon Web Services (AWS) CloudFormation template creates a relational or tile cache ArcGIS Data Store on two Amazon Elastic Compute Cloud (EC2) instances (primary and standby instances), which provides high availability for the ArcGIS Data Store deployment.
You have the following backup storage options when using this template:
- Store the backup files in Amazon Simple Storage Service (S3).
- Store the backup files on a separate file server (EC2 instance).
This template creates the following architecture in Amazon Web Services:
In the diagram above, backups are shown to be in either an EC2 file server or in an S3 bucket; backups are not created in both places.
License:
Certain icons in the diagram are used with permission from Amazon Web Services.
Tip:
Use this template as part of creating an ArcGIS Enterprise deployment as described in Deploy ArcGIS Enterprise components on separate machines using CloudFormation.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.
The account must have access to basic AWS services such as CloudFormation, Amazon Elastic Compute Cloud (EC2), Amazon Virtual Private Cloud (VPC), Amazon Simple Storage Service (S3), Systems Manager, Amazon CloudWatch, Lambda, AWS Identity and Access Management (IAM), Amazon DynamoDB, Secrets Manager, AWS Certificate Manager, and Amazon Relational Database Service (RDS).
- If you create a deployment on Ubuntu EC2 instances in AWS GovCloud, you need an AMI ID. If you want to use the base canonical Ubuntu AMI, follow the instructions in Esri Amazon Web Services CloudFormation templates to identify the ID.
- An Amazon Virtual Private Cloud (VPC) and subnets.
You can use one of the following CloudFormation templates to create a VPC: VPC with two public subnets or VPC with two public and private subnets with a NAT Gateway.
- The CloudFormation template.
Open and save a local copy of the arcgis-datastore-primarystandby.template.json template.
Required tasks
Complete the following tasks before running this template:
- You must have an ArcGIS GIS Server site that will be used as a hosting server for an ArcGIS Enterprise portal. Be sure the site doesn't already have the same type of ArcGIS Data Store registered to it that you will create with this template.
You can use the single machine ArcGIS Server site template or multiple machine ArcGIS Server site template to create the site.
- Configure passwords in AWS Secrets Manager (optional but recommended).
You can configure the passwords for accounts such as the site administrator user name 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.
Amazon EC2 Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
Platform Type | Required | Choose the operating system platform. Supported types are as follows:
|
EC2 Instance AMI ID | Optional | You can leave this parameter value empty. If you do, CloudFormation templates will use the latest Amazon Machine Image (AMI) ID for Windows or Ubuntu based on the type of platform you selected. Note:You cannot leave this parameter empty if you deploy in AWS GovCloud on an Ubuntu Server. See Esri Amazon Web Services CloudFormation templates for instructions on finding the ID for the base Ubuntu AMI from Canonical. The first time you use one of the default AMIs for a specific release, you must accept AWS Marketplace terms. If you want to use your own custom AMI, you can type the AMI ID using one of the following:
If you use a custom AMI, ensure that it meets the following requirements:
|
EC2 Instance Keypair Name | Required | Choose an EC2 keypair name to allow remote access to EC2 instances. |
Amazon VPC Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
VPC ID | Required | Choose a VPC ID. Note:This must be the same VPC as the ArcGIS GIS Server site to which you're adding this data store. |
Subnet ID 1 | Required | Choose a subnet ID. The subnet ID that you select must be within the VPC you have selected above. If you used an Esri CloudFormation template to create the VPC, you can get the subnet ID from that template's output parameters. |
Subnet ID 2 | Required | Choose a second subnet ID. This must be a different subnet ID than you used for Subnet ID 1. The subnet ID that you select must be within the VPC you specified for this deployment. If you used an Esri CloudFormation template to create the VPC, you can get the subnet ID from that template's output parameters. |
ArcGIS Server Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
Site Administrator User Name | Required | Provide a user name for the ArcGIS Server primary site administrator of the ArcGIS GIS Server site that will be used as the portal's hosting server. |
Site Administrator User Password | Required | Provide the 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 where your ArcGIS Server site is configured. Note:If you are registering the database 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. |
ArcGIS Data Store Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
Type | Required | Choose the ArcGIS Data Store type to deploy in primary-standby mode. Valid values are relational or tileCache. Tip:To create a spatiotemporal big data store, use the single-machine data store or cluster data store template. |
EC2 Instance Type | Required | Choose the EC2 instance type to use for the ArcGIS Data Store instances. The default is m5.2xlarge. The instances will be configured with the AWS Auto Recovery feature |
EC2 Instance Root Drive Disk Space | Required | Provide the size of the root drive in GB. The default is 100 GB. Minimum is 100 GB. Maximum is 1024 GB. |
Windows arcgis user password | Conditional | Provide a password for the arcgis user. This password is only required if you deploy on Windows. 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. |
Backup Store Type | Required | Choose the ArcGIS Data Store backup store type. The default type is FileSystem.
|
Backup Store EC2 Instance Type | Conditional | Choose an EC2 instance type for ArcGIS Data Store backup machine. The default instance type is m5.2xlarge. Note:This is required only if you specified FileSystem as the backup store type. |
Backup Store EC2 Instance Root Drive Disk Space | Conditional | Provide the size of the root drive in GB. The default is 100 GB. The minimum is 100 GB. The maximum is 1024 GB. Note:This is required only if you specified FileSystem as the backup store type. |
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. |
StopStackFunctionName | This is the Stop Stack Lambda function URL. You can use this lambda function to stop all EC2 instances in the stack. |
StartStackFunctionName | This is the Start Stack Lambda function URL. You can use this lambda function to start all EC2 instances in the stack that you previously stopped. |
Considerations
The following are important points to consider after creating a CloudFormation stack containing ArcGIS deployments:
- Do not delete any AWS resource created by this CloudFormation template. If you want to know what AWS resources have been created by this template, refer to the Resources tab of this stack in the AWS Management Console. Each resource created by an Esri CloudFormation template also has metadata tags. However, some of the resources do not show tags in the AWS Management Console.
- You can use the AWS Lambda functions that appear in your stack outputs (listed in the Outputs section of this page) to stop EC2 instances in this stack when they are not in use and start them again when required. These functions are useful to help you manage costs.
When you run the Lambda function to stop the EC2 instances in the deployment, the function returns a message that the instances are stopped. However, if the instances participate in an Auto Scaling group, the function must also detach the instances from the group. This can take up to 10 minutes to complete. Therefore, wait at least 10 minutes before you run the Lambda start function to restart the deployment.
Troubleshooting
If you observe any failures when creating this CloudFormation stack, see Troubleshoot ArcGIS deployments on AWS.