Confluence Data Center on the AWS Cloud

Quick Start Reference Deployment

QS

October 2020
Adam Brokes, Ben Partridge, Carlos Corredor, Chris Szmajda, Don Domingo, Dylan Rathbone, Felix Haehnel, Steve Smith, Varun Arbatti
Tony Vattathil - Principal Solutions Architect, AWS

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 Atlassian 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 is for users who want to deploy Confluence Data Center in a supported configuration in the AWS Cloud, following AWS and Atlassian best practices.

This Quick Start uses the Atlassian Standard Infrastructure (ASI) as a foundation. You can choose to build a new ASI for your deployment or deploy Confluence into your existing ASI. You can also deploy Jira, Bitbucket, and Crowd Data Center within the same ASI.

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

Confluence Data Center on AWS

Confluence is Atlassian’s team collaboration software that changes how modern teams work. Confluence Data Center is a self-managed solution that gives you high availability, performance at scale, and disaster recovery for uninterrupted access to Confluence for all your teams.

Please know that we may share who uses AWS Quick Starts with the AWS 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 deploys a cluster-ready infrastructure for Confluence. This requires a Confluence Data Center license. See the Atlassian pricing page for licensing information.

Architecture

Deploying this Quick Start for a new Atlassian Standard Infrastructure (ASI) with default parameters builds the following Confluence environment in the AWS Cloud.

Architecture
Figure 1. Quick Start architecture for Confluence on AWS

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

  • A highly available architecture that spans two Availability Zones.

  • In the public subnets:

    • A network address translation (NAT) gateway to allow outbound internet access for resources in the private subnets.

    • A bastion host that enables secure access to Confluence without exposing it to the internet. For more information, see Bastion Hosts). You can choose not to provision a bastion host if you prefer to access Confluence nodes through the AWS Systems Manager.

  • In the private subnets:

    • Amazon Elastic File System (Amazon EFS) to store artifacts such as attachments, avatars, icons, import and export files, and plug-ins in a common location that can be accessed by all Confluence nodes.

    • Amazon Relational Database Service (Amazon RDS) for PostgreSQL in a high-availability (Multi-AZ) configuration, which mitigates failover if the master node fails. You can choose Amazon Aurora PostgreSQL instead.

  • Amazon Elastic Compute Cloud (Amazon EC2) Auto Scaling groups for scaling the bastion hosts in the public subnets and the Confluence nodes in the private subnets. The instances are based on Amazon Linux, a Linux server operating system from AWS, and use an Atlassian-provided Amazon Machine Image (AMI).

  • An Application Load Balancer, which works both as a load balancer and a Secure Sockets Layer (SSL) termination reverse proxy.

  • Amazon CloudWatch for basic monitoring of all application and database nodes in your deployment. By default, CloudWatch collects and stores logs from each monitored node. Amazon CloudWatch is an optional component.

Auto Scaling groups in this Quick Start

This Quick Start uses Auto Scaling groups to statically control the number of its nodes. Don’t use Auto Scaling to dynamically scale the size of your cluster. Adding an application node to the cluster usually takes more than 20 minutes, which isn’t fast enough to address sudden load spikes.

If you can identify periods of high and low loads, you can schedule the application node cluster to scale accordingly. For more information, see Scheduled Scaling for Amazon EC2 Auto Scaling.

To study trends in your organization’s load, be sure to monitor the performance of your deployment.

Amazon Aurora database for high availability

The Quick Start also allows you to deploy Confluence Data Center with an Amazon Aurora clustered database (instead of RDS).

You can also use this Quick Start to deploy Confluence Data Center with an Aurora clustered database that’s compatible with PostgreSQL. The cluster configuration is illustrated in Figure 2. It features a primary database writer that replicates to two database readers in a different Availability Zone. If the writer fails, Aurora promotes one of the readers to take its place with no downtime. For more information, see Amazon Aurora Features: PostgreSQLCompatible Edition.

The Aurora configuration with a single database writer and two readers is designed to provide high availability without degrading performance.

Amazon Aurora
Figure 2. Amazon Aurora reader/writer 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 managing Atlassian Confluence. Refer to the latest Atlassian documentation for Confluence for more information.

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 need to request increases if your existing deployment currently uses these resources and if this Quick Start deployment could result in exceeding the default quotas. 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

VPC (ASI)

1

Auto Scaling groups

1 (2 if a Bastion Host is provisioned)

