K3 Documents

Step By Step Instructions for Launching K3 Cloud

Updated on

Overview

K3 Cloud is an ETL tool that can help you easily connect two data sources and specify the transformations in an easy to use intuitive interface.

You can get a 14-day trial version of K3Cloud from the AWS marketplace.  The following instructions describe how to install and try K3Cloud. After the 14-day trial period you will be automatically charged the monthly subscription fee.

Search & Subscribe

To launch K3 Cloud go to AWS marketplace https://aws.amazon.com/marketplace and search for K3Cloud. On the search results page select K3Cloud and then click the Continue to Subscribe button


On the subscription page, click the Continue to Configuration Button

Once you click the Subscribe button you will be taken to the Contract Screen. There is nothing to change on the Contract Screen, click the Continue to Configuration button.

Once you have clicked the Subscribe button you will be asked to accept the terms of service. There is a link to review the K3Cloud End User License Agreement (EULA) if you desire. If you are happy with the EULA and the AWS terms of service click the Accept Terms button.

Configuration

On the configuration page select the following values for the drop downs

  • Fulfillment Option
    • Amazon Machine Image
    • 64-bit Amazon Machine Image (AMI)
  • Software version: 7.4
  • Region: Choose the available regions that best suit your needs

Click the Continue to Launch button that will take you to the next screen that will prompt you to choose an action.

Launch Method

In the dropdown select Launch through EC2 option.

Instance Type

The instance type that you choose will impact the throughput of your integrations. In general we recommend instance size of t2.large,  t3.large, m2.large or m3.large. If you need to run a lot of integrations in parallel, then you can opt for larger instance sizes.

After selecting the appropriate instance size, click Next: Configure Instance Details  button. 

NOTE: Do not click Review and Launch button as there are more configuration items on subsequent screens that are required for proper functioning of the AMI.

Configure Instance Details

To be able to access K3Cloud through the web client, you need to ensure that the AMI is either reachable via the public internet or you have VPN infrastructure in place to connect to your private network on AWS. This page allows you to configure various networking related aspects. Specify the following properties and leave everything else to its default value.

  • Network - Choose any existing VPC, preferably that has a subnet in the availability zone of your snowflake or redshift cluster. You can also create a new VPC if you want to isolate the AMI from rest of your applications.
  • Subnet - For best performance, choose a subnet that is in the same availability zone as your Redshift or Snowflake cluster. You can also create a new subnet if needed.
  • Auto-assign public IP -  Leave it unchanged only when it says Use subnet setting (Enable). If the subnet setting is disabled then either choose a different subnet that has it enabled or explicitly choose Enabled. Only use a subnet with disabled setting when you have networking setup in place that allows you to connect to your instance on private IP.
  • Enable termination protection - Checked
  • Monitoring - Setting it to Enabled is recommended


After this click the Next: Add Storage button.

NOTE: Do not click Review and Launch button as there are more configuration items on subsequent screens that are required for proper functioning of the AMI.

Add Storage

We highly recommend that you set this the size of Root volume to 50GB or higher. This will give you enough room for running several batches of data.

After specifying the disk size, click Next: Add Tags button

NOTE: Do not click Review and Launch button as there are more configuration items on subsequent screens that are required for proper functioning of the AMI.

Add Tags

There is no requirement from K3Cloud perspective to add any specific tag. Specify any tags that you want that would help  you manage your instances. We recommend adding the Name tag to help in locating the instance on AWS console.

After this click Next: Configure Security Group button.

NOTE: Do not click Review and Launch button as there are more configuration items on subsequent screens that are required for proper functioning of the AMI.

Configure Security Groups

Security group allow certain kind of network traffic into your AMI. In this step create a new security group that allows SSH and HTTPS traffic. SSH access is required for any support request and HTTPS access is required by the web client to communicate with the K3Cloud server.

In the source field dropdown select

  • MyIP - if you want only your IP to be able to access this AMI. This is the most restrictive but also the most secure.
  • Anywhere - If you want the AMI to be accessible from any machine. This is the least restrictive and also least secure
  • Custom - you can specify a CIDR block and IP or another security group


Choose the option best suited to your needs and then click Review and Launch button.

Review Instance Launch

Review all the information on this page to ensure everything has been filled correctly. If you spot a mistake then click the edit link and fix it. Once you have reviewed that everything is correct, then click the Launch button at the bottom of the page.

A dialog box will pop up asking you for a key pair. If you already have one, then choose an existing key pair, otherwise select Create a new key pair option. Give a name to this new key pair and then click the Download Key Pair. Save the downloaded .pem file safely as it would be needed for accessing the machine over SSH in case there is a support issue.


Finally click the Launch Instances button to launch K3Cloud. 

Login to K3Cloud

Once the EC2 instance is fully launched, copy the public IP address of the AMI and then navigate to this url on your web browser

https://<IP of your AMI>

You will be presented with a warning about the SSL certificate. The reason for this warning is that a self-signed certificate is being used by the application. While it is not completely secure, it is still much better than plain unencrypted connections.

Click on Advanced button and then click the Proceed to <IP of AMI> link. 

You should now see the login page for K3Cloud. The username is admin and the password is the instance id of your AMI. 

To find the instance id, go to the EC2 section of AWS console and locate the machine running K3Cloud using the name you specified in the Configure step.

Refer to the K3 user guide on how to use K3Cloud for creating data integration flows.