WHAT TO EXPECT
Deployment of a cloudSwXtch environment consists of two parts: the creation of an instance containing cloudSwXtch, and the installation of the xNIC software on the agents.
In this section, users will learn how to deploy a cloudSwXtch in their Azure environment through the template method.
Please note: This is the preferred method of installation. However, alternatively, a manual install via other methods can be done. For more information on this method, please see the note “Alternative Install Methods”.
Deploying a cloudSwXtch instance
Prerequisites
Before starting, a user must do the following:
Review cloudSwXtch System Requirements.
Validate the Subnet(s): A virtual network must be created before creating a cloudSwXtch instance. This must contain one subnet, known as the ctrl-subnet. In addition, you can have a separate data-subnet.
Create an Azure cloudSwXtch Template: Creating a template will allows users to follow the easiest method for cloudSwXtch deployment detailed below.
Make sure that the Azure subscription has the quota and access privileges to create the virtual machine instance used to run the cloudSwXtch. The instance will fail to be provided if quota for the selected machine size is not available.
Log in to the Azure Portal.
Find the template by using the Search resource, services, and docs (G+/) bar and enter cloudSwxtch-from-mp-image in the search. This will take the console directly to the template.
Select the template.
Click Deploy to launch the template UI.
In the cloudSwXtch commercial plan area, click on the Choose a cloudSwXtch plan dropdown and select a plan (BYOL or PAYG). For more information on plans, see: cloudSwXtch System Requirements.
In the Project Details area, select a valid Subscription for the account.
Pick (or create) an Azure Resource Group.
In the Instance details area, notice how the region is filled in from the Azure Resource Group.
Assign the Swxtch Machine name. This name must be unique in both the resource group and the virtual network in which the instance will exist. It also must meet the requirements for a VM host name.
Select the cloudSwXtch size.
Note
The default size is 1x Standard D8s V4. A minimum of 8 cores is minimum with 16 recommended for cloudSwXtch deployment.
NOTE:
Please be aware that the owner of the Azure Subscription in which the cloudSwXtch instance is created is responsible for all cloud resources used by the cloudSwXtch. These fees are to the cloud provider and do not include any fees to swxtch.io for cloudSwXtch licensing.
Enter an Admin name. This will default to swxtchadmin, but can be modified.
Enter an SSH public key source. The options are:
Generate new key pair.
If selected, enter in Key Pair Name. This name must be unique among other key pairs in Azure.
Use existing key stored in Azure.
If selected, choose a stored key from the drop-down menu.
Use existing public key.
If selected, paste in an SSH public Key from Azure. Refer to https://learn.microsoft.com/en-us/azure/virtual-machines/ssh-keys-portal for how to get an existing public key.
Select the software version. The most common choice is latest, which will use the most recent software release for this instance. For more control, a specific release version can be entered, e.g., 4.0.0.
In the Optional Resource Tags area, optionally add Tags. Tags can be added to all Resources
Select Next, which will bring the Network tab.
Select a previously created virtual network.
WARNING
Due to an issue with Azure templates, do not select the Create new option for the network because the created network will not be accessible at that screen. Always select a previously created virtual network.
In the Configure virtual networks area, select a Control Subnet Name.
Select a Data Subnet Name (if using only one subnet, select the same Control Subnet Name).
OPTIONAL: In the Advanced Networking (optional) section:
Add a static IP Address.
Specify a Proximity Placement Group.
Specify an Availability Set.
Availability zone.
Select Review and Create.
Review the plan pricing.
Read the Terms & Conditions.
Select I agree when ready.
The creation will take 1-3 minutes, depending on Azure vagaries. When done, a cloudSwXtch instance shall exist within the selected Azure Resource Group, ready for use.
Post-Installation
IMPORTANT: If this is a new install, then each client that is expected to get traffic from the cloudSwXtch will need an xNIC installed. If this is an existing install, then each client with an xNIC already installed will need to be upgraded. Please see xNIC Installation.
For Windows-related clients, it's important to restart the console once the installation is complete, in order to be able to execute cloudSwXtch tools properly from any client's user home directory.
24/7 Operations
If the services need to be up and running 24/7, swXtch.io suggests that redundant systems exist for which will be referred to as "Main" and "Backup". During an upgrade, the Backup system should be upgraded, then the traffic should be routed to the Backup while the Main is upgraded.
Uninstalling cloudSwXtch
Delete the cloudSwXtch instance normally, like any other virtual machine.