Application Load Balancers

1

Elastic IP addresses

variable based on user configuration

AWS Identity and Access Management (IAM) security groups

variable based on user configuration

IAM roles

variable based on user configuration

EC2 instances

variable based on user configuration

Supported AWS Regions

For any Quick Start to work in a Region other than its default Region, all the services it deploys must be supported in that Region. You can launch a Quick Start in any Region and see if it works. If you get an error such as “Unrecognized resource type,” the Quick Start is not supported in that Region.

For an up-to-date list of AWS Regions and the AWS services they support, see AWS Regional Services.

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

Amazon EC2 key pairs

Ensure that at least one Amazon EC2 key pair exists in your AWS account in the Region where you plan to deploy the Quick Start. Note the key-pair name because you will use it during deployment. To create a key pair, see Amazon EC2 key pairs and Linux instances.

For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already being used by a production instance.

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.

Deployment options

This Quick Start includes two AWS CloudFormation templates. The first template builds the Atlassian Standard Infrastructure (ASI), which is a virtual private cloud (VPC) that contains the components required by all Atlassian applications, and then provisions Confluence into this ASI. The second template provisions Confluence in an existing ASI.

Using these templates, the Quick Start provides two deployment options:

  • Deploy Confluence Data Center into a new ASI (end-to-end deployment). Choose this option if you’re a new user. This option builds the Atlassian Standard Infrastructure (ASI), which is a VPC that consists of the subnets, NAT gateways, security groups, and other infrastructure components required by all Atlassian applications. It then deploys Confluence into this new VPC.

  • Deploy Confluence Data Center into an existing ASI. This option provisions Confluence in an existing ASI, and also offers more customizable parameters. Choose this option if you’ve already deployed the ASI separately by using the ASI Quick Start, or by deploying another Atlassian product from a Quick Start (Jira Software/Service Desk Data Center, Confluence Data Center, Bitbucket Data Center, or Crowd Data Center).

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

Deployment steps

The fastest way to deploy Confluence with this Quick Start is directly through its AWS Quick Start interface. However, when you deploy Confluence this way, any updates that are made to the Quick Start templates propagate directly to your production deployment. These updates sometimes involve adding or removing parameters, which could introduce unexpected changes or break your deployment.

As a best practice, instead of deploying directly through the AWS Quick Start interface, clone the Confluence Quick Start templates to a custom Amazon Simple Storage Service (Amazon S3) bucket. Then, launch the templates directly from the S3 bucket. This practice lets you control when to apply the latest changes to your environment.

  1. Clone a local copy of the Quick Start templates (including all of its submodules). From the command line, run:

    git clone --recurse-submodules https://github.com/aws-quickstart/quickstart-atlassian-confluence.git
  2. (Optional) The Quick Start templates repository uses the directory structure required by the Quick Start interface. If needed (for example, to minimize storage costs), you can remove all other files except the following:

    quickstart-atlassian-confluence
    ├── submodules
    ├── quickstart-atlassian-services
    │   └── templates
    │       └── quickstart-vpc-for-atlassian-services.yaml
    └── templates
        ├── quickstart-confluence-master-with-vpc.template.yaml
        └── quickstart-confluence.template.yaml
  3. Install and set up the AWS Command Line Interface (CLI) so that you can create an S3 bucket and upload content to it.

  4. Create an S3 bucket in your Region:

    aws s3 mb s3://<BUCKET_NAME> --region <AWS_REGION>
  5. Choose which Quick Start template to use:

    • quickstart-confluence-master-with-vpc.template.yaml: Use this template for deploying Confluence into a new ASI (end-to-end deployment).

    • quickstart-confluence.template.yaml: Use this template for deploying Confluence into an existing ASI.

  6. In both templates, the QSS3BucketName default value is set to aws-quickstart. Replace this value with the name of the bucket you created earlier (<BUCKET_NAME>).

  7. Return to the parent directory of your local clone of the Quick Start templates. From there, upload all the files in your local clone to your S3 bucket:

    aws s3 cp quickstart-atlassian-confluence s3://<BUCKET_NAME> --recursive --acl public-read

