Boomi Kubernetes Molecule on the AWS Cloud

Quick Start Reference Deployment

QS

November 2020
Vilvamani Arumugam, AWS Cloud Evangelist, Accenture Solution Pvt Ltd
Andrew Glenn, AWS Global Partner Solutions Architect

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 Boomi 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 Boomi Kubernetes Molecule on the AWS Cloud.

This Quick Start is for users who are looking for an integration platform as a service (iPaaS) that can be hosted on AWS. This Quick Start enables you to deploy a Boomi Molecule cluster on AWS and administer it through the Boomi AtomSphere platform.

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

Boomi Kubernetes Molecule on AWS

Boomi service is a minimal-code, cloud-based iPaaS that enables customers to design, deploy, manage, and govern all of their data across their hybrid and software as a service (SaaS) applications by connecting and integrating external application data with AWS services such as Amazon Simple Storage Service (Amazon S3), Amazon Simple Notification Service (Amazon SNS), Amazon Relational Database Service (Amazon RDS), and Amazon Redshift using Boomi’s point-and-click graphical interface.

The Boomi Molecule is a single-tenant, clustered runtime that runs separately from the platform, enabling multiple processes to run concurrently. The enterprise-grade version of a Boomi Atom runtime, the Boomi Molecule can be deployed across multiple servers to enhance load balancing and ensure high availability for mission-critical integration processes. Specifically, the Boomi Kubernetes Molecule on AWS leverages Amazon EKS to facilitate the orchestrated addition and removal of nodes as dictated by resource demands. This allows the Molecule to elastically add nodes to meet high-volume use-case demands and remove those nodes when no longer required to support operational efficiency and cost-savings efforts.

Cost

You are responsible for the cost of the AWS services 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 deployment requires a Boomi Molecule Enterprise license.

Architecture

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

image
Figure 1. Quick Start architecture for Boomi Kubernetes Molecule on AWS

The Quick Start sets up the following:

  • A highly available architecture that spans three 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.*

  • A Network Load Balancer.

  • In the public subnets:

    • Managed 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 Amazon Elastic Compute Cloud (Amazon EC2) instances in public and private subnets, with Amazon CloudWatch for monitoring.

  • In the private subnets:

    • Amazon EKS cluster with the Boomi software installed, one pod in each Availability Zone.

    • Amazon Elastic File System (Amazon EFS) deployed in the Region. Three Amazon EFS mount points are created also, one in each Availability Zone.

*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 guide requires a moderate level of familiarity with AWS services. If you’re new to AWS, visit the Getting Started Resource Center and the AWS Training and Certification website. 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 Amazon EKS, AWS CloudFormation, and Kubernetes.

This Quick Start follows the patterns for Unattended Boomi Molecule deployments found in the Boomi documentation. 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, your account must be configured as specified in the following table. 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

VPCs

1

Availability Zone

3

Public Subnet

3

Private Subnet

3

Internet Gateway

1

NAT Gateway

3

Elastic IP addresses

4

Auto Scaling groups

4

EKS Cluster

1

EKS Managed Node Group

3

Application/Network Load Balancers

1

t2.micro instances

1

t3.medium instances

3

EFS file systems

1

EFS mount targets

3

AWS Key Management Service (KMS) encryption keys

1

Secure Sockets Layer (SSL) certificates

1

Supported Regions

The following Regions are currently supported by this Boomi EKS Molecule Quick Start.

  • us-east-1 (N. Virginia)

  • us-east-2 (Ohio)

  • us-west-1 (N. California)

  • us-west-2 (Oregon)

  • ca-central-1 (Canada Central)

  • eu-central-1 (Frankfurt)

  • eu-west-1 (Ireland)

  • eu-west-2 (London)

  • eu-west-3 (Paris)

  • eu-north-1 (Stockholm)

  • eu-south-1 (Milan)

  • me-south-1 (Bahrain)

  • ap-east-1 (Hong Kong)

  • ap-southeast-1 (Singapore)

  • ap-southeast-2 (Sydney)

  • ap-south-1 (Mumbai)

  • ap-northeast-1 (Tokyo)

  • ap-northeast-2 (Seoul)

  • sa-east-1 (South America)

  • af-south-1 (Cape Town)

Certain Regions are available on an opt-in basis. 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.

Prepare your Boomi account

Ensure your Boomi account has at least one available Enterprise Molecule license. Ensure you have a valid Account ID and Username/Password.

Deployment options

This Quick Start provides two deployment options:

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

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

Authentication

In addition to the two deployment options, there is one authentication option for deployment.

  • Deploy with authorized Account ID, Username, and Password (Not MFA compatible)

