AEM OpenCloud on the AWS Cloud

Quick Start Reference Deployment

QS

September 2020
Cliffano Subagio and Michael Bloch, Shine Solutions Group
Tony Bulding, AWS Quick Start team

Visit our GitHub repository for source files and to post feedback, report bugs, or submit feature ideas for this Quick Start.

This Quick Start was created by Shine Solutions Group in collaboration with Amazon Web Services (AWS). Quick Starts are automated reference deployments that use AWS CloudFormation templates to deploy key technologies on AWS, following AWS best practices.

Overview

This Quick Start reference deployment guide provides step-by-step instructions for deploying AEM OpenCloud on the AWS Cloud.

This Quick Start deploys an AEM OpenCloud architecture on the AWS Cloud with high availability features including Amazon EC2 Auto Scaling, Elastic Load Balancing & Amazon CloudFront.

The AEM OpenCloud Full-Set is deployed with the recommended highly-available configuration of two Author-Dispatcher, two Publish-Dispatcher and two AEM Publish instances across multiple availability zones in one AWS Region. Further Amazon Cloudwatch alarms are configured to monitor the average CPU utilization of the Publish-Dispatcher Auto Scaling group. The alarm is configured to scale out/in by one EC2 instance if the CPU Utilization is above/below 50%, by not exceeding the configured minimum (2) or maximum (4) size of the Publish-Dispatcher Auto Scaling Group. The Orchestrator application manages AEM replication and flush agents as instances are created and terminated.

Amazon may share user-deployment information with the AWS Partner that collaborated with AWS on the Quick Start.

AEM OpenCloud on AWS

AEM OpenCloud is an open-source platform for running AEM on AWS. It provides an out of the box solution for provisioning a highly available AEM architecture which implements auto-scaling, auto-recovery, chaos-testing, CDN, multi-level backup, blue-green deployment, repository upgrade, security, and monitoring capabilities by leveraging a multitude of AWS services.

The AEM OpenCloud workloads are deployed on multiple Amazon EC2 instances for improved performance. The content-delivery and content-management web server roles can be scaled for high availability. Other AEM OpenCloud roles have restrictions on active/active roles and are designed for active/passive standby. Due to this, other AEM OpenCloud roles belong to their own Auto Scaling groups as single instances. Should an instance become unavailable, it will be replaced by a new instance and configured with a AEM OpenCloud role of the same type.

The Website content can be deployed to the content-delivery and content-management roles using your choice of deployment process.

Please know that we may share who uses AWS Quick Starts with the AWS Partner Network (APN) Partner that collaborated with AWS on the content of the Quick Start.

AWS costs

You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start. There is no additional cost for using the Quick Start.

The AWS CloudFormation templates for Quick Starts include configuration parameters that you can customize. Some of the settings, such as the instance type, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service you use. Prices are subject to change.

After you deploy the Quick Start, create AWS Cost and Usage Reports to deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. These reports provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, see What are AWS Cost and Usage Reports?

Software licenses

This Quick Start requires a license for Adobe Experience Manager. Contact your Adobe sales representative or Adobe partner for a full Adobe AEM on-premise license. When you launch the Quick Start, place the license key in the S3 installation bucket and specify its location.

If you don’t have a full Adobe AEM on-premise license, the Quick Start deployment will fail.

This Quick Start launches the Amazon Machine Image (AMI) for the Amazon Linux 2 or Red Hat Enterprise Linux (RHEL) operating system.

Architecture

Deploying this Quick Start for a new virtual private cloud (VPC) with default parameters builds the following AEM OpenCloud environment in the AWS Cloud.

Architecture
Figure 1. Quick Start architecture for AEM OpenCloud on AWS
Architecture
Figure 2. Quick Start architecture of resources for AEM OpenCloud on AWS

As shown in Figure 1 and Figure 2, the Quick Start sets up the following:

  • A highly-available architecture that spans two Availability Zones.*

  • A VPC configured with public and private subnets, according to AWS best practices, to provide you with your own virtual network on AWS.*

  • In the public subnets:

    • Managed network address translation (NAT) gateways to allow outbound internet access for resources in the private subnets.*

    • A Linux bastion host in an Auto Scaling group to allow inbound Secure Shell (SSH) access to EC2 instances in public and private subnets.*

    • An internet-facing Application Load Balancer (ALB) for routing traffic to the content delivery web server.

  • In the private subnets:

    • Content management EC2 instances are designed for active/passive standby and are not part of an Auto Scaling Group.

    • Content delivery EC2 instances are deployed into an Auto Scaling group.

    • Content delivery web server EC2 instances are deployed into an Auto Scaling group.

    • Content management web server EC2 instances are deployed into an Auto Scaling group.

    • Utility EC2 instances are deployed into their own Auto Scaling group.

    • An internal ALB for routing traffic to the active content management server.

    • An internal ALB for routing traffic to the content management web server.

  • Amazon CloudFront for content delivery.

  • EC2 Amazon Machine Image (AMI) for each AEM OpenCloud role.

  • AWS Certificate Manager (ACM) for storing SSL certificates.

  • Amazon CloudWatch for monitoring deployed services.

  • AWS Lambda to support provisioning of AEM OpenCloud on AWS.

  • Amazon Route 53 private hosted zone for internal Domain Name System (DNS) lookups.

  • AWS Secrets Manager to store the AEM keystore password & AEM SSL private key.

  • Amazon Simple Notification Service (SNS) for receiving Auto scaling group alarm notifications.

  • Amazon Simple Queue Service (SQS) for forwarding Auto scaling group alarm notifications to Utility EC2 instances.

  • Amazon Simple Storage Service (Amazon S3) bucket for storing AEM OpenCloud Stack assets.

  • AWS Systems Manager to store AEM OpenCloud configuration parameters.