After everything is uploaded, you can deploy your production stack from your S3 bucket.

  1. Sign in to your AWS account on the AWS Console.

  2. Check the AWS Region displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where {product-partner-name-short} is built. The template is launched in the us-east-2 Region by default.

  3. Go to CloudFormation > Create Stack. When specifying a template, paste in the Object URL of the Quick Start template that you are using for the deployment. Choose Next to start configuring your deployment.

  4. On the Specify stack details page, change the stack name, if needed. Review the parameters for the template, and provide values for parameters that require input. For all other parameters, review the default settings and customize them as necessary. For details about each setting, refer to the section matching your deployment type:

    • [launch-into-a-new-vpc] (if you’re deploying an ASI with Confluence)

    • [launch-into-an-existing-vpc] (if you’re deploying Confluence into a new ASI)

      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.

      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 an existing VPC

Table 1. Confluence setup
Parameter label (name) Default value Description

Collaborative editing mode (CollaborativeEditingMode)

synchrony-local

Collaborative Editing can be off, run locally on the Confluence nodes (requires Confluence version 6.12+ and 1 GB heap free for Synchrony), or run on a separately autoscaled group of nodes.

Version * (ConfluenceVersion)

7.13.0

The version of Confluence to install

Table 2. Cluster nodes
Parameter label (name) Default value Description

Enable CloudWatch integration (CloudWatchIntegration)

Metrics and Logs

Enables CloudWatch metrics with or without log gathering. If cost is an issue, you can disable this altogether.

Cluster node instance type (ClusterNodeInstanceType)

c5.xlarge

Instance type for the cluster application nodes (note - for "synchrony-local" collaborative editing you must choose an instance size with over 5 GB RAM).

Maximum number of cluster nodes (ClusterNodeMax)

1

Maximum number of nodes in the cluster.

Minimum number of cluster nodes (ClusterNodeMin)

1

Set to 1 for new deployment. Can be updated post launch.

Cluster node instance volume size (ClusterNodeVolumeSize)

50

Size of cluster node root volume in GB (note - size based upon Application indexes x 4).

Maximum number of Synchrony cluster nodes (SynchronyClusterNodeMax)

1

Maximum number of Synchrony cluster nodes.

Minimum number of Synchrony cluster nodes (SynchronyClusterNodeMin)

1

Minimum number of Synchrony cluster nodes.

Synchrony cluster node instance type (SynchronyNodeInstanceType)

t3.medium

Synchrony cluster node instance type.

Deployment Automation Git Repository URL (DeploymentAutomationRepository)

https://bitbucket.org/atlassian/dc-deployments-automation.git

The deployment automation repository to use for per-node initialization. Leave this as default unless you have customizations.

Deployment Automation Branch (DeploymentAutomationBranch)

master

The deployment automation repository branch to pull from.

Ansible playbook (DeploymentAutomationPlaybook)

aws_confluence_dc_node.yml

The Ansible playbook to invoke to initialize the application node on first start.

Custom command-line parameters for Ansible (DeploymentAutomationCustomParams)

Blank string

Additional command-line options for the ansible-playbook command. See https://bitbucket.org/atlassian/dc-deployments-automation/src/master/README.md for more information about overriding parameters. (Optional)

SSH keyname to use with the repository (DeploymentAutomationKeyName)

Blank string

Named Key Pair name to use with this repository. The key should be imported into the SSM parameter store. (Optional)

Table 3. Database
Parameter label (name) Default value Description

Database engine (DBEngine)

PostgreSQL

The database engine to use. The default is PostgreSQL (Amazon RDS for PostgreSQL). You can choose Amazon Aurora PostgreSQL.

The database engine version to use (DBEngineVersion)

10

The database engine version to use; we’ll install a suitable minor version for your chosen engine. Make sure that the Confluence version you’re installing supports the database engine selected.

Database instance class (DBInstanceClass)

db.m4.large

RDS instance type (must be R4 family if using Amazon Aurora).

RDS Provisioned IOPS (DBIops)

1000

Must be in the range of 1000 - 30000 and a multiple of 1000. This value is only used with Provisioned IOPS. Note: The ratio of IOPS per allocated-storage must be between 3.00 and 10.00. Not used for Amazon Aurora.

Master (admin) password * (DBMasterUserPassword)

Requires input

Password for the master ('postgres') account. Must be at least 8 characters and include 1 uppercase, 1 lowercase, 1 number, and 1 of the following symbols: ! # $ { * : [ = , ] - _ + % &

Enable RDS Multi-AZ deployment (DBMultiAZ)

true

