Cloud agnostic cloudSwXtch Install

Prev Next

WHAT TO EXPECT

In this article, users will learn how to install a cloudSwXtch instance on an existing Linux Ubuntu 24.04 virtual machine. This install process can be used on any cloud but requires a license file from swXtch.io. For more information about VM prerequisites, please see the cloudSwXtch System Requirements

Pre-Installation Step: Create VM

Before installing cloudSwXtch, users will need to create an Ubuntu 24.04 virtual machine on the desired cloud with a connection to the internet. In addition, it should encompass all the prerequisites outlined in the cloudSwXtch System Requirements.

Cloud Specifics

In OSI when creating the VM you MUST select “Hardware-assisted (SR-IOV) networking” in the “Advanced” section in the “Networking” tab.

For OCI also see step 7-9 in Install cloudSwXtch via Marketplace for other changes to the VM after creation.

Step One: Upgrade system

STEP ONE: Update Currently Installed OS Packages

  1. Please update all of the currently installed OS packages

    1. Ubuntu

      apt update && apt upgrade
  2. Reboot VM.

Prerequisites

Users must install and enable Docker on their Ubuntu VM. Please see  "How to Install Docker on RHEL and Ubuntu".

NOTE

The installation script can also install all dependencies if the argument --auto_deps is used in the swx-install.sh line.

Step Two: Install cloudSwXtch

In this step, users will execute commands in their VMs to manually install a cloudSwXtch instance.

  1. Connect to the VM instance that will be used as a cloudSwXtch.

  2. Enter the following command to download the cloudSwXtch installer script:

    1. This will install without installing dependencies or persisting configuration data, see b.  for persistence and dependencies parameters.

      token="si=RDONLY&spr=https&sv=2021-06-08&sr=c&sig=xyPF7SyI1cagUAEIZViqCHz7RroFTy2Fkltn2wwvMzc%3D"
      ver="v4.0.0"
      curl -X GET -H "x-ms-date: $(date -u)"  "https://sdmcdevstorage.blob.core.windows.net/imagebuilder/swx-swxtch-${ver}.tar.gz?$token" -o /tmp/swx-swxtch-${ver}.tar.gz 
      tar -xvf /tmp/swx-swxtch-${ver}.tar.gz -C /tmp; /tmp/swx-swxtch-${ver}/swx-install.sh  
    2. To persist data and automatically install dependencies, use this command instead of the last line in the command above:

      tar -xvf /tmp/swx-swxtch-${ver}.tar.gz -C /tmp; /tmp/swx-swxtch-${ver}/swx-install.sh --auto_deps --persist

      For Docker commands, see:  Helpful Docker Service Commands

    3. Upon success the system will reboot.

    4. After reboot validate that the cloudSwXtch is running using the command below:

swx-top

Step Three: Contact swXtch.io for a license

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

NEXT STEPS

The cloudSwXtch is ready to use. The next step is to install the xNIC on each client expected to get traffic from the cloudSwXtch. See Installing xNIC for more information on preparing clients.