ArcGIS Enterprise
Esri

Esri CloudFormation Templates 10.7.1

CloudFormation templates to deploy ArcGIS Enterprise on Amazon Web Services

The templates listed on this page use CloudFormation to create an ArcGIS Enterprise 10.7.1 deployment or ArcGIS Server 10.7.1 roles on Amazon Web Services (AWS).

Looking for a different Esri template version?

10.7 10.6.1 10.6 10.5.1 10.5 10.4.1 10.4 10.3.1

Table of Contents

  • To use the CloudFormation templates
  • Esri Cloud Builder Command Line Interface for Amazon Web Services
  • ArcGIS Enterprise CloudFormation templates
    • Create a VPC to deploy ArcGIS Enterprise
    • Deploy base ArcGIS Enterprise
    • Deploy additional ArcGIS Server deployments
  • Stop and start all the EC2 instances in your deployment stack
  • Automate CloudFormation stack creation using Python
  • Upgrade to 10.7.1
  • Troubleshooting guide

To use the CloudFormation templates

  • Before using a template, read the Readme file for the sample template you want to use. Make sure you follow the directions to set up the required components first.
  • Click Launch Stack to use a template. You will be taken to the AWS Console. Sign in to your Amazon Web Services account, and enter the required parameters for the template.
  • For more information, see the ArcGIS Enterprise on AWS help and ArcGIS Enterprise on Windows or ArcGIS Enterprise on Linux help.

Esri Cloud Builder Command Line Interface for Amazon Web Services

The CloudFormation templates below create either one base Enterprise deployment or one ArcGIS Server role deployment. An optimized ArcGIS Enterprise deployment often requires several ArcGIS Server and ArcGIS Data Store machines, the ArcGIS Enterprise Cloud Builder Command Line Interface for Amazon Web Services an intuitive tool for automating cloud deployments of ArcGIS Enterprise to create these deployments.

ArcGIS Enterprise CloudFormation templates

Create a VPC to deploy ArcGIS Enterprise

ArcGIS Enterprise needs to run in a VPC environment. Most Amazon Web Services accounts have a default AWS VPC created. Use this default VPC, create another VPC manually, or use the template described in this section to create a VPC.

ArcGIS Server requires the hostname to be valid. On the machine where ArcGIS Server is running, you need to make sure you can ping the hostname. To check that, run the following:

  • >hostname

    This returns the hostname.

  • >ping "<the output of the hostname above>"

If the hostname is accessible, this command returns the valid ip address.

When you manually create a VPC, the following properties need to be ensure your hostname is accessible:

  • DNS resolution: Set to yes.
  • DNS hostname: Set to yes.
  • DHCP options set: You must have both domain-name and domain-name-servers set. For example:
    domain-name=ec2.internal; domain-name-servers=AmazonProvided

You can also use this template to create a VPC environment for your ArcGIS Enterprise deployment.

Template Name Description View Launch
Create an Amazon VPC Create an Amazon VPC with two subnets that ArcGIS Enterprise can be deployed in. ReadMe View Launch Stack

Deploy base ArcGIS Enterprise

A base ArcGIS Enterprise deployment includes Portal for ArcGIS, a GIS Server to be used as the portal's hosting server, and a relational and a tile cache data store created through ArcGIS Data Store and registered with the portal's hosting server.

These templates create a base ArcGIS Enterprise deployment You also have the option to include a spatiotemporal big data store with your base deployment when you use the following templates.

Template Name Description Platform View Launch
Single-machine deployment Create a base ArcGIS Enterprise deployment on a single machine. This is the minimal all-in-one configuration, where all the components are installed on a single instance. ReadMe Windows 2019 View Launch Stack
Ubuntu LTS 18.04 View Launch Stack
Highly available deployment Create a highly available deployment with two machines. Both machines contain all ArcGIS Enterprise components. The second machine acts as a standby ArcGIS Enterprise machine, which minimizes downtime in scenarios when one machine is unavailable. ReadMe Windows 2019 View Launch Stack
Ubuntu LTS 18.04 View Launch Stack

