Install cloudSwXtch for an Air-Gapped Environment

WHAT TO EXPECT
In this article, you will learn how to install a cloudSwXtch in an Air-Gapped (Closed Network) environment for Azure. For standard Azure installation instructions, please see the cloudSwXtch on Azure article.

Before You Start

Review VM Requirements for a cloudSwXtch Instance in cloudSwXtch System Requirements.

VM Image Creation

The cloudSwXtch software is delivered as a Virtual Machine Disk Image. This Image file can be added to an Azure Image Gallery. Images in an Image Gallery can be used to create Virtual Machines.

To assist with creation of VMs from images in a gallery, swXtch.io provides instructions on how to accomplish the following:

Complete all steps to successfully install cloudSwXtch in an Air-Gapped environment.

STEP ONE: Get the VM Disk Image

Log onto an environment that has access to the internet and download the following file onto a machine with access to the Azure Air-Gapped Environment (~30GB):

https://swxtchpublic.blob.core.windows.net/3hwgfe98hfglsrdfh4/cloudSwXtch_osdisk_3.0.0.airgap.vhd

STEP TWO: Upload the VM Disk Image into an Azure Storage Account

Upload the files into an Azure storage account in the secure Azure Environment.
1. Log into the Azure Portal
2. Navigate to Storage Accounts.
3. Select the desired storage account or create a new one.
4. Select the desired Container or create a new one.
5. Select Upload and select the VM Disk Image file you copied to the local PC.
6. Start the upload and wait for it to complete.

This may take some time to upload the file (up to an hour). When completed, the file should show with a green checkbox.

Failed to Upload Blob(s) Message

If you receive a "Failed to Upload Blob(s)" message when uploading the file in the Storage Account, select Configuration and validate the Allow storage key access is enabled.

Azure-airgapped_failedtouploadpng

STEP THREE: Create a VM Image from the Disk Image

Once we have a disk image in storage, we can use it to create a VM image. A VM image is a snapshot of a VM. The real VM will be created later. The VM Image only needs to be created once. Any number of VMs can be instantiated from a single VM image.

In the Azure Portal, Search for and select Images.
Select Create.
Select the appropriate Resource Group.
Give the VM Image a name. The cloudSwXtch instance will be created later with a different name. Pick a name with the cloudSwXtch software version in it as you may end up with multiple images after some time.
Ensure that the region is the same for the storage account holding the disk image.
Select Linux as the OS type
Select Gen 1.
Click Browse on the Storage Blob.
1. In the new panel, navigate to the storage account and container holding the disk image.
2. Select the file that was previously uploaded.
For Account Type, select Standard SSD. See the example of the screen filled out completely.
If tags are desired, then select Tags and enter the required tags.
The other fields can be left as default.
Select Review and create.
When validation passes, select Create. When it is complete, click Go to Resource to see the image.

STEP FOUR: Create cloudSwXtch from VM Image

Now that we have a cloudSwXtch VM Image, we can use it to instantiate a cloudSwXtch.

Navigate to Images.
Select the image with the cloudSwXtch version you require.
Select Create VM.
Fill out the Create Virtual machine form like below:
1. Under Project Details, set the subscription and Resource Group for where you want the cloudSwXtch instance to be located.
2. Under Instance Details, Name the Virtual Machine with a valid host name.
3. Select No infrastructure redundancy required for Availability options.
4. Select appropriate machine size. For recommendations based on features, endpoints, and bandwidth needs, read the cloudSwXtch System Requirements.
5. Under Administrator account, use SSH for the authentication type. Enter your SSH public key source. Refer to ssh-keys-portal for details.
6. Select your preference in Inbound port rules.
7. Set the Licensing Type to Other.
8. Navigate to the Networking tab and fill out the form like below:
  1. Select the appropriate Virtual Network.
  2. Select the appropriate control subnet.
9. Navigate to other tabs as desired and enter in information as preferred. For example, some installations expect Tags to be entered.
10. Select Review + Create.
11. When validation passes, select Create.
When the deployment is complete, select Go to Resource.
Select Stop to stop the VM.
Navigate to Network Settings under Networking.
Select Attach network Interface.
Select Create and attach Network. A new form will open.
Enter your information into the form to add a new NIC like shown. It is good practice to include the word, “data”, in the name to distinguish between the two.
1. Note: For Public inbound ports, it is up to the user to decide.
Select Create.
When it is done, the screen will automatically refresh with the new “data” interface listed as the top network interface. There should now be a control and data interface in the dropdown.
Click the Data Network Interface.
1. Select Overview in the side menu.
2. Select Edit accelerated Networking. A new window will display.
3. Select Enabled.
4. Check the agreement.
5. Select Save.
The page will automatically refresh and navigate back to Overview page. Validate that Accelerated networking is Enabled.
Start the newly created cloudSwXtch VM.

STEP FIVE: License the cloudSwXtch

Log onto the newly created VM.
Run this command:
TextText
```
swxtch-top
```
The swXtch-top dashboard will display.
Copy the “SwxtchId” and email it to support@swxtch.io requesting a license.
When you receive the license file, upload it onto the cloudSwXtch VM.
Move the license.json file to the /swxtch directory using the following command replacing user with the appropriate value:
TextText
```
sudo mv /home/<user>/license.json /swxtch
```
Reboot the cloudSwXtch and run swxtch-top again or journal to check the license took place:
TextText
```
sudo journalctl  -u swxtch-ctrl.service -f -n 500
```

swxtch-top_Licensing

The cloudSwXtch is ready for use. IMPORTANT: Each client that is expected to get traffic from the cloudSwXtch will need an xNIC installed. See Installing xNIC for next steps in preparing clients (producers and consumers of Multicast).

Prerequisite: Installing Dependencies for Air-Gapped Clients
Before installing the xNIC, users will need to install the necessary packages on their air-gapped clients. Failure to complete this prerequisite will result in an unsuccessful xNIC deployment. To learn more, see How to Install xNIC Dependencies in an Air-Gapped Environment.