Install cloudSwXtch on AWS

WHAT TO EXPECT

Deployment of a cloudSwXtch environment consists of two parts: the creation of an EC2 instance containing cloudSwXtch, and the installation of the xNIC software on the agents.

In this section, users will learn how to deploy cloudSwXtch for their AWS environment.

NOTE:

Root privileges are not required for deployment or operation. Our CloudFormation template allows an automated mechanism to update the installed cloudSwXtch version at first boot. This will deploy the latest version of the cloudSwXtch instead of the one packaged in the AMI, which requires root privileges to trigger the update from the product side. For upgrades, please see Upgrade cloudSwXtch on AWS on how to perform an upgrade from the client side. An upgrade from the client side does not require root privileges.

Creating a cloudSwXtch EC2 Instance

Prerequisites

Before starting, a user must do the following:

Review cloudSwXtch System Requirements.
Ensure that there is already an active and valid AWS account with proper rights.
Create a virtual network (VPC). This must be created before deploying a cloudSwXtch.
Validate subnets on AWS. A single subnet can be used for the control and data plane.
Verify a Security Group that allows access to all traffic inside the VPC. If one is not created, use the default when creating a cloudSwXtch.
Create an SSH Key Pair.

Post-Installation

The following instructions detail how to deploy a cloudSwXtch BYOL instance. After that deployment, a valid license needs to be in place. Read Licensing cloudSwXtch.

If all prerequisites are met, a cloudSwXtch can be created via the Marketplace in any region in approximately 10 minutes. If multi CPV or multi-region is required, then consider VPC peering and Clusters.

The installer will create a CloudFormation Stack to include the following resources:

ControlENI Networking Interface for control data
DataENI Networking Interface for data, such as Multicast
EC2Instance in Linux for the cloudSwxtch to run on

In order to create a cloudSwXtch, please do the following steps.

Sign in to AWS.
From the AWS console, search "Market" and select "AWS Marketplace Subscriptions" from the search results.
Select "Discover Products" in the AWS Marketplace menu on the left-hand side.
Search for "cloudSwXtch."
Select a Tier (cloudSwXtch - BYOL or cloudSwXtch - PAYG subscription) based on the usage requirements and features needed.
1. Please read the cloudSwXtch System Requirements article for more information regarding cloudSwXtch sizing.
2. For the purpose of this guide, the next screenshots will be for a cloudSwXtch BYOL deployment.
  Endpoint Connections Limit
  Be mindful of the number of endpoints connecting to the cloudSwXtch after creation. For cloudSwXtch BYOL, there is a limit to the number of endpoints allowed in the license.
  
  If users need to increase the number of endpoints, please view the AWS instructions here on how to change the cloudSwXtch instance type. Note that if the new instance type exceeds the size of the tier, a user must contact support@swxtch.io to update the license.
Select "Continue to Subscribe" after reviewing the product information. Note: The "Typical Total Price" is calculated with the recommended instance size included in the final monthly value and a utilization of 24x7. Please note: The cost in "Software Pricing Details" is for the cloudSwXtch and does not include costs for the AWS instance.
Review the Terms and Conditions.
Click "Accept Terms" if they are acceptable.
Click "Continue to Configuration" after reading the subscription and license management.
Select the desired "Region” and then click “Continue to Launch”. (Note: If the user selects a region that does not match the region where the process began, then it may not work even if selected here.)
INSTANCE TYPES
It is recommended to use an instance type in the c6in or m6in families. Remember that a cloudSwXtch requires a minimum of 8 cores. Note how the cloudSwXtch Marketplace install selects the appropriate VM size in the Fulfillment section based on the cloudSwXtch tier.
Please ensure that the instance type matches one of the options below:
- c6in.2xlarge
- c6in.4xlarge
- c6in.8xlarge
- c6in.12xlarge
- c6in.16xlarge
- c6in.24xlarge
- c6in.32xlarge
- m6in.2xlarge
- m6in.4xlarge
- m6in.8xlarge
- m6in.12xlarge
- m6in.16xlarge
- m6in.24xlarge
- m6in.32xlarge
Read “Usage Instructions” if desired.
Use the “Choose Action” dropdown menu and select “Launch CloudFormation”.
Click “Launch”.
Keep Settings on default on the "Create Stack" page and select "Next."
On the Specify stack details page, complete the following:
1. Under “Stack name," enter a name. Keep in mind that this will be used for everything added to the stack. For example: “resource name,” “security groups,” “EC2 instance name,” etc.
2. Under “CidrIpForInboundOutboundTraffic,” use 0.0.0.0/0 so that users can SSH to the virtual machine from any IP address, unless a more restrictive range is desired.
3. Under “ControlSubnet,” use the dropdown to find the already created control subnet (recommended: ctrl-subnet).
4. Under “DataSubnet,” use the dropdown to find the control subnet again. Both control and data can share the same subnet.
  1. Alternatively, for better performance, a user can assign a separate subnet for their data subnet.
5. For “InstanceType,” there should be "Fulfillment" data from the earlier step.
6. Under “KeyName,” use the dropdown to find the SSH key.
7. In “PassedSwxtchSecruityGroup,” use “default” and one will be created during the installation process. Alternatively, users can enter the ID of an already created security group. It will be something similar to "sg-009273855418af38d."
8. Under “VpcId,” select from the dropdown to find the already created VPC.
9. Here is an example of how a template would look:
Click "Next."
The “Configuring stack options” page is completely optional. The user can assign tags to the stack, set additional IAM permissions, stack failure options, etc.
Click "Next".
Verify that the parameters are accurate on the final "Review" page. If everything is OK, select "Edit."
Click "Submit." On the next page, the creation of the stack is displayed.
The EC2 instance has now been created. It should appear in the EC2/Instances list.
Once connected with SSH to the cloudSwXtch, run the following command:
```
swx-top
```

This will display the cloudSwXtch's swx-top dashboard. In "Status," it should be read "OK." This will let the user know that the cloudSwXtch has been successfully deployed. More information regarding swx-top can be seen in the swx-top page.

INSTALLING AN XNIC

If this is a new installation, then each client that is expected to receive or transmit to the cloudSwXtch will need an xNIC installed.

If this is an existing cloudSwXtch replacement, then each client with an xNIC already installed will need to be upgraded to match the current cloudSwXtch version.

Users can find more information about xNIC installation in the Installing xNIC page.

Required Step for BYOL: Contact swXtch.io for a license

Users deploying a BYOL instance of cloudSwXtch will need to contact swXtch.io for a license file. For more information, see Licensing cloudSwXtch.

Checking the Health of the cloudSwXtch Instance

It is important to ensure the AWS system is healthy. AWS provides AWS CloudWatch as a way to check on the health of the systems. To check on the cloudSwXtch EC2 instance, read more in the Check the Health of the cloudSwXtch Instance on AWS page.

Upgrading cloudSwXtch on AWS

It is important that the cloudSwXtch instance is up to date. To learn how to upgrade a cloudSwXtch, read more in the Upgrading cloudSwXtch page.

Deleting cloudSwXtch on AWS

To learn how to delete a cloudSwXtch, read more in the Delete cloudSwXtch on AWS page.