ELB for highly available base ArcGIS Enterprise deployment. The highly available base ArcGIS Enterprise CloudFormation template allows you to use an existing ELB. This option makes it easier to keep your existing domain_name mapping. The existing ELB has certain requirements, for example, the VPC, SSL cert, etc. It is recommended to create the ELB using this template.

View Launch Stack
Disaster recovery deployment in a different region Build an identical ArcGIS Enterprise deployment in a different region and periodically synchronize content from the active deployment to a deployment in a different region. If the active deployment goes offline, you can switch your clients to use the second deployment. ReadMe Windows&Ubuntu

Deploy additional ArcGIS Server deployments

In addition to the base ArcGIS Enterprise deployment, you can add functionality and capacity with additional ArcGIS Server sites.

Template Name Description Platform View Launch
ArcGIS GIS Server This template creates a general purpose GIS Server site, GeoAnalytics Server site, or Image Server Sites that you can set as Raster analytics Server or Image Hosting Server for the portal in your base ArcGIS Enterprise deployment. You just need to use different Server license files to deploy different ArcGIS Server roles. ReadMe Windows 2019 View Launch Stack
Ubuntu 18.04 LTS View Launch Stack

ELB for ArcGIS GIS Server deployment. The ArcGIS GIS Server CloudFormation template allows you to use an existing ELB. This option makes it easier to keep your existing domain_name mapping. The existing ELB has certain requirements, for example, the VPC, SSL cert, etc. It is recommended to create the ELB using this template.

View Launch Stack
ArcGIS GeoEvent Server This template creates a single-machine ArcGIS GeoEvent Server site that can be scaled up to a multi-machine deployment that you can federate with the portal in a base ArcGIS Enterprise deployment. To archive stream service data, you must have a spatiotemporal big data store, which must run on separate instances from the other components. ReadMe Windows 2019 View Launch Stack
Ubuntu LTS 18.04 View Launch Stack

ELB for ArcGIS GeoEvent Server deployment. The ArcGIS GIS Server CloudFormation template allows you to use an existing ELB. This option makes it easier to keep your existing domain_name mapping. The existing ELB has certain requirements, for example, the VPC, SSL cert, etc. It is recommended to create the ELB using this template.

View Launch Stack
Stand-alone ArcGIS Server sites Create an autoscaling group of stand-alone ArcGIS Server sites behind an Elastic Load Balancer. You can create a GIS Server site, Image Server site, or GeoEvent Server site. ReadMe Windows&Ubuntu View Launch Stack
Top of Page

Stop and start all the instances in your CloudFormation stack

The CloudFormation stacks for highly available base enterprise deployments, ArcGIS GIS Server deployments, and ArcGIS GeoEvent Server deployments will create Lambda functions to help stop and start all the EC2 instances in your deployment stack. It's recommended to use these Lamdba functions to stop and start all the EC2 instances and to scale auto-scaling groups up or down rather than perform those tasks manually.

These Lambda functions have the name starting with "<CloudFormation Stack Name>-StartStackFunction" or "<CloudFormation Stack Name>-StopStackFunction". You can invoke the function using the sample event data provided in the AWS Management Console following these steps:

  • On the functions page, select the function you want to run, choose Test from the Actions list.
  • In the Configure test event page, choose Create new test event and in Event template, leave the default Hello World option. Enter an Event name and click on Create
  • On the yourfunction page, click on Test
Top of Page

Automate CloudFormation stack creation using Python

You can create a ClouldFormation stack using AWS Command Line Interface and AWS SDKs for different languages. See Tools for Amazon Web Services for more information. A sample Python script is provided to create base ArcGIS Enterprise and ArcGIS Server CloudFormation stacks.