When DBEngine is 'PostgreSQL', this will determine whether to provision a multi-AZ RDS instance. When DBEngine is 'Amazon Aurora PostgreSQL', this will determine whether to provision a single or a multiple-node Amazon Aurora cluster.

Application user database password * (DBPassword)

Requires input

Database password used by Confluence. Must be at least 8 characters and include 1 uppercase, 1 lowercase, 1 number, and 1 of the following symbols: ! # $ { * : [ = , ] - _ @ + % &

Database storage (DBStorage)

200

Database allocated storage size, in gigabytes (GB). If you choose Provisioned IOPS, storage should be between 100 and 6144. Not used for Amazon Aurora.

Database encryption (DBStorageEncrypted)

false

Whether or not to encrypt the database.

Database storage type (DBStorageType)

General Purpose (SSD)

Database storage type. Not used for Amazon Aurora.

Table 4. Bastion host utilization
Parameter label (name) Default value Description

Use Bastion host (BastionHostRequired)

true

Whether to grant access to Confluence EC2 instances through the ASI’s Bastion host (if it exists). If 'true', remember to provide an EC2 Key Pair. If your ASI does not have a Bastion host, set this to 'false'.

SSH Key Pair Name (KeyPairName)

Blank string

Public/private EC2 Key Pairs (without file extension) to allow you to securely access the Bastion host.

Table 5. Networking
Parameter label (name) Default value Description

Permitted IP range (CidrBlock)

Requires input

CIDR block allowed to access the Atlassian product. This should be set to a trusted IP range; if you want to give public access use '0.0.0.0/0'.

Make instance internet facing (InternetFacingLoadBalancer)

true

Controls whether the load balancer should be visible to the internet (true) or only within the VPC (false).

SSL Certificate ARN (SSLCertificateARN)

Blank string

Amazon Resource Name (ARN) of your SSL certificate. If you want to use your own certificate that you generated outside of Amazon, you need to first import it to AWS Certificate Manager. After a successful import, you’ll receive the ARN. If you want to create a certificate with AWS Certificate Manager (ACM certificate), you will receive the ARN after it’s successfully created.

Table 6. DNS
Parameter label (name) Default value Description

Existing DNS name (CustomDnsName)

Blank string

(Optional) Use custom existing DNS name for your Data Center instance. This will take precedence over HostedZone. Please note: you must own the domain and configure it to point at the load balancer.

Route 53 Hosted Zone (HostedZone)

Blank string

(Optional) The domain name of the Amazon Route 53 PRIVATE Hosted Zone in which to create cnames.

Table 7. Advanced (Optional)
Parameter label (name) Default value Description

Remember Me cookie expiry (AutologinCookieAge)

Blank string

Sets the Remember Me (autologin) cookie expiry length in seconds. If blank this defaults to 1 year.

Table 8. Application tuning
Parameter label (name) Default value Description

Tomcat Context Path (TomcatContextPath)

Blank string

The context path of this web application, which is matched against the beginning of each request URI to select the appropriate web application for processing. If used, must include leading "/". See http://tomcat.apache.org/tomcat-8.0-doc/config/http.html for reference on tuning tomcat parameters.

Catalina options (CatalinaOpts)

Blank string

Java options that are passed to the Java virtual machine (JVM) that runs Confluence.

Confluence Heap Size Override (JvmHeapOverride)

Blank string

The heap size to use, in MB (e.g., 1024m) or GB (e.g., 1g), to override the default amount of memory to allocate to the JVM for your instance type.

Synchrony Heap Size Override (JvmHeapOverrideSynchrony)

Blank string

The heap size to use, in MiB (e.g., 1024m) or GiB (e.g., 1g), to override the default amount of memory to allocate to the JVM for Synchrony.

DB Pool Maximum Size (DBPoolMaxSize)

60

The maximum number of database connections that can be opened at any time. See https://confluence.atlassian.com/doc/performance-tuning-130289.html for reference on tuning database parameters.

DB Pool Minimum Size (DBPoolMinSize)

20

The minimum number of idle database connections that are kept open at any time.

DB Timeout (DBTimeout)

30

Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled.

DB Idle Test Period (DBIdleTestPeriod)

100

If greater than 0, this is the frequency (in seconds) that c3po will test all idle, pooled but unchecked-out connections.

DB Max Statements (DBMaxStatements)

0

The size of c3p0’s global PreparedStatement cache. It controls the total number of statements cached, for all connections. If set, it should be a fairly large number, as each pooled Connection requires its own, distinct flock of cached statements.

