Installing cloudSwXtch via Template
The best method for deploying a cloudSwXtch on Azure is via a template. For more information on this method, please review the Install cloudSwXtch on Azure guide.
Prerequisites
Before starting, ensure that you have validated your subnets on Azure. Return to this page after completing that preliminary step.
Creating a Virtual Machine
Log in to the Azure Portal. You will need the following permissions to create and manage virtual machines and to create Managed Applications.
virtual-machine-contributor: To create and manage virtual machines.
managed-application-contributor-role: To create Managed Applications.
Select Marketplace.
Search for cloudswXtch.
Select a plan. For more information, see: cloudSwXtch System Requirements.
Click on the cloudSwXtch VM Image drop down menu to select a plan. Please note: A BYOL instance will require users to obtain a license from swXtch.io. For more information, see here.
cloudSwXtch BYOL
It is recommended that users select cloudSwXtch BYOL, which allows for more customizability including expanded bandwidth, increased endpoint limit and additional licensable features. Users will need to request a license from support@swxtch.io. For more information, please see cloudSwXtch System Requirements.
The Create a virtual machine will open with the selected plan. If the plan was not selected in the previous screen, then the following screen will open to choose a plan.
Select either Create or Start with a pre-set configuration.
NOTE
swxtch.io is just using the standard Azure Marketplace VM from Image method, this document will not go over all the tabs and fields in the tabs as they are not cloudSwxtch specific. Some things of note in the Azure Marketplace VM image creation are as follows:
The Start with a pre-set configuration vs Create will eventually lead to the same UI where there are many tabs to enter data. However, the Start with a pre-set configuration will fill in certain fields based on the user's selections. For example, in the Basics tab it will fill in Boot diagnostics, Availability options, and Size. In addition, the Disks tab will fill in the OS disk type.
REMINDER: This Market Place method will only create one NIC. The second required NIC will need to be added after creation.
Follow the tabs and make appropriate selections – there are a number of fields that have to be filled in to create a cloudSwXtch instance.
In the Basics tab, select a Subscription.
Choose (or create) a Resource Group.
Assign the Virtual Machine Name. This name must be unique.
Select a Region.
Confirm the Image is the correct one you selected when choosing a plan: cloudSwXtch BYOL or cloudSwXtch PAYG.
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.
Continue on the Networking Tab.
Networking Tab
The cloudSwXtch instance must be associated with a virtual network and the virtual network must have at least two subnets: one for control plane and one for data plane traffic. This user interface only allows attachment of one subnet. Below steps will describe how to add a second subnet after creation. See “System Requirements” above for details.
Check Delete public IP and NIC when VM is deleted.
OPTIONAL: Change values on other tabs.
Select Review and Create.
Carefully review the plan pricing.
Read the Terms & Conditions.
Select I agree when ready. Note: The creation will take 2-3 minutes depending on Azure varieties.
Creating the Second Subnet *REQUIRED*
Navigate to the newly created VM by selecting the Go to Resource button.
Click Stop at the top of the toolbar.
Select Yes when prompted.
Click Networking on the left hand side under settings. Alternatively, you can select Networking in the main Properties page.
Select Attach network interface.
Select a Resource Group under Project Details.
Enter in a Name under Network Interface.
Select a Subnet. Please note: You can optionally change other data.
Select Create.
Refresh the screen after completing the form and the second subnet should be added in a second tab.
Enabling "Accelerated Networking" *REQUIRED*
The newly created Network Interface needs to be updated to enable Accelerated Networking to do this follow the steps below:
Select the Network Interface. In the example below, it is named vm-swxtch-300-data.
Click the blue link to the Network Interface.
Click Edit accelerated networking.
Select Enable.
Select I have validated that the operating system supports accelerated networking.
Click Save.
Start the VM for use.
Upgrading your cloudSwXtch Instance
After deployment, it is recommended to update your cloudSwXtch instance to latest. Please refer to the Upgrading cloudSwXtch article for more information.
Required Step for BYOL: Request a License from swXtch.io
Users deploying a BYOL instance of cloudSwXtch will need to contact swXtch.io for a license file. For more information, see How to License a cloudSwXtch.
Important
If this is a new install then each client that is expected to get traffic from the cloudSwXtch or send to the cloudSwXtch will need a xNIC installed. If this is a existing install then each client with an xNIC already installed will need to be upgraded. Please see xNIC Installation.