Boomi Atom on AWS

Partner Solution Deployment Guide

July 2022
Sean Williams and Ryan Vanderwerf, AWS ISV Partner Management team
Andrew Glenn, AWS Integration & Automation team

Refer to the GitHub repository to view source files, report bugs, submit feature ideas, and post feedback about this Partner Solution. To comment on the documentation, refer to Feedback.

This Partner Solution was created by Boomi in collaboration with Amazon Web Services (AWS). Partner Solutions are automated reference deployments that help people deploy popular technologies on AWS according to AWS best practices. If you’re unfamiliar with AWS Partner Solutions, refer to the AWS Partner Solution General Information Guide.

Overview

This Partner Solution reference deployment guide walks you through the steps for deploying Boomi Atom on the AWS Cloud. It does not require deep knowledge of AWS or Linux system administration.

This Partner Solution is for users who are looking for an integration platform as a service (iPaaS) solution hosted on the AWS Cloud. With it, you can deploy Boomi Atom on AWS and administer it through the Boomi Atom AtomSphere platform.

Costs and licenses

This Partner Solution requires a Boomi account. The Boomi account you use to deploy this Partner Solution will determine the licensing model that applies. Licensing costs are managed by Boomi, and Boomi applies standard connector metering charges to workloads using a Boomi account. However, you can also use this Partner Solution to deploy a Boomi Atom server that will run trial or training workloads.

There is no cost to use this Partner Solution, but you will be billed for any AWS services or resources that this Partner Solution deploys. For more information, refer to the AWS Partner Solution General Information Guide.

Architecture

Deploying this Partner Solution with default parameters builds the following Boomi Atom environment in the AWS Cloud.

Figure 1. Partner Solution architecture for Boomi Atom on AWS

As shown in Figure 1, this Partner Solution 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:
- A managed network address translation (NAT) gateway to allow outbound internet access for resources in the private subnets.*
- A Linux bastion host to allow inbound SSH (Secure Shell) access to Amazon Elastic Compute Cloud (Amazon EC2) instances in public and private subnets.*
In the private subnets, Boomi Atom installed on an Amazon EC2 instance running Amazon Linux 2.
An Amazon CloudWatch alarm to monitor EC2 instances and initiate recovery actions if an instance fails.

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

Because of the limitations of single-use installation tokens, this Partner Solution does not deploy Auto Scaling groups or load balancers. To deploy highly available Boomi Atom instances with multiple nodes and load balancing, consider deploying Boomi Molecule on AWS.

Deployment options

This Partner Solution provides the following deployment options:

Deploy Boomi Atom into a new VPC. This option builds a new AWS environment that consists of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys Boomi Atom into this new VPC.
Deploy Boomi Atom into an existing VPC. This option provisions Boomi Atom in your existing AWS infrastructure.

This Partner Solution provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and Boomi Atom settings.

Predeployment steps

This Partner Solution requires a Boomi account. Also, to install Boomi Atom locally, you must have the following:

Boomi AtomSphere login credentials (user name and password) with permissions to create Atoms.
A valid Boomi installer token that is compatible with Multi-Factor Authentication (MFA).

Generating a Boomi installer token

When deploying this Partner Solution, you can specify a Boomi AtomSphere username and password or a valid Boomi installer token, depending on how you want to authenticate the Atom. To generate an installer token, do the following:

Log in to Boomi AtomSphere.
Select Build.
On the Welcome tab, select Atom under Atom Runtime.
In the Atom Setup window, select Security Options.
From the Token Valid For dropdown list, select the length of time for which the token should be valid.
Select Generate Token.
Copy the token to the clipboard.
Select Close.

Deployment steps

Sign in to your AWS account, and launch this Partner Solution, as described under Deployment options. The AWS CloudFormation console opens with a prepopulated template.
Choose the correct AWS Region, and then choose Next.
On the Create stack page, keep the default setting for the template URL, and then choose Next.

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. When you finish reviewing and customizing the parameters, choose Next.

Unless you’re customizing the Partner Solution templates or are instructed otherwise in this guide’s Predeployment section, don’t change the default settings for the following parameters: QSS3BucketName, QSS3BucketRegion, and QSS3KeyPrefix. Changing the values of these parameters will modify code references that point to the Amazon Simple Storage Service (Amazon S3) bucket name and key prefix. For more information, refer to the AWS Partner Solutions Contributor’s Guide.

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 all of the check boxes to acknowledge that the template creates AWS Identity and Access Management (IAM) resources that might require the ability to automatically expand macros.
Choose Create stack. The stack takes about 30 minutes to deploy.
Monitor the stack’s status, and when the status is CREATE_COMPLETE, the Boomi Atom deployment is ready.
To view the created resources, choose the Outputs tab.

Postdeployment steps

Test the deployment

To verify the deployment of the Atom in your Boomi account, first log in to AtomSphere. On the Manage menu, select Atom Management. The new Atom deployed by this Partner Solution is displayed under Unattached Atoms.

Boomi AtomSphere dashboard

Best practices for using Boomi Atom on AWS

The Atom that is deployed by this Partner Solution can be managed from the Boomi AtomSphere dashboard. From the AtomSphere dashboard, you can attach the Atom to environments and deploy processes to it.

In Figure 2, the Atom server is identified by the Domain Name System (DNS) name ip-172-30-7.186.ec2.internal. The account contains environments, one labeled Production and the other labeled Test.

Figure 2. Boomi AtomSphere dashboard with an unattached AWS-managed Atom server

Security

This Partner Solution deploys a bastion host and a Boomi Atom server into an AWS VPC. The bastion host is the only means of accessing the Atom at a command-line level. The Atom is deployed into a private subnet and cannot be reached through the internet. It communicates through a NAT gateway for updates and patches.

Performance Monitoring

Monitoring the CPU, network, and Amazon Elastic Block Store (Amazon EBS) performance of your Atom is done using CloudWatch metrics.

CPU and network performance is measured in utilization, network in and out, network packets in and out, and system status checks.

Amazon EBS volume performance is measured in read and write throughput, average read and write size, read and write bandwidth, read and write latency, and volume idle time.

Further monitoring of disk space and inode consumption must be performed at the command line level of the EC2 instance using the df -h and df -i Linux commands.

Troubleshooting

For troubleshooting common Partner Solution issues, refer to the AWS Partner Solution General Information Guide and Troubleshooting CloudFormation.

Customer responsibility

After you deploy a Partner Solution, confirm that your resources and services are updated and configured—including any required patches—to meet your security and other needs. For more information, refer to the Shared Responsibility Model.

Feedback

To submit feature ideas and report bugs, use the Issues section of the GitHub repository for this Partner Solution. To submit code, refer to the Partner Solution Contributor’s Guide. To submit feedback on this deployment guide, use the following GitHub links:

Notices

This document is provided for informational purposes only. It represents current AWS 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 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 https://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. Refer to the License for specific language governing permissions and limitations.