Wallaroo Community AWS EC2 Setup Instructions

How to set up your Wallaroo Community Edition AWS Environment with EC2

Setup AWS EC2 Environment for Wallaroo

The following instructions are made to assist users set up their Amazon Web Services (AWS) environment for running Wallaroo using AWS virtual servers with EC2. This allows organizations to stand a single virtual machine and used a pre-made Amazon Machine Images (AMIs) to quickly stand up an environment that can be used to install Wallaroo.

AWS Prerequisites

To install Wallaroo in your AWS environment based on these instructions, the following prerequisites must be met:

  • Register an AWS account: https://aws.amazon.com/ and assign the proper permissions according to your organization’s needs. This must be a paid AWS account - Wallaroo will not operate on the free tier level of virtual machines.

Steps

Create the EC2 VM

To create your Wallaroo instance using a pre-made AMI:

  1. Log into AWS cloud console.

  2. Set the region to N. Virginia. Other regions will be added over time.

    Set the region
  3. Select Services -> EC2.

    Select EC2
  4. Select Instances, then from the upper right hand section Launch Instances->Launch Instances.

    Select Launch Instances
  5. Set the Name and any additional tags.

  6. In Application and OS Images, enter Wallaroo Install and press Enter.

  7. From the search results, select Community AMIs and select Wallaroo Installer 3a.

    Select AMI
  8. Set the Instance Type as c3.8xlarge as the minimum machine type. This provides 32 cores with 60 GB memory.

    Select Instance Type
  9. For Key pair (login) select one of the following:

    Select or Create Key Pair
    1. Select an existing Key pair name
    2. Select Create new key pair and set the following:
      1. Name: The name of the new key pair.
      2. Key pair type: Select either RSA or ED25519.
      3. Private key file format: Select either .pem or .ppk. These instructions are based on the .pem file.
      4. Select Create key pair when complete.
  10. Set the following for Network settings:

    Set Network
    1. Firewall: Select Create security group or select from an existing one that best fits your organization.
    2. Allow SSH traffic from: Set to Enabled and Anywhere 0.0.0.0/0.
    3. Allow HTTPs traffic from the internet: Set to Enabled.
  11. Set the following for Configure Storage:

    1. Set Root volume to at least 400 GiB, type standard.
  12. Review the Summary and verify the following:

    1. Number of instances: 1
    2. Virtual server type: Matches the minimum requirement listed above.
    3. Verify the other settings are accurate.
  13. Select Launch Instance.

It is recommended to give the instance time to complete its setup process. This typically takes 20 minutes.

Verify the Setup

To verify the environment is setup for Wallaroo:

  1. From the EC2 Dashboard, select the virtual machine created for your Wallaroo instance.

  2. Note the Public IPv4 DNS address.

    Instance Public DNS
  3. From a terminal, run ssh to connect to your virtual machine. The installation requires access to port 8800 and the private key selected or created in the instructions above.

    The ssh command format for connecting to your virtual machine uses the following format, replacing the $keyfile, $VM_DNS with your private key file and the DNS address to your Amazon VM:

    ssh -i "$keyfile" ubuntu@$VM_DNS -L8800:localhost:8800
    

    For example, a $keyfile of Doc Sample Key.pem and $VM_DNS of ec2-54-160-227-100.compute-1.amazonaws.com would be as follows:

    ssh -i "Doc Sample Key.pem" ubuntu@ec2-54-160-227-100.compute-1.amazonaws.com -L8800:localhost:8800
    
  4. If the Kubernetes setup is still installing, wait until complete and when prompted select EXIT to complete the process. This process may take up to 20 to 30 minutes.

    Complete Kubernetes Install

Install Wallaroo

With your environment ready, it’s time to install Wallaroo.

Step Status
Setup Environment
NEXT STEP!
COMPLETE
Install Wallaroo Install Wallaroo into a prepared environment

Cost Saving Tips

The following tips can be used to save costs on your AWS EC2 instance.

Stop Instances When Not In Use

One cost saving measure is to stop instances when not in use. If you intend to stop an instance, register it with static IP address so when it is turned back on your services will continue to function without interruption.

Stop instance.

Troubleshooting

I keep seeing the errors such as connect failed. Is this a problem?

Sometimes you may see an error such as channel 3: open failed: connect failed: Connection refused. This is the ssh port forwarding attempting to connect to port 8800 during the installation, and can be ignored.

When Launching JupyterHub, I get a Server 500 error

If you shut down and restart a Wallaroo instance in a new environment or change the IP address, some settings may not be updated. Run the following command to restart the deployment process and update the settings to match the current environment:

kubectl rollout restart deployment hub