You will need to choose one method or the other. If you are unsure of how to create an Installation Token or API Token/Key, see Creating an Installation Token in this guide for steps or contact your administrator.

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 Boomi Kubernetes Molecule into a new VPC on AWS

Deploy Boomi Kubernetes Molecule into an existing VPC on AWS

If you’re deploying Boomi Kubernetes Molecule 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 DHCP options sets. You provide your VPC settings when you launch the Quick Start.

Each deployment takes about 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 Boomi Kubernetes Molecule 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.

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, 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 Existing VPC

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

VPC ID (VPCID)

Requires input

The ID of your existing VPC (e.g., vpc-0343606e).

Private subnet 1 ID (PrivateSubnet1ID)

Requires input

The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-fe9a8b32).

Private subnet 2 ID (PrivateSubnet2ID)

Requires input

The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-be8b01ea).

Private subnet 3 ID (PrivateSubnet3ID)

Requires input

The ID of the private subnet in Availability Zone 3 in your existing VPC (e.g., subnet-abd39039).

Public subnet 1 ID (PublicSubnet1ID)

Requires input

The ID of the public subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).

Public subnet 2 ID (PublicSubnet2ID)

Requires input

The ID of the public subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b1236eea).

Public subnet 3 ID (PublicSubnet3ID)

Requires input

The ID of the public subnet in Availability Zone 3 in your existing VPC (e.g., subnet-c3456aba).

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

Key pair name (KeyPairName)

Requires input

Key name for access to EC2 instances.

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

Workload namespace (WorkloadNamespace)

eks-boomi-molecule

The Kubernetes namespace to use when provisioning the workload.

Nodes instance type (NodeInstanceType)

t3.xlarge

The type of EC2 instance for the node instances.

Number of nodes (NumberOfNodes)

1

The number of Amazon EKS node instances. The default is one for each of the three Availability Zones.

Load balancer type (LoadBalancerType)

ALB

EKS Service Load Balancer Type.

Table 4. Boomi Molecule configuration
Parameter label (name) Default value Description

Boomi account ID (BoomiAccountID)

Requires input

The Boomi account ID that you want to associate with the new Molecule cluster.

Boomi user name (BoomiUsername)

Requires input

The email account associated with the Boomi account.

Boomi password (BoomiPassword)

Blank string

The password associated with the Boomi account.

Boomi MFA install token (BoomiMFAInstallToken)

Blank string

An MFA installation token generated by your Dell Boomi Administrator.

Boomi MFA API token (BoomiMFAAPIToken)

Blank string

An MFA API token generated by your Dell Boomi Administrator.

Molecule cluster name (MoleculeClusterName)

Boomi-Molecule-EKS

The name for the Boomi Molecule cluster.

NO_LABEL (EFSProvisionedThroughputInMibps)

10

The provisioned throughput value for the EFS volume.

Table 5. DNS or SSL configuration
Parameter label (name) Default value Description

Molecule FQDN (MoleculeFQDN)

Blank string

The fully qualified domain name for the Boomi Molecule cluster. Use with 'HostedZoneID' if you are not using SSL..

Route 53 hosted zone ID (HostedZoneID)

Blank string

Route 53 Hosted Zone ID of the domain name. Used in conjunction with a 'MoleculeFQDN'.

SSL certificate ARN (SSLCertificateArn)

Blank string

The ARN of the SSL certificate to use for the load balancer. Use 'SSLCertificateArn' if you are not using 'MoleculeFQDN' and 'HostedZoneID'.

Table 6. 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-eks-boomi-molecule/

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

Per account shared resources (PerAccountSharedResources)

AutoDetect

Choose "No" if you already deployed another EKS Quick Start stack in your AWS account.

Per region shared resources (PerRegionSharedResources)

AutoDetect

Choose "No" if you already deployed another EKS Quick Start stack in your Region.

Launch into a new VPC

Table 7. 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. This deployment uses two Availability Zones, and the logical order of your selections is preserved.

VPC CIDR (VPCCIDR)

10.0.0.0/16

The CIDR block for the VPC.

Public subnet 1 CIDR (PublicSubnet1CIDR)

10.0.128.0/20

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

Public subnet 2 CIDR (PublicSubnet2CIDR)

10.0.144.0/20

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

Public subnet 3 CIDR (PublicSubnet3CIDR)

10.0.160.0/20

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

Private subnet 1 CIDR (PrivateSubnet1CIDR)

10.0.0.0/19

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

Private subnet 2 CIDR (PrivateSubnet2CIDR)

10.0.32.0/19

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