DB Validate (DBValidate)

false

If true, a connection test will be performed at every connection checkout to verify that the connection is valid.

DB Preferred Test Query (DBPreferredTestQuery)

select version();

The query that will be executed for all connection tests.

DB Acquire Increment (DBAcquireIncrement)

1

Determines how many connections at a time c3p0 will try to acquire when the pool is exhausted.

Enable App to Process Email (MailEnabled)

true

Enable mail processing and sending.

Tomcat Accept Count (TomcatAcceptCount)

10

The maximum queue length for incoming connection requests when all possible request processing threads are in use.

Tomcat Connection Timeout (TomcatConnectionTimeout)

20000

The number of milliseconds this connector will wait, after accepting a connection, for the request URI line to be presented.

Tomcat Default Connector Port (TomcatDefaultConnectorPort)

8080

The port on which to serve the application.

Tomcat Enable DNS Lookups (TomcatEnableLookups)

false

Set to true if you want calls to request.getRemoteHost() to perform DNS lookups in order to return the actual host name of the remote client.

Tomcat Maximum Threads (TomcatMaxThreads)

48

The maximum number of request processing threads to be created by this connector, which therefore determines the maximum number of simultaneous requests that can be handled.

Tomcat Minimum Spare Threads (TomcatMinSpareThreads)

10

The minimum number of threads always kept running.

Tomcat Protocol (TomcatProtocol)

HTTP/1.1

Sets the protocol to handle incoming traffic.

Tomcat Redirect Port (TomcatRedirectPort)

8443

The port number for Catalina to use when automatically redirecting a non-SSL connector actioning a redirect to a SSL URI.

Table 9. 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. Quick Start bucket name can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

Quick Start S3 Key Prefix (QSS3KeyPrefix)

quickstart-atlassian-confluence/

S3 key prefix for the Quick Start assets. Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/).

ASI identifier (ExportPrefix)

ATL-

Identifier used in all variables exported from this deployment’s Atlassian Standard Infrastructure (VPCID, SubnetIDs, KeyName). Use different identifier to deploy multiple Atlassian Standard Infrastructures in the same AWS region.

Launch into a new VPC

Table 10. Confluence setup
Parameter label (name) Default value Description

Collaborative editing mode (CollaborativeEditingMode)

synchrony-local

Collaborative Editing can be off, run locally on the Confluence nodes (requires Confluence version 6.12+ and 1 GB heap free for Synchrony), or run on a separately autoscaled group of nodes.

Version * (ConfluenceVersion)

7.13.0

The version of Confluence to install

Table 11. Cluster nodes
Parameter label (name) Default value Description

Enable CloudWatch integration (CloudWatchIntegration)

Metrics and Logs

Enables CloudWatch metrics with or without log gathering. If cost is an issue, you can disable this altogether.

Cluster node instance type (ClusterNodeInstanceType)

c5.xlarge

Instance type for the cluster application nodes (note - for "synchrony-local" collaborative editing you must choose an instance size with over 5 GB RAM).

Maximum number of cluster nodes (ClusterNodeMax)

1

Maximum number of nodes in the cluster.

Minimum number of cluster nodes (ClusterNodeMin)

1

Set to 1 for new deployment. Can be updated post launch.

Cluster node instance volume size (ClusterNodeVolumeSize)

50

Size of cluster node root volume in GB (note - size based upon Application indexes x 4).

Maximum number of Synchrony cluster nodes (SynchronyClusterNodeMax)

1

Maximum number of Synchrony cluster nodes.

Minimum number of Synchrony cluster nodes (SynchronyClusterNodeMin)

1

Minimum number of Synchrony cluster nodes.

Synchrony cluster node instance type (SynchronyNodeInstanceType)

t3.medium

Synchrony cluster node instance type.

Deployment Automation Git Repository URL (DeploymentAutomationRepository)

https://bitbucket.org/atlassian/dc-deployments-automation.git

The deployment automation repository to use for per-node initialization. Leave this as default unless you have customizations.

Deployment Automation Branch (DeploymentAutomationBranch)

master

The deployment automation repository branch to pull from.

Ansible playbook (DeploymentAutomationPlaybook)

aws_confluence_dc_node.yml

The Ansible playbook to invoke to initialize the application node on first start.

Custom command-line parameters for Ansible (DeploymentAutomationCustomParams)

