Dell Boomi Atom on the AWS Cloud

Quick Start Reference Deployment

QS

March 2021
Andrew Glenn, 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 Dell Inc. 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 walks you through the steps for deploying Dell Boomi Atom on the AWS Cloud. It does not require deep knowledge of AWS or Linux system administration.

This Quick Start 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 Dell Boomi Atom on AWS and administer it through the Dell Boomi Atom AtomSphere platform.

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

Dell Boomi Atom on AWS

Dell Boomi Atom is a a low-code iPaaS with pre-built connectors to integrate cloud and legacy data and applications. With Boomi integration, you can adopt AWS services quickly while continuing to operate in an environment that includes on-premises data.

AWS costs

You are responsible for the cost of the AWS services and any paid 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 Dell Boomi account. The Dell Boomi account you use to deploy this Quick Start will determine the licensing model that applies. Licensing costs are managed by Dell Boomi, and Dell Boomi applies standard connector metering charges to workloads using a Dell Boomi account. However, you can also use this Quick Start to deploy a Dell Boomi Atom server that will run trial or training workloads.

Architecture

Deploying this Quick Start into a new virtual private cloud (VPC) with default parameters builds the following Dell Boomi Atom environment in the AWS Cloud.

Architecture
Figure 1. Quick Start architecture for Dell Boomi Atom on AWS

As shown in Figure 1, 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:

    • 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, Dell 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 the Quick Start 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 Quick Start 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.

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 basic concepts of networking, bastion hosts, volume sizing, and compute performance. It also assumes familiarity with the Dell Boomi variables that are required when deploying an Atom server. These variables include Atom Name, Local Path, Local Temp Path, Account ID, Account Name, and Account Password. This Quick Start follows the patterns for unattended Dell Boomi Atom deployments. For more information, see Unattended installation of an Atom, Molecule, or Atom Cloud.

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

2

AWS Identity and Access Management (IAM) security groups

0

IAM roles

0

Auto Scaling groups

0

Application Load Balancers

0

Classic Load Balancers

0

t2.micro instances

1

m5.xlarge instances

1

Supported Regions

This deployment can be deployed in all AWS Regions. For a current list of supported Regions, see AWS service endpoints.

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 a Dell Boomi account. Also, to install Boomi Atom locally, you must have the following:

  • Dell 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).

For more information, see Generating a Boomi installer token, later in this guide.

Deployment options

This Quick Start provides two deployment options:

  • Deploy Dell Boomi Atom 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 Dell Boomi Atom into this new VPC.

  • Deploy Dell Boomi Atom into an existing VPC. This option provisions Dell Boomi Atom 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 Dell Boomi Atom settings, as discussed later in this guide.

When deploying this Quick Start, you can specify an AtomSphere username and password or a valid Boomi installer token, depending on how you want to authenticate the Atom. For instructions on generating a Boomi installer token, see Generating a Boomi installer token, later in this guide.

Deployment steps

Sign in to your AWS account

  1. Sign in to your AWS account 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 Dell Boomi Atom into a new VPC on AWS

View template

Deploy Dell Boomi Atom into an existing VPC on AWS

View template

If you’re deploying Dell Boomi Atom 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, ensure that the domain name option in the Dynamic Host Configuration Protocol (DHCP) options is configured as explained in DHCP options sets. You provide your VPC settings when you launch the Quick Start.

Each deployment takes about 30 minutes–1 hour 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 Dell Boomi Atom 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. For details on each parameter, see the Parameter reference section of this guide.

  1. 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.

  2. 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.

  3. Choose Create stack to deploy the stack.

  4. Monitor the status of the stack. When the status is CREATE_COMPLETE, the Dell Boomi Atom deployment is ready.

  5. Use the values displayed in the Outputs tab for the stack, as shown in Figure 2, to view the created resources.

cfn_outputs
Figure 2. Dell Boomi Atom outputs after successful deployment

Test the deployment

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

unattached-atom
Figure 3. Dell Boomi AtomSphere dashboard

Best practices for using Dell Boomi Atom on AWS

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

In Figure 4, 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.

deployed-atom
Figure 4. Boomi AtomSphere dashboard with an unattached AWS-managed Atom server

Security

This Quick Start deploys a bastion host and a Dell 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.

Generating a Boomi installer token

When deploying this Quick Start, you can specify a Dell 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:

  1. Log in to Dell Boomi AtomSphere.

  2. Select Build.

  3. On the Welcome tab, select Atom under Atom Runtime.

  4. In the Atom Setup window, select Security Options.

  5. From the Token Valid For dropdown list, select the length of time for which the token should be valid.

  6. Select Generate Token.

  7. Copy the token to the clipboard.

  8. Select Close.

FAQ

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 Configure stack options page. With this setting, the stack’s state is retained, and you can troubleshoot the issue.

