The Esri arcgis-notebook-server-singlemachine-upgrade.template.json Amazon Web Services (AWS) CloudFormation template upgrades an ArcGIS Notebook Server 10.9, 10.9.1, or 11.0 site that you created using the template described in Deploy a single-machine ArcGIS Notebook Server site using CloudFormation.
The arcgis-notebook-server-singlemachine-upgrade.template.json template upgrades the following software on a single Linux Amazon Elastic Compute Cloud (EC2) instance:
- ArcGIS Notebook Server
- ArcGIS Web Adaptor
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 ArcGIS Notebook Server license file (.ecp or .prvc).
- An SSL certificate file or certificates (in .pfx format) and corresponding passwords. Certificates must be from a certifying authority.
- An existing single-machine ArcGIS Notebook Server site that you created using the Esri Amazon Web Services CloudFormation template arcgis-notebook-server-singlemachine.template.json.
- The upgrade CloudFormation template, arcgis-notebook-server-singlemachine-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:
- 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 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
The following table contains the parameters used in this template and a description of each parameter.
ArcGIS Notebook Server Configuration
| Parameter name | Required? | Parameter description |
|---|---|---|
ArcGIS Notebook Server EC2 Instance ID | Required | Choose the ID of the EC2 instance in your existing ArcGIS Notebook Server site. If you created the existing site using an Esri CloudFormation template or Cloud Builder, you can find the instance ID in the existing CloudFormation stack's Resources section in AWS Management Console. The logical ID of the resource is ArcGISNotebookServerEC2Instance. |
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. |
License File Name | Required | Provide the ArcGIS Notebook 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 notebook.prvc or resources/licenses/server/notebook.prvc. License file names are case sensitive. Ensure that you type the correct name and case. |
License Level | Required | Choose the ArcGIS Notebook Server license level. Options are as follows:
|
Site Administrator User Name | Required | Provide the user name for the primary site administrator of your existing ArcGIS Notebook Server site. |
Site Administrator User Password | Required | Provide the password for the primary site administrator of your existing ArcGIS Notebook Server site. You can either type a plain text password or the ARN of your secret ID from AWS Secrets Manager. |
Site Domain Name | Required | Provide the fully qualified domain name of your existing ArcGIS Notebook Server site. |
Web Adaptor Name | Required | Provide the Notebook Server Web Adaptor name of your existing ArcGIS Notebook Server site. |
SSL Certificate File Name | Required | Provide an SSL certificate from a certifying authority (.pfx file). Use the same (or renewed) SSL certificate used when you created your existing deployment. You must upload the certificate 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, for example, domainname.pfx or resources/sslcerts/domainname.pfx. |
SSL Certificate Password | Required | Provide the 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 |
|---|---|
ServerAdminDirURL | |
ServerServicesURL | |
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 Notebook Server site is upgraded successfully. You can validate this by signing in to the ArcGIS Notebook Server Admin directory.
- 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 Notebook Server site.
Troubleshooting
If you observe any failures when creating this CloudFormation stack, see Troubleshoot ArcGIS deployments on AWS.