Blank string

Additional command-line options for the ansible-playbook command. See https://bitbucket.org/atlassian/dc-deployments-automation/src/master/README.md for more information about overriding parameters. (Optional)

SSH keyname to use with the repository (DeploymentAutomationKeyName)

Blank string

Named Key Pair name to use with this repository. The key should be imported into the SSM parameter store. (Optional)

Table 12. Database
Parameter label (name) Default value Description

Database engine (DBEngine)

PostgreSQL

The database engine to use. The default is PostgreSQL (Amazon RDS for PostgreSQL). You can choose Amazon Aurora PostgreSQL.

The database engine version to use (DBEngineVersion)

10

The database engine version to use; we’ll install a suitable minor version for your chosen engine. Make sure that the Confluence version you’re installing supports the database engine selected.

Database instance class (DBInstanceClass)

db.m4.large

RDS instance type (must be R4 family if using Amazon Aurora).

RDS Provisioned IOPS (DBIops)

1000

Must be in the range of 1000 - 30000 and a multiple of 1000. This value is only used with Provisioned IOPS. Note: The ratio of IOPS per allocated-storage must be between 3.00 and 10.00. Not used for Amazon Aurora.

Master (admin) password * (DBMasterUserPassword)

Requires input

Password for the master ('postgres') account. Must be at least 8 characters and include 1 uppercase, 1 lowercase, 1 number, and 1 of the following symbols: ! # $ { * : [ = , ] - _ + % &

Enable RDS Multi-AZ deployment (DBMultiAZ)

true

When DBEngine is 'PostgreSQL', this will determine whether to provision a multi-AZ RDS instance. When DBEngine is 'Amazon Aurora PostgreSQL', this will determine whether to provision a single or a multiple-node Amazon Aurora cluster.

Application user database password * (DBPassword)

Requires input

Database password used by Confluence. Must be at least 8 characters and include 1 uppercase, 1 lowercase, 1 number, and 1 of the following symbols: ! # $ { * : [ = , ] - _ @ + % &

Database storage (DBStorage)

200

Database allocated storage size, in gigabytes (GB). If you choose Provisioned IOPS, storage should be between 100 and 6144. Not used for Amazon Aurora.

Database encryption (DBStorageEncrypted)

false

Whether or not to encrypt the database.

Database storage type (DBStorageType)

General Purpose (SSD)

Database storage type. Not used for Amazon Aurora.

Table 13. Bastion host provisioning
Parameter label (name) Default value Description

Deploy Bastion host (BastionHostRequired)

true

Whether to provision a Bastion host instance. If 'true', then you need to provide an EC2 Key Pair (otherwise, you won’t be able to use the Bastion host to access Confluence instances).

SSH Key Pair Name (KeyPairName)

Blank string

Public/private EC2 Key Pairs (without file extension) to allow you to securely access the Bastion host.

Table 14. Networking
Parameter label (name) Default value Description

Availability Zones (AvailabilityZones)

Requires input

List of Availability Zones to use for the subnets in the VPC. Note: You must specify 2 Availability Zones here; if more are specified, only the first 2 will be used.

Permitted IP range (CidrBlock)

Requires input

CIDR block allowed to access the Atlassian product. This should be set to a trusted IP range; if you want to give public access use '0.0.0.0/0'.

Make instance internet facing (InternetFacingLoadBalancer)

true

Controls whether the load balancer should be visible to the internet (true) or only within the VPC (false).

SSL Certificate ARN (SSLCertificateARN)

Blank string

Amazon Resource Name (ARN) of your SSL certificate. If you want to use your own certificate that you generated outside of Amazon, you need to first import it to AWS Certificate Manager. After a successful import, you’ll receive the ARN. If you want to create a certificate with AWS Certificate Manager (ACM certificate), you will receive the ARN after it’s successfully created.

Table 15. DNS
Parameter label (name) Default value Description

Existing DNS name (CustomDnsName)

Blank string

(Optional) Use custom existing DNS name for your Data Center instance. This will take precedence over HostedZone. Please note: you must own the domain and configure it to point at the load balancer.

Route 53 Hosted Zone (HostedZone)

Blank string

(Optional) The domain name of the Amazon Route 53 PRIVATE Hosted Zone in which to create cnames.

Table 16. Application tuning
Parameter label (name) Default value Description

Tomcat Context Path (TomcatContextPath)

Blank string