When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Make sure that you delete stack after troubleshooting.

For more information, see Troubleshooting AWS CloudFormation.

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, see AWS CloudFormation quotas.

Parameter reference

Unless you are customizing the Quick Start templates for your own deployment projects, we recommend that you keep the default settings for the parameters labeled Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. Changing these parameter 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

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

Availability Zones (AvailabilityZones)

Requires input

Select two Availability Zones for VPC subnets. The logical order of your selections is preserved in the deployment.

VPC CIDR (VPCCIDR)

10.0.0.0/16

CIDR block for the VPC.

Public subnet 1 CIDR (PublicSubnet1CIDR)

10.0.32.0/24

CIDR block for the public subnet, located in Availability Zone 1.

Public subnet 2 CIDR (PublicSubnet2CIDR)

10.0.64.0/24

CIDR block for the public subnet, located in Availability Zone 2.

Private subnet 1 CIDR (PrivateSubnet1CIDR)

10.0.128.0/24

CIDR block for the private subnet, located in Availability Zone 1.

Private subnet 2 CIDR (PrivateSubnet2CIDR)

10.0.192.0/24

CIDR block for the private subnet, located in Availability Zone 2.

Allowed external access CIDR (RemoteAccessCIDR)

Requires input

The CIDR IP range that is permitted to access the instances. We recommend that you set this value to a trusted IP range.

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

Boomi Atom instance type (InstanceType)

m5.xlarge

Boomi host instance type.

SSH key name (KeyPairName)

Requires input

Name of the key pair that allows you to connect securely to your instance after it launches.

Amazon EBS volume size of Boomi Atom (BoomiInstanceVolumeSize)

100

Size of the Amazon EBS volume attached to the Atom instance. Size range is 1GiB–16TiB.

Table 3. Dell Boomi Atom configuration
Parameter label (name) Default value Description

Atom name (AtomName)

atom1

Boomi Atom instance name.

Boomi account ID (BoomiAccountID)

Requires input

ID of the Dell Boomi account to associate with the new Atom.

Boomi user name (BoomiUsername)

Requires input

Boomi account username. Not required if using a Boomi installation token.

Boomi password (BoomiPassword)

Requires input

Boomi account password. Not required if using a Boomi installation token.

Boomi install directory (BoomiInstallDir)

/opt/boomi/

Boomi installation directory.

Boomi installation token (BoomiInstallToken)

Blank string

Boomi installation token.

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

Quick Start S3 bucket name (QSS3BucketName)

aws-quickstart

Name of the S3 bucket for your copy of the Quick Start assets. Keep the default name unless you are customizing the template. Changing the name updates code references to point to a new Quick Start location. This name can include numbers, lowercase letters, uppercase letters, and hyphens, but do not start or end with a hyphen (-). See https://aws-quickstart.github.io/option1.html.

Quick Start S3 bucket Region (QSS3BucketRegion)

us-east-1

AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. Keep the default Region unless you are customizing the template. Changing this Region updates code references to point to a new Quick Start location. When using your own bucket, specify the Region. See https://aws-quickstart.github.io/option1.html.

Quick Start S3 key prefix (QSS3KeyPrefix)

quickstart-*/

S3 key prefix that is used to simulate a directory for your copy of the Quick Start assets. Keep the default prefix unless you are customizing the template. Changing this prefix updates code references to point to a new Quick Start location. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). End with a forward slash. See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html and https://aws-quickstart.github.io/option1.html.

Launch into an existing VPC

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

VPC ID (VPCID)

Requires input

VPC to deploy into.

Private subnet ID (PrivateSubnet1ID)

Requires input

ID of the private subnet, in Availability Zone 1 in your existing VPC.

NO_LABEL (BastionSecurityGroupID)

Requires input

NO_DESCRIPTION

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

Boomi Atom instance type (InstanceType)

m5.xlarge

Boomi host instance type.

SSH key name (KeyPairName)

Requires input

Key pair that allows you to connect securely to your instance after it launches.

Amazon EBS volume size for Boomi Atom instance (BoomiInstanceVolumeSize)

100

Size of the Amazon EBS volume attached to the Atom instance. Size range is 1GiB–16TiB.

Table 7. Dell Boomi Atom configuration
Parameter label (name) Default value Description

Atom name (AtomName)

atom1

Boomi Atom instance name.

Boomi account ID (BoomiAccountID)

Requires input

Boomi account ID to associate with the new Atom.

Boomi username (BoomiUsername)

Requires input

Boomi account username. (Not required if using a Boomi installation token.)

Boomi password (BoomiPassword)

Requires input

Boomi account password. (Not required if using a Boomi installation token.)

Boomi installation token (BoomiInstallToken)

Blank string

Boomi installation token.

Boomi install directory (BoomiInstallDir)

/opt/boomi/

Boomi installation directory.

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.