*The template that deploys the Quick Start into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.

Planning the deployment

Specialized knowledge

This deployment requires a moderate level of familiarity with AWS services. If you’re new to AWS, see Getting Started Resource Center and AWS Training and Certification. These sites provide materials for learning how to design, deploy, and operate your infrastructure and applications on the AWS Cloud.

This Quick Start assumes familiarity with AWS and AEM.

AWS account

If you don’t already have an AWS account, create one at https://aws.amazon.com by following the on-screen instructions. Part of the sign-up process involves receiving a phone call and entering a PIN using the phone keypad.

Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.

Technical requirements

Before you launch the Quick Start, review the following information and ensure that your account is properly configured. Otherwise, deployment might fail.

Resource quotas

If necessary, request service quota increases for the following resources. You might request quota increases to avoid exceeding the default limits for any resources that are shared across multiple deployments. The Service Quotas console displays your usage and quotas for some aspects of some services. For more information, see What is Service Quotas? and AWS service quotas.

Resource This deployment uses

VPCs

1

Elastic IP addresses

1

IAM roles

13

ACM Certificates

1

Cloudfront Distributions

1

Application Load Balancers

3

Cloudfront Distributions

1

Lambda Functions

13

m5.2xlarge instances

4

t3.small instances

5

t2.micro instances

1

Route53 Hosted Zones

1

Route53 Records

3

Secrets Manager

2

Systems Manager parameters

127

Supported Regions

Code Name Opt-in Status

us-east-2

US East (Ohio)

Not required

us-east-1

US East (N. Virginia)

Not required

us-west-1

US West (N. California)

Not required

us-west-2

US West (Oregon)

Not required

af-south-1

Africa (Cape Town)

Required

ap-east-1

Asia Pacific (Hong Kong)

Required

ap-south-1

Asia Pacific (Mumbai)

Not required

ap-northeast-3

Asia Pacific (Osaka-Local)

Not required

ap-northeast-2

Asia Pacific (Seoul)

Not required

ap-southeast-1

Asia Pacific (Singapore)

Not required

ap-southeast-2

Asia Pacific (Sydney)

Not required

ap-northeast-1

Asia Pacific (Tokyo)

Not required

ca-central-1

Canada (Central)

Not required

eu-central-1

Europe (Frankfurt)

Not required

eu-west-1

Europe (Ireland)

Not required

eu-west-2

Europe (London)

Not required

eu-south-1

Europe (Milan)

Required

eu-west-3

Europe (Paris)

Not required

eu-north-1

Europe (Stockholm)

Not required

me-south-1

Middle East (Bahrain)

Required

sa-east-1

South America (São Paulo)

Not required

Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions.

IAM permissions

Before launching the Quick Start, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions. For more information, see AWS managed policies for job functions.

This Quick Start requires that you have access to Adobe Experience Cloud to obtain the AEM resource files.

  1. Contact your Adobe sales representative or Adobe partner for a full Adobe AEM on-premises license.

  2. Name the license file "license.properties" and prepare the content of the license file as follows:

license.product.name=Adobe Experience Manager
license.customer.name=Customer Name
license.product.version=6.5.0
license.downloadID=AEM License Key
  1. Go to AEM Dispatcher Release Notes to download the Linux x86_64 AEM Dispatcher module for Apache 2.4 with OpenSSL 1.0 Support as the tar.gz file

  2. Go to Adobe Experience Cloud Software Distribution and download the JDK 8 installation rpm e.g. jdk-8u251-linux-x64.rpm. Which JDK8 versions are supported is described in the FAQ.

  3. Go to Adobe Experience Cloud Software Distribution and download the AEM Jar file and if necessary the required AEM service pack. Which AEM versions are supported is described in the FAQ.

  4. Place the AEM license, AEM Dispatcher module, JDK8 rpm installation, AEM Jar & AEM Service-Packs to the S3 installation bucket which will be use for the Quick Start deployment into a prefix of your choice.

