Skip to content

Home

Introduction

Development

Overview

IDEs

Services

Service manager

API Explorer

Deploying your instance on AWS with CloudFormation

Using the template

To use the AWS CloudFormation template to deploy TORO Integrate, you must:

Permissions and resources

The user performing the steps below will need to have permission to provision instances, spanning multiple types of AWS resources.

AWS free tier

By default, all instances are micro-instances which means you can deploy it for free provided that your account is eligible for the AWS free tier program. The default instance size can be changed during deployment.

  1. Download the template.
  2. Proceed to CloudFormation by choosing CloudFormation from the list of Amazon Web Services. You can also click the drop-down menu located at the upper left corner, and choose CloudFormation.

    Navigating to AWS CloudFormation

  3. Click the Create new stack button.

    Creating a new stack

    Choose the correct AWS Region

    For this deployment, we will select the North Virginia (us-east-1) region. Ensure you select the right region. You can check your region by looking at the upper right menu.

    List of AWS Regions

  4. Upload the template to Amazon S3, then browse and select the template downloaded earlier.

    Choosing the template

  5. Input your custom data.

    Entering custom data for template

    The parameters you can enter for this step are described below:

    Parameter Purpose
    Stack name Choose a name for your infrastructure.
    AllowCidrBlock (Optional) Enter a CIDR block to allow access to your network e.g. 0.0.0.0/0.
    DBAllocatedStorage Determine the size of the database (in GB).
    DBInstanceClass Specify the database instance type.
    DbMasterPassword Configure a database master password.
    DbMasterUser Configure a database master username. It is not recommended to use root.
    Email Specify the email address to notify when a CloudWatch metric has triggered an alarm.
    MultiAZ Choose whether you would like a Multi-AZ master database which automatically creates a primary DB instance and synchronously replicates the data to a standby instance in a different Availability Zone (AZ).
    OrganizationName Specify the name of your organisation/company.
    ParentDomain Enter the DNS name of an existing Amazon Route 53 hosted zone.
    SslCertificateName Identify the name of an SSL certificate uploaded in AWS Certificate Manager that you want to use for TORO Integrate.
    T1BCidrBlock Enter CIDR block for Tier 1 - Zone B subnet.
    T1CCidrBlock Enter CIDR block for Tier 1 - Zone C subnet.
    T1WebEc2Type Specify WebServer EC2 instance type.
    T2ActivemqEc2Type Specify ActiveMQ EC2 instance type.
    T2BCidrBlock Enter CIDR block for Tier 2 - Zone B subnet.
    T2CCidrBlock Enter CIDR block for Tier 2 - Zone C subnet.
    T2EcsEc2Type Specify ECS cluster EC2 types. They will run the Docker containers of TORO Integrate.
    T2SolrEc2Type Specify SolrCloud EC2 instance type.
    T2ZookeeperEc2Type Specify ZooKeeper EC2 instance type.
    T3BCidrBlock Enter CIDR block for Tier 3 - Zone B subnet.
    T3CCidrBlock Enter CIDR block for Tier 3 - Zone C subnet.
    VPCSubnetCidrBlock Enter VPC CIDR block. (i.e. 10.0.0.0/16).
  6. (Optional) Add tags and permissions.

    Adding tags

  7. Review your details and if satisfied, create your stack by clicking the Create button at the bottom of the page.

    Review and create Cloudformation stack information

And that's it! You're done. You’ll see your stack in the dashboard that it is being created. You can also monitor the deployment process of the CloudFormation template in the Events tab.

Creating a DNS record

Instead of using the IP address generated by AWS to access your TORO Integrate instance, you can use your own domain name. In this section, we'll be showing you how to do this via creating an A record in AWS Route 53. Route 53 is a service available on AWS that is used to manage the Domain Name Service (DNS) of web services to direct users to web applications by translating domain names into numeric IP addresses.

Creating a hosted zone

  1. Proceed to Route 53 by clicking Route 53 under the Networking & Content Delivery category. You'll be able to view the list of AWS services in the AWS Management Console home or via the Services drop-down at the static, navigation bar at the top.

    Navigating to AWS Route 53

  2. Select Hosted Zones from the left menu bar.

  3. Choose Create Hosted Zone at the top portion of the screen.
  4. A form will appear on the left side of the screen. Fill in the details.

    Field hints

    If you don't know what a field is for, you can easily hover over the field to see a short description about it.

    Hovering over fields to show hints

  5. Once done, click the Create button.

    Creating a hosted zone

Hosted zone type

The accessibility of your domain will depend on your network and the type of hosted zone you have selected upon creation (either Public Hosted Zone or Private Hosted Zone for Amazon VPC).

Creating a record set

  1. Select your domain and click Go to Record Sets.

    Viewing record sets of a hosted zone

  2. Next, a button labeled Create Record Set should be visible; click it.

    Creating a record set

  3. Fields to fill in the information for your record set will pop up on the right side of the screen. Modify the Value field so that it contains the NGINX instance’s IP address.

    Record set form

  4. Once done, click Save Record Set.

And that's it. Open your web browser and enter the domain name on the address bar to verify your changes. It's also possible to tweak the default CloudFormation template deployed over AWS to suit your organization's design needs.