The context path of this web application, which is matched against the beginning of each request URI to select the appropriate web application for processing. If used, must include leading "/". See http://tomcat.apache.org/tomcat-8.0-doc/config/http.html for reference on tuning tomcat parameters.

Catalina options (CatalinaOpts)

Blank string

Java options that are passed to the Java virtual machine (JVM) that runs Confluence.

Confluence Heap Size Override (JvmHeapOverride)

Blank string

The heap size to use, in MB (e.g., 1024m) or GB (e.g., 1g), to override the default amount of memory to allocate to the JVM for your instance type.

Synchrony Heap Size Override (JvmHeapOverrideSynchrony)

Blank string

The heap size to use, in MiB (e.g., 1024m) or GiB (e.g., 1g), to override the default amount of memory to allocate to the JVM for Synchrony.

DB Pool Maximum Size (DBPoolMaxSize)

60

The maximum number of database connections that can be opened at any time. See https://confluence.atlassian.com/doc/performance-tuning-130289.html for reference on tuning database parameters.

DB Pool Minimum Size (DBPoolMinSize)

20

The minimum number of idle database connections that are kept open at any time.

DB Timeout (DBTimeout)

30

Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled.

DB Idle Test Period (DBIdleTestPeriod)

100

If greater than 0, this is the frequency (in seconds) that c3po will test all idle, pooled but unchecked-out connections.

DB Max Statements (DBMaxStatements)

0

The size of c3p0’s global PreparedStatement cache. It controls the total number of statements cached, for all connections. If set, it should be a fairly large number, as each pooled Connection requires its own, distinct flock of cached statements.

DB Validate (DBValidate)

false

If true, a connection test will be performed at every connection checkout to verify that the connection is valid.

DB Preferred Test Query (DBPreferredTestQuery)

select version();

The query that will be executed for all connection tests.

DB Acquire Increment (DBAcquireIncrement)

1

Determines how many connections at a time c3p0 will try to acquire when the pool is exhausted.

Enable App to Process Email (MailEnabled)

true

Enable mail processing and sending.

Tomcat Accept Count (TomcatAcceptCount)

10

The maximum queue length for incoming connection requests when all possible request processing threads are in use.

Tomcat Connection Timeout (TomcatConnectionTimeout)

20000

The number of milliseconds this connector will wait, after accepting a connection, for the request URI line to be presented.

Tomcat Default Connector Port (TomcatDefaultConnectorPort)

8080

The port on which to serve the application.

Tomcat Enable DNS Lookups (TomcatEnableLookups)

false

Set to true if you want calls to request.getRemoteHost() to perform DNS lookups in order to return the actual host name of the remote client.

Tomcat Maximum Threads (TomcatMaxThreads)

48

The maximum number of request processing threads to be created by this connector, which therefore determines the maximum number of simultaneous requests that can be handled.

Tomcat Minimum Spare Threads (TomcatMinSpareThreads)

10

The minimum number of threads always kept running.

Tomcat Protocol (TomcatProtocol)

HTTP/1.1

Sets the protocol to handle incoming traffic.

Tomcat Redirect Port (TomcatRedirectPort)

8443

The port number for Catalina to use when automatically redirecting a non-SSL connector actioning a redirect to a SSL URI.

Table 17. 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. Quick Start bucket name can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

Quick Start S3 Key Prefix (QSS3KeyPrefix)

quickstart-atlassian-confluence/

S3 key prefix for the Quick Start assets. Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/).

ASI identifier (ExportPrefix)

ATL-

Identifier used in all variables exported from this deployment’s Atlassian Standard Infrastructure (VPCID, SubnetIDs, KeyName). Use different identifier to deploy multiple Atlassian Standard Infrastructures in the same AWS region.

+ . On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you finish, 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 Confluence Data Center deployment is ready. . To view the created resources, see the values displayed in the Outputs tab for the stack.

Configuring Confluence