S3BucketInstallationContent
Figure 3. S3 installation bucket
  1. (Optional) Create a certificate for your internal URL in Amazon Certificate Manager (ACM) in the Region where you deploy the Quick Start. This certificate must be created as a wildcard certificate for your AEM OpenCloud internal domain (for example, *.example.internal). Alternatively a Certificate will be created for you.

  2. (Optional) If you are planning to enable Cloudfront and to use an external FQDN, create a certificate for your external URL in Amazon Certificate Manager (ACM) in the Region us-east-1. This certificate must be created as a wildcard certificate for your AEM OpenCloud domain (for example, *.example.com).

  3. (Optional) If you are planning to disable Cloudfront and to use an external FQDN, create a certificate for your external URL in Amazon Certificate Manager (ACM) in the Region where you deploy the Quick Start. This certificate must be created as a wildcard certificate for your AEM OpenCloud domain (for example, *.example.com). Alternatively an external Certificate will be created for you.

Deployment options

This Quick Start provides two deployment options:

  • Deploy AEM OpenCloud into a new VPC (end-to-end deployment). This option builds a new AWS environment consisting of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys AEM OpenCloud into this new VPC.

  • Deploy AEM OpenCloud into an existing VPC. This option provisions AEM OpenCloud in your existing AWS infrastructure.

The Quick Start provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and AEM OpenCloud settings, as discussed later in this guide.

Operating System for Deployment

This Quick Start supports Amazon Linux 2(AL2) or RedHat Enterprise Linux 7(RHEL7) for your AEM OpenCloud installation on AWS. This Quick Start deployment uses AL2.

Deployment steps

Sign in to your AWS account

  1. Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see Planning the deployment earlier in this guide.

  2. Make sure that your AWS account is configured correctly, as discussed in the Technical requirements section.

Launch the Quick Start

You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional cost for using this Quick Start. For full details, see the pricing pages for each AWS service used by this Quick Start. Prices are subject to change.
  1. Sign in to your AWS account, and choose one of the following options to launch the AWS CloudFormation template. For help with choosing an option, see deployment options earlier in this guide.

Deploy AEM OpenCloud into a new VPC on AWS

Deploy AEM OpenCloud into an existing VPC on AWS

If you’re deploying AEM OpenCloud into an existing VPC, make sure that your VPC has two private subnets in different Availability Zones for the workload instances, and that the subnets aren’t shared. This Quick Start doesn’t support shared subnets. These subnets require NAT gateways in their route tables, to allow the instances to download packages and software without exposing them to the internet.

Also, make sure that the domain name option in the DHCP options is configured as explained in the Amazon VPC documentation. You provide your VPC settings when you launch the Quick Start.

Each deployment takes about 1–1.5 hours to complete.

  1. Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This is where the network infrastructure for AEM OpenCloud will be built. The template is launched in the us-east-1 Region by default.

  1. On the Create stack page, keep the default setting for the template URL, and then choose Next.

  2. On the Specify stack details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. (Deployment steps are continued after the parameter tables.)

+ In the following tables, parameters are listed by category and described separately for the deployment options. When you finish reviewing and customizing the parameters, choose Next.

+ NOTE: Unless you are customizing the Quick Start templates for your own deployment projects, keep the default settings for the parameters Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. Changing these settings automatically updates code references to point to a new Quick Start location. For more information, see the AWS Quick Start Contributor’s Guide.

+ === Launch into a new VPC .VPC Network configuration

Parameter label (name) Default value Description

Availability Zones (AvailabilityZones)

Requires input

List of Availability Zones to use for the subnets in the VPC. Only two Availability Zones are used for this deployment, and the logical order of your selections is preserved.

VPC CIDR (VPCCIDR)

10.2.16.0/21

CIDR block for the VPC

Private Subnet 1 CIDR (PrivateSubnet1CIDR)

10.2.16.0/24

CIDR block for private subnet 1 located in Availability Zone 1

Private Subnet 2 CIDR (PrivateSubnet2CIDR)

10.2.18.0/24

CIDR block for private subnet 2 located in Availability Zone 2

Public Subnet 1 CIDR (PublicSubnet1CIDR)

10.2.20.0/24

CIDR block for the public (DMZ) subnet 1 located in Availability Zone 1

Public Subnet 2 CIDR (PublicSubnet2CIDR)

10.2.22.0/24

CIDR block for the public (DMZ) subnet 2 located in Availability Zone 2

Table 1. Bastion Host configuration
Parameter label (name) Default value Description

Bastion Instance Type (BastionInstanceType)

t3.micro

Amazon EC2 instance type for the bastion instances

Bastion AMI Operating System (BastionAMIOS)

Amazon-Linux2-HVM