Private subnet 3 CIDR (PrivateSubnet3CIDR)

10.0.64.0/19

The CIDR block for private subnet 3 located in Availability Zone 3

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 8. Amazon EC2 configuration
Parameter label (name) Default value Description

SSH key name (KeyPairName)

Requires input

A public/private key pair, which allows you to connect securely to your instance after it launches.

Table 9. Amazon EKS configuration
Parameter label (name) Default value Description

NO_LABEL (WorkloadNamespace)

eks-boomi-molecule

The Kubernetes namespace to use when provisioning the workload.

Node instance type (NodeInstanceType)

t3.xlarge

EKS node instance type

Load balancer type (LoadBalancerType)

ALB

EKS Service Load Balancer Type.

Number of nodes (NumberOfNodes)

1

The number of Amazon EKS node instances. The default is one for each of the three Availability Zones.

Table 10. Boomi Molecule configuration
Parameter label (name) Default value Description

Boomi account ID (BoomiAccountID)

Requires input

The Boomi account ID that you want to associate with the new Molecule cluster.

Boomi user name (BoomiUsername)

Requires input

The email account associated with the Boomi account.

Boomi password (BoomiPassword)

Blank string

The password associated with the Boomi account.

Boomi MFA install token (BoomiMFAInstallToken)

Blank string

An MFA installation token generated by your Dell Boomi Administrator.

Boomi MFA API token (BoomiMFAAPIToken)

Blank string

An MFA API token generated by your Dell Boomi Administrator.

Molecule cluster name (MoleculeClusterName)

Boomi-Molecule-EKS

The name for the Boomi Molecule cluster.

NO_LABEL (EFSProvisionedThroughputInMibps)

10

The provisioned throughput value for the EFS volume.

Table 11. DNS or SSL configuration
Parameter label (name) Default value Description

Molecule FQDN (MoleculeFQDN)

Blank string

The fully qualified domain name for the Boomi Molecule cluster. Use with 'HostedZoneID' if you are not using SSL.

Route 53 hosted zone ID (HostedZoneID)

Blank string

Route 53 Hosted Zone ID of the domain name. Used in conjunction with a 'MoleculeFQDN'.

SSL certificate ARN (SSLCertificateArn)

Blank string

The ARN of the SSL certificate to use for the load balancer. Use 'SSLCertificateArn' if you are not using 'MoleculeFQDN' and 'HostedZoneID'.

Table 12. 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-eks-boomi-molecule/

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

Per account shared resources (PerAccountSharedResources)

AutoDetect

Choose "No" if you already deployed another EKS Quick Start stack in your AWS account.

Per region shared resources (PerRegionSharedResources)

AutoDetect

Choose "No" if you already deployed another EKS Quick Start stack in your Region.

  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 Boomi Kubernetes Molecule deployment is ready.

  5. Use the values displayed in the Outputs tab for the stack, as shown in Boomi Kubernetes Molecule outputs after successful deployment, to view the created resources.

cfn_outputs
Figure 2. Boomi Kubernetes Molecule outputs after successful deployment

Test the deployment

To view the Molecule in the Boomi AtomSphere platform, log in to your Boomi account, navigate to the Manage drop-down menu, and choose Atom Management. The newly created Amazon Molecule EKS cluster will be displayed.

image
Figure 3. Boomi Dashboard with an unattached AWS-managed Molecule Cluster

You can then attach the Molecules to any environment you have staged and deploy workloads to that Molecule cluster. By Default the molecule you deployed will be under ‘Unattached Atoms’. When you click on ‘Atom Information’ you will see an option to attach it to an environment.

Security

This Quick Start deploys a bastion host and a Boomi Molecule EKS cluster into an AWS VPC. The bastion host is the only means of accessing the Boomi Molecule EKS cluster at a command-line level. The Boomi Molecule EKS cluster is deployed into private subnets and cannot be reached through the internet. The Boomi Molecule EKS cluster communicates through a NAT Gateway for updates and patches, and it communicates through the public-facing Application Load Balancer or Network Load Balancer to communicate with the Boomi AtomSphere platform.

Other useful information

Performance monitoring

Monitoring the CPU, network, and Amazon Elastic Block Store (Amazon EBS) performance of your AWS Boomi Molecule EKS cluster is done through CloudWatch metrics.

CPU and network performance are 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.

Amazon EFS reports metrics to CloudWatch and can be monitored there. Metrics include client connections, data read and data write bytes, and IO percent limits.

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. (For Windows, look at the log files in %ProgramFiles%\Amazon\EC2ConfigService and C:\cfn\log.)

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.

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.