The Esri arcgis-server-ha.template.json Amazon Web Services (AWS) CloudFormation template creates a highly available GIS Server site, ArcGIS Image Server site, or ArcGIS GeoAnalytics Server site. If you create an ArcGIS GeoAnalytics Server site, you must federate it with an ArcGIS Enterprise portal. You can federate the other types or use them as stand-alone sites.
This template configures the ArcGIS Server Amazon Elastic Compute Cloud (EC2) instances in an AWS Auto Scaling group, which offers advantages such as capacity planning based on certain criteria, better fault tolerance, better availability, and better cost management.
Choose one of the following options for ArcGIS Server directory storage when using this template:
- Use cloud storage (Amazon S3 and DynamoDB) for the configuration store and a file share (EC2 instance) for shared directories.
- Place the configuration store and shared directories on a file server (EC2 instance) only.
Automatic recovery is set for the file server; if one machine fails, the services will still be available.
You can also include ArcGIS Web Adaptor on each ArcGIS Server machine.
This template creates the following architecture in Amazon Web Services:
License:
Certain icons in the diagram are used with permission from Amazon Web Services.
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).
- An ArcGIS Server license. License files must include the server licensing role you need: ArcGIS GIS Server, ArcGIS Image Server, or ArcGIS GeoAnalytics Server.
- An SSL certificate file (in .pfx format) and corresponding password.
The certificate must be from a certifying authority.
- An Amazon Virtual Private Cloud (VPC) and subnets.
If you are creating a stand-alone site, 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.
If you intend to federate this site with an ArcGIS Enterprise portal, ensure that all components in the same ArcGIS Enterprise deployment run in the same VPC.
- 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.
- The CloudFormation template.
Open and save a local copy of the arcgis-server-ha.template.json template.
Required tasks
Complete the following tasks before running this template:
- Prepare a deployment Amazon Simple Storage Service (S3) bucket in your AWS account. You will specify the bucket name in the template when you launch the stack.
- Create a bucket or use an existing S3 bucket. You must be the owner of the bucket.
- Upload your ArcGIS software authorization files to the bucket.
- Upload your SSL certificate file to the deployment bucket.
- Configure a Domain Name System (DNS).
You must have a fully qualified domain name for your ArcGIS Server site. This domain name must exist before you launch this stack, and it must be resolvable. Contact your IT department if you are unsure how to obtain a fully qualified domain name and configure a DNS.
- 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. |
Elastic IP Address Allocation ID | Optional | Provide the Allocation ID of an elastic IP address in this format, eipalloc-XXXXXXXX. You may need an elastic IP address if you want to map the site domain name to the elastic IP address and access the EC2 instance via RDP/SSH from outside of the AWS environment. Leave this parameter empty if you don't want to assign an elastic IP address to the EC2 instance. |
Amazon VPC Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
VPC ID | Required | Choose a VPC ID. Note:All ArcGIS Enterprise components that are part of the same deployment must be deployed in the same VPC. If you need to create a VPC, you can use one of the VPC sample templates: VPC with public subnets or VPC with public and private subnets and a NAT Gateway. |
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. |
Domain Name System (DNS) Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
ArcGIS Server Site Domain Name | Required | Provide the fully qualified domain name for the ArcGIS Server site. The domain name must exist and be resolvable. Contact your IT administrator if you are not sure what domain name to use. |
Elastic Load Balancer DNS Name | Optional | To use an elastic load balancer (ELB) with the deployment, provide the value for an application or classic ELB DNS name. This ELB must already exist. If you do not want to use an ELB or want to configure it by yourself later, leave this parameter value empty. You can get the ELB DNS name by browsing to the Load Balancers section of the Amazon EC2 service within the AWS Management Console or, if you used an Esri CloudFormation template to create the ELB, you can get it from that template's output parameters. Valid ELB DNS names must end with .elb.amazonaws.com. |
ArcGIS Server Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
EC2 Instance Type | Required | Choose an EC2 instance type. The default is m5.2xlarge. This is the instance type that will be used for the ArcGIS Server machines. These EC2 instances will be deployed in an Auto Scaling group. These machines will join the ArcGIS Server site by accessing the ArcGIS Server configuration store. |
EC2 Instance Root Drive Disk Space | Required | This is the size of the root drive disk space for the ArcGIS Server EC2 instances. Provide the size of the root drive in GB. The default is 100 GB. Minimum is 100 GB. Maximum is 1024 GB. |
Number of EC2 Instances | Required | Provide the number of EC2 instances that participate in the site. The default is 2. The maximum is 10. The minimum is 1. The EC2 instances in the site will be created in an Auto Scaling group. This does not include the directory file server. Note:The recommended number of instances for an ArcGIS GeoAnalytics Server site is 1 or 3. If you are creating an ArcGIS GeoAnalytics Server site, do not use the default number of EC2 instances. |
Deployment Bucket Name | Required | Provide the name of the Amazon S3 bucket that contains your software license files and SSL certificates. This bucket must already exist and contain the license file and SSL certificate for your deployment. You must be the owner of the bucket and it must reside in the same AWS account as your deployment. |
Server License File Name | Required | Provide the ArcGIS Server authorization file object key name. You must upload the license file (.ecp or .prvc file) to the deployment bucket before launching this stack. You can get the file object key name by browsing to the file within the deployment bucket in the Amazon S3 console. Examples include server.prvc or resources/licenses/109/server/server.prvc. You must use the appropriate license file for the type of ArcGIS Server site—GIS Server, ArcGIS GeoAnalytics Server, or ArcGIS Image Server—that you are creating. License file names are case sensitive. Ensure that you type the name correctly. |
Site Administrator User Name | Required | Provide a user name for the ArcGIS Server primary site administrator. The name must be 6 or more alphanumeric or underscore (_) characters and must start with a letter. |
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 must be 8 or more alphanumeric characters and can contain underscore (_), at (@), or dot (.) characters. |
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. |
Configuration Store Type | Required | Choose where the ArcGIS Server configuration store will be located. The default is FileSystem.
Note:Even if you choose CloudStore, a separate file server is created to host the ArcGIS Server shared directories.See the Considerations section of this page for information about DynamoDB capacity. |
ArcGIS File Server Instance Type | Required | Choose an EC2 instance type for the ArcGIS file server. The default instance type is m5.2xlarge. |
ArcGIS File Server EC2 Instance Root Drive Disk Space | Required | The size of the root drive disk space for the ArcGIS file server EC2 instance. Provide the size of the root drive in GB. The default is 100 GB. Minimum is 100 GB. Maximum is 1024 GB. |
Web Adaptor Name | Optional | If you want to use ArcGIS Web Adaptor with the ArcGIS Server site, type a web adaptor name. Access to the ArcGIS Server site will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>. The name must begin with a letter and contain only alphanumeric characters. Leave this parameter value empty if you do not want to use ArcGIS Web Adaptor, and URLs for the site will be in the format https://<fully qualified domain name><PortNumber>/arcgis. |
SSL Certificate File Name | Optional | If you include a web adaptor with the site, you can provide an SSL certificate from a certifying authority (.pfx file). If you do provide a certificate, you must upload it to the deployment bucket before launching this stack. You can get the file object key name by browsing to the file within the deployment bucket in the AWS S3 console. Examples of certificate names include domainname.pfx for a certificate file stored at the root level of the deployment bucket, or resources/sslcerts/domainname.pfx for a certificate file stored in a folder in the deployment bucket. If you use a web adaptor and leave this parameter value empty, an autogenerated self-signed certificate will be used with the web adaptor. |
SSL Certificate Password | Conditional | Provide a password for the SSL certificate. You can either type a plain text password or the ARN of your secret ID from AWS Secrets Manager. For information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS. |
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. |
ServerAdminDirURL | |
ServerManagerDirURL | The ArcGIS Server Manager URL. |
ServerRestDirURL | The ArcGIS Server REST Services URL. |
ServerServicesURL | The ArcGIS Server services URL. You can use this URL as an input parameter in the federate server template. |
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:
- In highly available ArcGIS Server deployments, EC2 instances are always configured in an AWS Auto Scaling group. Once the ArcGIS Server site is created, you can add more machines (EC2 instances) to the ArcGIS Server site by adjusting the size of the Auto Scaling group. Use AWS Management Console to increase the capacity of the Auto Scaling group to add machines. To remove machines, decrease the capacity. See the AWS documentation for instructions on changing the capacity limits of an Auto Scaling group to add machines to or remove machines from an ArcGIS Server site.
Tip:
To find the AWS Auto Scaling group created for a CloudFormation stack, review the Resources tab of the related CloudFormation stack. The logical ID of the resource is AutoScalingGroup.
Although it is technically possible to change the AWS Auto Scaling group size to zero, keep at least one instance running in the Auto Scaling group; otherwise, the ArcGIS Server site may not function properly.
Once you change the capacity of the group, it may take up to an hour to add machines or up to 15 minutes to remove machines. Once the change is applied, use the ArcGIS Server administrator API to confirm that the number of machines in the ArcGIS Server site has increased or decreased appropriately.
- The recommended number of EC2 instances for an ArcGIS GeoAnalytics Server site is 1 or 3. Having more or fewer instances may result in the site not functioning properly.
- If you choose CloudStore for the Configuration Store Type parameter, the Amazon DynamoDB provision capacity units are set to the following:
- Read capacity units: 250 tables
- Write capacity units: 25 tables
The estimated cost for these settings is approximately $36 per month. Esri testing indicates these settings work well for publishing approximately 500 services. You can edit this setting in the AWS Management Console to decrease the units and lower the cost or increase the units to accommodate more services. Keep in mind that some functionality, such as publishing, will fail if you don't have enough capacity.
- 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.