The Linux distribution for the AMI to be used for the bastion instances

Allowed Bastion external access CIDR (RemoteAccessCIDR)

Requires input

Allowed CIDR block for external SSH access to the bastions

Table 2. Amazon EC2 configuration
Parameter label (name) Default value Description

EC2 instance KeyPair name (KeyPairName)

Requires input

Name of an existing Amazon EC2 public/private key pair to enable remote access to instances.

Base AMI SSM Name (BaseAmiImageName)

/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2

SSM Parameter Name of the Base Image Id. Supported OS are AL2 & RHEL7. Default OS is AL2.

Author instance type (AuthorInstanceType)

m5.2xlarge

Amazon EC2 instance type for the AEM Author instance

Publish instance type (PublishInstanceType)

m5.2xlarge

Amazon EC2 instance type for the AEM Publish instance

Author-Dispatcher instance type (AuthorDispatcherInstanceType)

t3.small

Amazon EC2 instance type for the AEM Author-Dispatcher instance

Publish-Dispatcher instance type (PublishDispatcherInstanceType)

t3.small

Amazon EC2 instance type for the AEM Publish-Dispatcher instance

Orchestrator instance type (OrchestratorInstanceType)

t3.small

Amazon EC2 instance type for the Orchestrator instance

Table 3. AEM OpenCloud configuration
Parameter label (name) Default value Description

AEM OpenCloud S3 Data bucket (S3DataBucketName)

Blank string

(Optional) S3 bucket name for the AEM OpenCloud Stack data assets(installation files, license file, etc.). This string can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

AEM OpenCloud S3 Installation Bucket (S3InstallBucketName)

Requires input

S3 bucket name for the AEM OpenCloud installation assets(installation files, license file, etc.). This string can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

AEM OpenCloud S3 installation Key Prefix (S3InstallKeyPrefix)

quickstart-aem-opencloud/library/

S3 key prefix for the AEM OpenCloud installation assets(installation files, license file, etc.).AWS Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/). It cannot start or end with forward slash (/) because they are automatically appended.

AEM OpenCloud Stack Prefix (AOCStackPrefix)

aem-opencloud

Stack Prefix used to tag and identify the AEM OpenCloud Stack.

AEM Version to install (AemVersion)

65-SP4

AEM Version to install. Please refer to the deployment guide for other supported versions.

AEM Dispatcher version to install (AemDispatcherVersion)

4.3.3

AEM Dispatcher version to install.

Java JDK version to install (JavaJDKVersion)

8u251

Java JDK Version to install and run AEM. Please refer to the deployment guide for other supported versions.

Lambda S3 bucket name (LambdaZipsBucketName)

Blank string

(Optional) The name of the S3 bucket where the Lambda zip files should be placed. If you leave this parameter blank, an S3 bucket will be created.

Table 4. (optional) AEM OpenCloud Certificate configuration
Parameter label (name) Default value Description

Internal Route53 Zone name (InternalRoute53ZoneName)

Blank string

(Optional) Internal Route53 Zone name. If Left blank, one is generated for you. If you want to use your own Route 53 hosted zone, please provide the hosted zone name.

Internal Route53 Zone Id (InternalRoute53ZoneID)

Blank string

(Optional) Internal Route53 Zone id of the provided internal Route53 Zone name.

Internal ACM Certificate ARN (InternalCertificateARN)

Blank string

(Optional) Provide the Amazon Resource Name (ARN) of the private certificate created in Amazon Certificate Manager, for the provided Internal Route53 Zone name. If not provided, a self-signed certificate will be used for you.

External FQDN (ExternalFQDN)

Blank string

(Optional) External FQDN for the AEM OpenCloud deployment (e.g., aoc.example.com). If not provided, no external Route53 Record will be created. If provided the External Route53 Zone ID becomes mandatory.

External Route53 Zone Id (ExternalRoute53ZoneID)

Blank string

(Conditional) Route53 Hosted Zone ID of the defined ExternalFQDN. Mandatory if an External FQDN was provided.

External Certificate ARN (ExternalCertificateARN)

Blank string

(Optional) The ARN of the external Certificate stored in AWS Certificate Manager(ACM). If not provided, but External FQDN & External Route53 Zone ID were provided, an external wildcard certificate will be created for you.

Table 5. (optional) Advanced AEM OpenCloud configuration
Parameter label (name) Default value Description

Author Backup EC2 Snapshot id (AuthorBackupSnapshotID)

Blank string

(Optional) Provide the AWS EC2 Snapshot ID of an AEM Author backup, to recreate a new Environment based on a backup.

Publish Backup EC2 Snapshot id (PublishBackupSnapshotID)

Blank string

(Optional) Provide the AWS EC2 Snapshot ID of an AEM Publish backup, to recreate a new Environment based on a backup.

Alarm notification E-Mail address (AlarmNotificationEmail)

