To help you get going with deploying MarkLogic on Amazon Web Services (AWS), MarkLogic provides prebuilt Amazon Machine Images (AMIs) and ready for deployment CloudFormation Templates. The templates, which build on the AMIs, can be used to provision a MarkLogic Managed Cluster.
The best (and easiest) way to provision MarkLogic Managed Clusters is via Cloud Formation templates. Managed cluster provides the benefits of high-availability and scalability.
The templates serve both as Getting Started points as well as examples. Once you are comfortable with them, we encourage and expect you to copy and modify them to suit your specific needs. See our GitHub page to download and access the template.
NOTE: Successful launching of EC2 instances via a CloudFormation template requires acceptance of the License Agreement for the underlying AMI. Please visit the corresponding AWS Marketplace AMI page to accept the License Agreement before attempting to launch a stack from any of the templates.
For more information on how to deploy MarkLogic on EC2, please refer to the product documentation.
|Description||Template URL||Launch in US East Region|
|MarkLogic 11 Cluster in New VPC||mlcluster-vpc.template|
|MarkLogic 11 Cluster in existing VPC||mlcluster.template|
|MarkLogic 10 Cluster in New VPC||mlcluster-vpc.template|
|MarkLogic 10 Cluster in existing VPC||mlcluster.template|
|MarkLogic 9 Cluster in New VPC||mlcluster-vpc.template|
|MarkLogic 9 Cluster in existing VPC||mlcluster.template|
For these reasons, we highly recommend starting with the CloudFormation templates, even if you plan to start with a single-node cluster.
The Developer AMI is suited for a variety of purposes, from development to proof-of-concept work. Production use (or any use allowed by the terms of your license) of this AMI may also be supported if you bring your own license (BYOL). After you start up this AMI, you must request and install a free developer license key OR install your own pre-paid license key.
Custom AMIs can also be created using the MarkLogic installers, if preferred or necessary for your requirements. Note that provisioning the MarkLogic AMI by themselves does not automatically provide Managed Cluster features.
Here are the AWS Marketplace pages for the MarkLogic 11, 10 and 9 AMIs:
|MarkLogic 11 AMIs||MarkLogic 10 AMIs||MarkLogic 9 AMIs|
|Single-instance Developer (Free, BYOL)||Single-instance Developer (Free, BYOL)||Single-instance Developer (Free, BYOL)|
|Single-instance Essential Enterprise (Pay per hour)||Single-instance Essential Enterprise (Pay per hour)||Single-instance Essential Enterprise (Pay per hour)|
To gain the benefits of high-availability and scalability, the best practice is to provision is via CloudFormation templates and run MarkLogic as a cluster (see above). However, if you prefer to launch an AMI directly, here are the steps:
You can access our CloudFormation templates at our AWS GitHub page. Please feel free to download and modify the template as per your needs.
* Any distribution or sale of custom AMIs with MarkLogic installed is subject to MarkLogic License Agreement terms.
* If you are using Cloud Formation Templates published prior to MarkLogic 9.0-5 Release, you cannot upgrade automatically to 9.0-5 Cloud Formation Templates with VPC Support.
* Please refer to this knowledge base article if you want to upgrade to 1-click compatible MarkLogic AMI from a previously released MarkLogic AMI without pre-configured data volume (device on /dev/sdf).
* Since AWS retired the Classic Load Balancer (CLB) as of August 15, 2022, the CLB feature has been removed from the MarkLogic CloudFormation templates starting with these MarkLogic Server versions:
Starting with those versions, the MarkLogic CloudFormation templates now work like this:
* Starting with MarkLogic 11.1.0, the MarkLogic CloudFormation Templates replace the use of Launch Configurations with Launch Templates. This ensures that MarkLogic CFT users can make use of all of the Amazon EC2 Auto Scaling features now available in Launch Templates.
* Additionally, MarkLogic 11.1.0 adds support for IMDSv2. The IMDSv2 option is set to “required” by default in the 11.1.0 and later CFTs. In order to use MarkLogic Server AMIs before 11.1.0 with the new templates, the templates need to be modified to set IMDSv2 to “optional” as IMDSv2 is not supported in earlier versions of the MarkLogic AMI.