To run the Python script:

  • Make sure you have Python installed. Python is installed with ArcGIS Desktop and ArcGIS Server under the C:\Python27\ folder or <ArcGIS Server Installation Directory>/arcgis/server/tools folder on Linux.
  • Download and install AWS SDK for Python (boto).
  • Download sample python scripts and run them with the parameters required by your CloudFormation templates.
    For example, the single-machine ArcGIS Enterprise file, cf_parameters_win_allinone_webgisstack.json, defines the parameters required to deploy all base ArcGIS Enterprise components on one Windows instance on AWS. Modify the parameters accordingly. Run the file by typing:

    python cloudformation_stack_creation.py <Your AWS Access key> <Your AWS Secret Access Key> cf_parameters_win_allinone_webgisstack.json

Top of Page

Upgrade to 10.7.1

Step 0: Before you upgrade, make a backup of the existing system. Before upgrading an ArcGIS Enterprise deployment, use the webgisdr tool installed with Portal for ArcGIS to create a backup of the ArcGIS Enterprise components. This backup allows you to restore your deployment using the same URLs if you encounter issues that require you to revert to your old deployment. 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 to 10.7.1 from 10.6.1 or 10.7 through CloudFormation stack Update

The following steps are for upgrading 10.6.1 or 10.7 to 10.7.1. The 10.6.1 or 10.7 deployments might be created from Esri sample cloudformation templates or ArcGIS Enterprise Cloud Builder Command Line Interface.

  • Upgrade stand-alone base ArcGIS Enterprise deployment from 10.6.1 or 10.7 to 10.7.1.
  • Upgrade highly available base ArcGIS Enterprise deployment from 10.6.1 or 10.7 to 10.7.1.
  • Upgrade ArcGIS GIS Server deployment from 10.6.1 or 10.7 to 10.7.1.

Upgrade to 10.7.1 using Chef automation

Chef Automation can help upgrade in-place and upgrade from 10.6 or older version to 10.7.1. The deployments might be created from Esri sample cloudformation templates or ArcGIS Enterprise Cloud Builder Command Line Interface.

  • Upgrade standalone base ArcGIS Enterprise on Windows.
  • Upgrade standalone base ArcGIS Enterprise on Ubuntu.
  • Upgrade highly available base ArcGIS Enterprise deployment on Windows.
  • Upgrade highly available base ArcGIS Enterprise deployment on Ubuntu.
  • Upgrade Spatial Temporal DataStore on Windows.
  • Upgrade Spatial Temporal DataStore on Ubuntu.
  • Upgrade ArcGIS GIS Server deployment on Windows.
  • Upgrade ArcGIS GIS Server deployment on Ubuntu.

Upgrade to 10.7.1 by running ArcGIS Enterprise Setups.

It is recommended to move all the instances out of the auto-scaling group, and upgrade the ArcGIS components as you would upgrade an on-premise deployment.

  • Move ArcGIS GIS Server instances that are in an auto-scaling group out of the auto-scaling group.
  • If you have deployed a spatialtemporal big data store, move the instances out of the auto-scaling group as well.
  • Follow the upgrade documentation, for Windows or Ubuntu, to upgrade your ArcGIS Enterprise deployment.
Top of Page

Troubleshooting guide

DeploymentLogs in CloudWatch. The deployment logs are exported to CloudWatch. In the CloudFormation stack, you can click on Resources and there is the link for the “DeploymentLogs in the list. Clicking on the link will take you to the deployment logs on all started instances, including the chef-run.log.

You can also see Troubleshoot AWS CloudFormation stack creation in the ArcGIS Enterprise on Amazon Web Services help for information on how to identify and correct issues you may encounter when launching a CloudFormation stack using the Esri sample templates.

ArcGIS Enterprise

  • Home
  • Documentation
  • Pricing
  • Support

ArcGIS Platform

  • ArcGIS Online
  • ArcGIS Desktop
  • ArcGIS Server
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Insiders Blog
  • User Conference
  • Developer Summit
Esri
© Copyright 2018 Environmental Systems Research Institute, Inc. Privacy Legal