Blank string

(Optional) Provode a valid Email address if you want to receive Stack alarm messages.

Alarm notification HTTPS endpoint (AlarmNotificationHttpsEndpoint)

Blank string

(Optional) Provode a valid HTTPS Endpoint address if you want to receive Stack alarm messages.

Table 6. (optional) AWS Cloudfront configuration
Parameter label (name) Default value Description

Enable Cloudfront Stack (EnableCloudfront)

true

(Optional) Set to false to disable Cloudfront.

CloudFront PriceClass (CloudfrontPriceClass)

PriceClass_All

(Optional) Select the price class associated with the maximum price that you want to pay for CloudFront service. If you select a price class other than All, some of your users may experience higher latency.

Table 7. AWS Quick Start configuration
Parameter label (name) Default value Description

Quick Start S3 Bucket name (QSS3BucketName)

aws-quickstart

S3 bucket name for the Quick Start assets. This string can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

Quick Start S3 bucket region (QSS3BucketRegion)

us-east-1

The AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value.

Quick Start S3 Key Prefix (QSS3KeyPrefix)

quickstart-aem-opencloud/

S3 key prefix for the AWS Quick Start assets.AWS Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/). It cannot start or end with forward slash (/) because they are automatically appended.

Launch into an existing VPC

Table 8. Network configuration
Parameter label (name) Default value Description

Availability zones (AvailabilityZones)

Requires input

List of Availability Zones to use for the subnets in the VPC. Only two Availability Zones are used for this deployment, and the logical order of your selections is preserved.

VPC ID (VPCID)

Requires input

ID of the VPC which the subnets are located.

VPC CIDR (VPCCIDR)

Requires input

CIDR block for the VPC

Private Subnet 1 ID (PrivateSubnet1ID)

Requires input

Subnet ID for private subnet 1 located in Availability Zone 1

Private Subnet 2 ID (PrivateSubnet2ID)

Requires input

Subnet ID for private subnet 2 located in Availability Zone 2

Public Subnet 1 ID (PublicSubnet1ID)

Requires input

Subnet ID for private subnet 1 located in Availability Zone 1

Public Subnet 2 ID (PublicSubnet2ID)

Requires input

Subnet ID for private subnet 2 located in Availability Zone 2

Private Subnet 1 Route Table ID (PrivateSubnet1RouteTableID)

Requires input

Route Table ID of the Private Subnet 1

Private Subnet 2 Route Table ID (PrivateSubnet2RouteTableID)

Requires input

Route Table ID of the Private Subnet 2

Public Subnet Route Table ID (PublicSubnetRouteTableID)

Requires input

Route Table ID of the Pulic Subnet

Table 9. Amazon EC2 Configuration
Parameter label (name) Default value Description

EC2 instance KeyPair name (KeyPairName)

Requires input

Name of an existing Amazon EC2 public/private key pair to enable remote access to instances.

Base AMI SSM Name (BaseAmiImageName)

/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2

SSM Parameter Name of the Base Image ID. Supported OS are AL2 & RHEL7. Default OS is AL2.

Author instance type (AuthorInstanceType)

m5.2xlarge

Amazon EC2 instance type for the AEM Author instance

Publish instance type (PublishInstanceType)

m5.2xlarge

Amazon EC2 instance type for the AEM Publish instance

Author-Dispatcher instance type (AuthorDispatcherInstanceType)

t3.small

Amazon EC2 instance type for the AEM Author-Dispatcher instance

Publish-Dispatcher instance type (PublishDispatcherInstanceType)

t3.small

Amazon EC2 instance type for the AEM Publish-Dispatcher instance

Orchestrator instance type (OrchestratorInstanceType)

t3.small

Amazon EC2 instance type for the Orchestrator instance

Table 10. AEM OpenCloud configuration
Parameter label (name) Default value Description

AEM OpenCloud S3 Data bucket (S3DataBucketName)

Blank string

(Optional) S3 bucket name for the AEM OpenCloud Stack data assets(installation files, license file, etc.). This string can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

AEM OpenCloud S3 Installation Bucket (S3InstallBucketName)

Requires input

S3 bucket name for the AEM OpenCloud installation assets(installation files, license file, etc.). This string can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

AEM OpenCloud S3 installation Key Prefix (S3InstallKeyPrefix)

quickstart-aem-opencloud/library/

S3 key prefix for the AEM OpenCloud installation assets(installation files, license file, etc.).AWS Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/). It cannot start or end with forward slash (/) because they are automatically appended.

AEM OpenCloud Stack Prefix (AOCStackPrefix)

aem-opencloud

Stack Prefix used to tag and IDentify the AEM OpenCloud Stack.

AEM Version to install (AemVersion)

65-SP4

AEM Version to install. Please refer to the deployment guide for other supported versions.

