MuleSoft Anypoint Runtime Fabric on AWS

Partner Solution Deployment Guide

QS

September 2022
Sandeep Deshmukh, Sparsh Agarwal, and Digvijay Kulkarni, MuleSoft
Kranthi Pullagurla, AWS Strategic ISVs
Dave May, AWS Integration and Automation

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 MuleSoft 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 guide covers the steps necessary to deploy MuleSoft Anypoint Runtime Fabric on an Amazon Elastic Kubernetes Service (Amazon EKS) cluster that you create, configure, and manage.

Costs and licenses

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

To use Runtime Fabric, you must acquire and install a product license. To acquire a license, contact your account representative or the MuleSoft sales team.

Architecture

Deploying this Quick Start with default parameters builds the following Runtime Fabric environment in the AWS Cloud.

Architecture
Figure 1. Quick Start architecture for Runtime Fabric on AWS

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

  • A highly available architecture that spans three Availability Zones.*

  • A virtual private cloud (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:

    • Managed network address translation (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.*

  • In the private subnets, Kubernetes nodes running Runtime Fabric services in an Auto Scaling group.

  • An Application Load Balancer (not shown) to route traffic to the Mule API instances in the private subnets.

  • Amazon EKS, which provides the Kubernetes control plane for the cluster.

  • AWS Systems Manager to manage Mule deployments automatically.

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

Deployment options

This Quick Start provides the following deployment options:

This Quick Start uses the same template for all three options. The first two options launch the Amazon EKS Quick Start with the MuleSoftRtfIntegration parameter set to Enabled. Then, after the new EKS cluster is deployed, the Runtime Fabric Quick Start is deployed as a submodule.

For all three options, you can configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and Runtime Fabric settings.

Deployment steps

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

  2. Choose the correct AWS Region, and then choose Next.

  3. On the Create stack page, keep the default setting for the template URL, and then choose Next.

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

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

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

  7. Choose Create stack. The stack takes about 15 minutes to deploy.

  8. Monitor the stack’s status, and when the status is CREATE_COMPLETE, the MuleSoft Anypoint Runtime Fabric deployment is ready.

  9. To view the created resources, choose the Outputs tab.

Postdeployment steps

Associate your environment with MuleSoft Runtime Fabric

  1. Log in to the MuleSoft Anypoint control plane, and navigate to Runtime Manager.

  2. From Runtime Manager, select the Amazon EKS cluster that you created.

  3. Choose the Associated Environments tab.

  4. Add the appropriate business group, and choose the environment to add to Runtime Fabric.

  5. Choose Apply Allocation.

Deploy and test your Mule application

For details on deploying and testing your Mule application, refer to Deploy a Mule Application to Runtime Fabric.

Troubleshooting

For troubleshooting common Quick Start issues, refer to the AWS Quick Start 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.