The following procedure helps you set up your new Confluence deployment.

  1. Choose the URL that is displayed in the Outputs tab of the AWS CloudFormation stack to go to the Confluence configuration page.

    If you get an HTTP Error 503 response when you access the URL, it means that Confluence is still loading. This is expected, and you should wait a couple of minutes before trying again.
  2. In the Get add-ons page, choose Next. You can enable add-ons after setup if you wish.

    qs step2 connie get addons
    Figure 3. Get add-ons
  3. On the License key page, enter a valid Confluence Data Center license, and then choose Next. If you don’t have a valid license for Confluence Data Center, choose Get an evaluation license. You’ll be taken to http://my.atlassian.com where you can generate an evaluation license. You can’t use a Confluence Server license with this Quick Start.

    qs step3 connie license
    Figure 4. License key
  4. On the Load Content page, choose Example Site.

    qs step4 connie loadcontent
    Figure 5. Load Content
  5. On the Configure User Management page, choose Manage Users and Groups within Confluence.

    qs step5 connie configusermgt
    Figure 6. Configure User Management
  6. To set up Confluence Data Center, you need to create an administrator account and password. The administrator account has full access to all data in Confluence, so we highly recommend that you choose a strong password for this account. Enter the administrator’s user details, and then choose Next.

    qs step6 connie sysadmin account
    Figure 7. Configure System Administrator Account
  7. You should now see the Setup Successful page. Choose Further configuration to go directly to the Confluence administration console, and log in with the administrator user account you created in the previous step.

    qs step7 connie loggingin
    Figure 8. Administrator Access
  8. Go to Clustering in the administration console sidebar. You should see a page similar to the one below, which shows that the node is ready for clustering.

    qs step8 connie sndc
    Figure 9. Clustering (single node)

Your Confluence Data Center deployment is now in a state where you can add nodes that will automatically cluster with your existing node.

Adding nodes to the Confluence cluster

By default, your Quick Start deployment starts with a single Confluence node (Auto Scaling group of min=1 and max=1). When you’re ready to add nodes to your cluster, perform the following steps:

  1. Sign in to the AWS Management Console, use the Region selector in the navigation bar to choose the AWS Region for your deployment, and open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation/.

  2. Choose the Confluence stack. From the Actions list, choose Update Stack.

  3. On the Select Template page, leave Use current template selected, and then choose Next.

  4. On the Specify Details page, in the Confluence Setup section of Parameters, enter the number of cluster nodes in Minimum number of cluster nodes and Maximum number of cluster nodes, and then click through to update the stack. This step sets a static number of nodes in your cluster.

  5. After the stack finishes updating, verify the number of nodes in your Confluence cluster. Choose Clustering again from the administration console sidebar. The following example shows a cluster that is scaled up to three instances.

    qs step9 connie clustering
    Figure 10. Clustering (multiple nodes)

(Optional) Adding nodes to the stand-alone Synchrony cluster

Proceed with this step only if you set Collaborative editing mode to synchrony-separate-nodes (Standalone Synchrony cluster).
  1. Sign in to the AWS Management Console, use the Region selector in the navigation bar to choose the AWS Region for your deployment, and open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation/.

  2. Choose the Confluence stack. From the Actions list, choose Update Stack.

  3. On the Select Template page, leave Use current template selected, and then choose Next.

  4. On the Specify Details page, in the Confluence Setup section of Parameters, enter the number of cluster nodes in Minimum number of Synchrony cluster nodes and Maximum number of Synchrony cluster nodes, and then click through to update the stack. This step sets a static number of nodes in your cluster.

(If needed) Enabling collaborative editing

In older versions of Confluence Data Center, Collaborative Editing is disabled by default. If it is, you’ll need to manually enable it.
  1. In Confluence Data Center, go to icon gear > General Configuration > Collaborative editing, and check whether collaborative editing is disabled (off).

    qs collabediting step1
    Figure 11. Collaborative editing (off)
  2. If Collaborative editing is disabled, choose Change Mode. From the Change editing mode page, choose On, and then choose Change.

    qs collabediting step2
    Figure 12. Change editing mode
  3. Verify that collaborative editing is on and that the status of Synchrony is Running.

    qs collabediting step3
    Figure 13. Collaborative editing (on)

Troubleshooting

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

A. If AWS CloudFormation fails to create the stack, relaunch the template with Rollback on failure set to Disabled. (This setting is under Advanced in the AWS CloudFormation console on the Options page.) With this setting, the stack’s state is retained and the instance is left running, so you can troubleshoot the issue. (Review the log files in /var/log/atl.log and /var/log/cfn-init.log.)

When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Ensure that you 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. 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 the AWS documentation.

Customer responsibility

After you successfully deploy this Quick Start, confirm that your resources and services are updated and configured — including any required patches — to meet your security and other needs. For more information, see the AWS Shared Responsibility Model.

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.