AEM Dispatcher version to install (AemDispatcherVersion)

4.3.3

AEM Dispatcher version to install.

Java JDK version to install (JavaJDKVersion)

8u251

Java JDK Version to install and run AEM. Please refer to the deployment guide for other supported versions.

Lambda S3 bucket name (LambdaZipsBucketName)

Blank string

(Optional) The name of the S3 bucket where the Lambda zip files should be placed. If you leave this parameter blank, an S3 bucket will be created.

Table 11. (optional) AEM OpenCloud Certificate configuration
Parameter label (name) Default value Description

Internal Route53 Zone name (InternalRoute53ZoneName)

Blank string

(Optional) Internal Route53 Zone name. If Left blank, one is generated for you. If you want to use your own Route 53 hosted zone, please provide the hosted zone name.

Internal Route53 Zone ID (InternalRoute53ZoneID)

Blank string

(Optional) Internal Route53 Zone ID of the provided internal Route53 Zone name.

Internal ACM Certificate ARN (InternalCertificateARN)

Blank string

(Optional) Provide the Amazon Resource Name (ARN) of the private certificate created in Amazon Certificate Manager Private CA, for the provided Internal Route53 Zone name. If not provided, a self-signed certificate will be used for you.

External FQDN (ExternalFQDN)

Blank string

(Optional) External FQDN for the AEM OpenCloud deployment (e.g., aoc.example.com). If not provided, no external Route53 Record will be created. If provided the External Route53 Zone ID becomes mandatory.

External Route53 Zone ID (ExternalRoute53ZoneID)

Blank string

(Conditional) Route53 Hosted Zone ID of the defined ExternalFQDN. Mandatory if an External FQDN was provided.

External Certificate ARN (ExternalCertificateARN)

Blank string

(Optional) The ARN of the external Certificate stored in AWS Certificate Manager(ACM). If not provided, but External FQDN & External Route53 Zone ID were provided, an external wildcard certificate will be created for you.

Table 12. (optional) Advanced AEM OpenCloud configuration
Parameter label (name) Default value Description

Author Backup EC2 Snapshot ID (AuthorBackupSnapshotID)

Blank string

(Optional) Provide the AWS EC2 Snapshot ID of an AEM Author backup, to recreate a new Environment based on a backup.

Publish Backup EC2 Snapshot ID (PublishBackupSnapshotID)

Blank string

(Optional) Provide the AWS EC2 Snapshot ID of an AEM Publish backup, to recreate a new Environment based on a backup.

Alarm notification E-Mail address (AlarmNotificationEmail)

Blank string

(Optional) Provode a valid Email address if you want to receive Stack alarm messages.

Alarm notification HTTPS endpoint (AlarmNotificationHttpsEndpoint)

Blank string

(Optional) Provode a valid HTTPS Endpoint address if you want to receive Stack alarm messages.

Table 13. (optional) AWS Cloudfront configuration
Parameter label (name) Default value Description

Enable Cloudfront Stack (EnableCloudfront)

true

(Optional) Set to false to disable Cloudfront.

CloudFront PriceClass (CloudfrontPriceClass)

PriceClass_All

(Optional) Select the price class associated with the maximum price that you want to pay for CloudFront service. If you select a price class other than All, some of your users may experience higher latency.

Table 14. AWS Quick Start configuration
Parameter label (name) Default value Description

Quick Start S3 Bucket name (QSS3BucketName)

aws-quickstart

S3 bucket name for the Quick Start assets. This string can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

Quick Start S3 bucket region (QSS3BucketRegion)

us-east-1

The AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value.

Quick Start S3 Key Prefix (QSS3KeyPrefix)

quickstart-aem-opencloud/

S3 key prefix for the AWS Quick Start assets.AWS Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/). It cannot start or end with forward slash (/) because they are automatically appended.

+ . On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you’re finished, choose Next. . On the Review page, review and confirm the template settings. Under Capabilities, select the two check boxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros. . Choose Create stack to deploy the stack. . Monitor the status of the stack. When the status is CREATE_COMPLETE, the AEM OpenCloud deployment is ready. . Use the values displayed in the Outputs tab for the stack, as shown in Figure 4, to view the created resources.

cfn_outputs
Figure 4. AEM OpenCloud outputs after successful deployment

Security

The login credentials of the AEM system users are stored as json file system_users_credentials.json on S3 at the location s3://S3DataBucketName/AOCStackPrefix/. S3DataBucketName is the name of the provided (or generated) S3 Bucket and AOCStackPrefix is the provided stack prefix (e.g. s3://aem-opencloud/aoc-stack-1/system-users-credentials.json.)

To login to AEM use the credentials for the admin user.

Changing the password of an AEM System User may cause system instabilities and is therefore not recommended.

If you changed the password of an AEM system user, do the following:

  1. Update the system_users_credentials.json with the new password.

  2. Make sure the same password for the user is set on the AEM Author & AEM Publish EC2 instances.

  3. If you change the password of the orchestrator user, restart or terminate the AEM Orchestrator EC2 instance and wait until the new one came up successfully by monitoring the EC2 tag ComponentInitStatus.

  4. If you change the password of the replicator user, update all agents on the AEM Author & AEM Publish EC2 instances with the new password. As an alternative, you can also terminate the AEM Publish instances one by one. Before terminating the second AEM Publish instance, verify provisioning of the recovered AEM Publish EC2 instance was successful by monitoring the EC2 tag ComponentInitStatus.

FAQ

Q. I encountered a CREATE_FAILED error when I launched the Quick Start.

A. If AWS CloudFormation fails to create the stack, we recommend that you relaunch the template with Rollback on failure set to No. (This setting is under Advanced in the AWS CloudFormation console, Options page.) With this setting, the stack’s state is retained and the instance is left running, so you can troubleshoot the issue.

When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Please make sure to delete the stack when you finish troubleshooting.

For additional information, see Troubleshooting AWS CloudFormation on the AWS website.

Q. I encountered a size limitation error when I deployed the AWS CloudFormation templates.

A. We recommend that you launch the Quick Start templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer or from a location other than an S3 bucket, you might encounter template size limitations. For more information about AWS CloudFormation quotas, see AWS CloudFormation quotas.

Q. Where are the deployment logs?

A. All resources and logs for deployments are found either in Amazon CloudWatch Logs or in the instances themselves.

  • All log files of the Lambda functions can be found in Amazon CloudWatch Logs.

  • Installation logfiles of the AEM OpenCloud roles can be found in the EC2 instances at /var/log/cloud-init.log and /var/log/cloud-init-output.log.

  • Log files of the AEM OpenCloud Main Stack are found either in Amazon Cloudwatch Logs by the AOC Stack Prefix & name of the log file (e.g., aoc-stack-1/var/log/shinesolutions/puppet-stack-init.log) or in the EC2 instances at /var/log/shinesolutions/puppet-stack-init.log, /var/log/cloud-init.log, and /var/log/cloud-init-output.log.

Q. Where are the AEM System Users Login Credentials stored?

A. The login credentials of the AEM System users are stored on S3 in the AEM OpenCloud Stack data directory s3://S3DataBucketName/AOCStackPrefix/system-users-credentials.json (e.g., s3://aem-opencloud/aoc-stack-1/system-users-credentials.json.)

Q. Which versions of Oracle Java JDK8 are supported by AEM OpenCloud?

A. All versions of Oracle Java JDK8 are supported. You just need to provide the version e.g. 8u271 as input value for the parameter JavaJDKVersion

Q. What versions of AEM are supported by AEM OpenCloud?

A. Supported versions of AEM and their allowed input value for the parameter AemVersion including the expected name of the Service-Packs are listed in the table below.

Table 15. Supported AEM Version
Version Allowed input value Service Pack Name

AEM 63

63

-

AEM 63 SP1

63-SP1

AEM-6.3-Service-Pack-1-6.3.SP1.zip

AEM 63 SP2

63-SP2

AEM-6.3.2.0-6.3.2.zip

AEM 63 SP2-CFP1

63-SP2-CFP1

AEM-6.3.2.0-6.3.2.zip & AEM-CFP-6.3.2.1-1.0.zip

AEM 63 SP2-CFP2

63-SP2-CFP2

AEM-6.3.2.0-6.3.2.zip & AEM-CFP-6.3.2.2-2.0.zip

AEM 64

64

-

AEM 64 SP1

64-SP1

AEM-6.4.1.0-6.4.1.zip

AEM 64 SP2

64-SP2

AEM-6.4.2.0-6.4.2.zip

AEM 64 SP3

64-SP3

AEM-6.4.3.0-6.4.3.zip

AEM 64 SP4

64-SP4

AEM-6.4.4.0-6.4.4.zip

AEM 64 SP5

64-SP5

AEM-6.4.5.0-6.4.5.zip

AEM 64 SP6

64-SP6

AEM-6.4.6.0-6.4.6.zip

AEM 64 SP7

64-SP7

AEM-6.4.7.0-6.4.7.zip

AEM 64 SP8

64-SP8

AEM-6.4.8.0-6.4.8.zip

AEM 65

65

-

AEM 65 SP1

65-SP1

AEM-6.5.1.0-6.5.1.zip

AEM 65 SP2

65-SP2

AEM-6.5.2.0-6.5.2.zip

AEM 65 SP3

65-SP3

AEM-6.5.3.0-6.5.3.zip

AEM 65 SP4

65-SP4

AEM-6.5.4.0-6.5.4.zip

AEM 65 SP5

65-SP5

AEM-6.5.4.0-6.5.5.zip

AEM 65 SP6

65-SP6

AEM-6.5.4.0-6.5.6.zip

Troubleshooting

General Troubleshooting notes:

  • If the stack AmiCreationStack failed to create, the installation of the AEM OpenCloud roles failed. Start troubleshooting by analysing the log files in the EC2 instances or the Lambda logs in Amazon CloudWatch Logs.

  • The EC2 instances of the stack AemOpenCloudMainStack have the EC2 tag ComponentInitStatus, which helps to determine the provisioning state of the EC2 instances.

The Tag ComponentInitStatus can contain three values:

InProgress: The provisioning of the AEM OpenCloud role is still in progress.

Success: The provisioning of the AEM OpenCloud role was successful.

Failed: The provisioning of the AEM OpenCloud role failed.

ec2_tag_componentinitstatus
  • Amazon CloudWatch Logs contains all important log files of each main AEM OpenCloud role. Some important logs which support you troubleshooting are listed below.

General Logs:

/var/log/shinesolutions/puppet-stack-init.log
/var/log/cloud-init.log
/var/log/cloud-init-output.log

Role specific Logs:

/opt/aem/author/crx-quickstart/logs/error.log
/opt/aem/publish/crx-quickstart/logs/error.log

/var/log/httpd/access_log
/var/log/httpd/dispatcher.log
/var/log/httpd/error_log

/opt/shinesolutions/aem-orchestrator/orchestrator.log

Troubleshooting by Error messages:

  • OrchestratorAutoScalingGroup Received 1 FAILURE signal(s) out of 1. Unable to satisfy 100% MinSuccessfulInstancesPercent requirement.

Troubleshooting this error requires you to analyse the Orchestrator role logs on the EC2 instance:

/var/log/cloud-init-output.log
/opt/shinesolutions/aem-orchestrator/orchestrator.log

/var/log/cloud-init-output.log:

Analyse this log file for the test results of the AEM OpenCloud readiness check.

A successful component readiness check:

inspec exec . --show-progress --controls=\ author-primary-instance-provisioned-successful
.
Profile: AEM-AWS InSpec profile (aem-aws)
Version: 1.10.0
Target: local://
 ✔ author-primary-instance-provisioned-successful: Check if Author Primary instance has been provisioned successful
 ✔ ready is expected to have author primary instance been successful provision
Profile Summary: 1 successful control, 0 control failures, 0 controls skipped
Test Summary: 1 successful, 0 failures, 0 skipped

A failed component readiness check:

inspec exec . --show-progress --controls=\ author-primary-instance-provisioned-successful
F
Profile: AEM-AWS InSpec profile (aem-aws)
Version: 1.10.0
Target: local://
   ×  author-primary-instance-provisioned-successful: Check if Author Primary instance has been provisioned successful
      ×  ready is expected to have author primary instance been successful provision
   expected #has_author_primary_instance_been_successful_provision? to return true, got false
Profile Summary: 0 successful controls, 1 control failure, 0 controls skipped
Test Summary: 0 successful, 1 failure, 0 skipped

A running component readiness check:

inspec exec . --show-progress --controls=\ author-standby-instance-provisioned-successful

If a readiness check failed for an AEM OpenCloud role, start analysing the deployment logs of the failed role.

If the readiness check passed or was still running at the time of the failure start analysing the orchestrator log.

/opt/shinesolutions/aem-orchestrator/orchestrator.log:

The orchestrator log contains all log messages of all orchestration event.

This message indicates that the Orchestrator was unable to download the system-users-credentials file from S3. This happens if the system-users-credentials file was deleted or if the S3DataBucket is not in the same Region in which the AEM OpenCloud Quick Start is deployed.

DEBUG c.s.a.c.AemConfig$$EnhancerBySpringCGLIB$$56cbacf8 - Reading AEM credentials from S3 bucket
ERROR c.s.a.c.AemConfig$$EnhancerBySpringCGLIB$$56cbacf8 - Failed to read AEM credentials file from S3 location: s3://aem-opencloud/aoc-stack-1/system-users-credentials.json

If reading the AEM credentials from S3 was successful and the orchestrator log is showing no more log messages after the following log message:

[main] INFO  c.s.aemorchestrator.AemOrchestrator - Waiting for Author ELB to be in healthy state

It indicates that the provisioning of the Author-Primary role has not finished yet. Follow the guidelines described in the general troubleshooting notes for analysing errors for an AEM OpenCloud Role.

Send us feedback

To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. To submit code, see the Quick Start Contributor’s Guide.

Quick Start reference deployments

GitHub repository

Visit our GitHub repository to download the templates and scripts for this Quick Start, to post your comments, and to share your customizations with others.


Notices

This document is provided for informational purposes only. It represents AWS’s current product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS’s products or services, each of which is provided “as is” without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.

The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for specific language governing permissions and limitations.