Install cloudSwXtch via GCP Marketplace

Prev Next

WHAT TO EXPECT

Prerequisites

A user needs the following to deploy a cloudSwXtch via the GCP Marketplace: 

  • An existing Deployment Service Account established in their Google Cloud Console project. Creating a new account is further detailed in Step Two. 

  • Two (2) VPCs available -- one for the Control NIC and another for Data. All cloudSwXtch installations require 2 NICs. Please review the GCP documentation on how to create and modify VPCs

    • Note: GCP does not allow having 2 NICs on the same VM using the same VPC. It will return an error message. The Control and Data NICs must be assigned within their own VPC. 

Please review the cloudSwXtch System Requirements for additional prerequisites. 

Step One: Navigate to cloudSwXtch in the GCP Marketplace

  1. Log in to the Google Cloud Console

    GCP_ConsolePage

  2. Navigate to the Google Cloud Marketplace using the Navigation menu at the top left corner. 

    GCP_NavigationBars

  3. Select Marketplace

    GCP_Navigate-Marketplace

  4. Search for cloudSwXtch

    GCP_Marketplace_Search

  5. Select the product, cloudSwXtch BYOL

    GCP_cloudSwXtch BYOL Offering

  6. Click Launch to open the deployment configuration page. 

    GCP_cloudSwXtch Marketplace page

Enabling APIs

After hitting launch, a new window might open asking to enable Google APIs. Users must enable the suggested APIs to continue. 

Step Two: Configure cloudSwXtch Deployment

  1. Enter a Deployment name for the cloudSwXtch. 

  2. Select an Existing account under Deployment Service Account. 

    GCP_Configure-cloudSwXtch

    1. If there’s no Deployment Service Account, select New Account. The user will need permissions from a Project IAM Admin (or someone with the resourcemanager.projects.setiampolicy permissions) to allow the creation of a new Deployment Service Account. 

    2. Enter the same name used for the cloudSwXtch Deployment for your New Account Name and ID. The names must match and only use lowercase letters and numbers. 

    3. The account will be created after the deployment of the cloudSwXtch. Once an account is created, users without permissions can use it as an Existing account option.  GCP_Configure-cloudSwXtch-newaccount

  3. Under SwXtch Machine Type, confirm that N2 is selected under Series

  4. Confirm sizing under Machine Type. The default is set to n2-standard-16, which is 16 cores. A cloudSwXtch must have a minimum of 8 cores. For cloudSwXtch Sizing guidelines, see cloudSwXtch System Requirements

  5. Confirm the desired Zone

    GCP_Marketplace-MachineType

  6. Use the dropdown arrow under Control network interface to open the configuration panel. If the default subnet is already selected and the user does not wish to set a public IP, continue to Step 10.

    GCP_Marketplace-ControlNIC-Arrow

  7. Select a Network and Subnetwork. This subnet will be used for control plane communications. 

    1. Optional: Users can select Ephemeral under External IP if they wish for their Control NIC to be assigned a randomized public IP address. 

      GCP_Marketplace-EditControl

  8. Click Done.

  9. Use the dropdown arrow under Data network interface to open the configuration panel.GCP_Marketplace-DataNIC-Arrow

  10. Select a Network and Subnetwork. This 2nd subnet will be used for the data plane communications and should've been created before starting the deployment process. 

    1. Please note: The control and data NICs cannot share a subnet. They must have separate subnets. 

    2. Optional: Users can select Ephemeral under External IP if they wish for their Data NIC to be assigned a randomized public IP address. 

      GCP_Marketplace-EditData

  11. Click Done

  12. Click Deploy

    GCP_Marketplace-Deploy(1)

The cloudSwXtch instance will now be deployed. GCP_Marketplace-Deployed

Step Three: Add SSH Key(s)

In order to access the Google Cloud VM instance, users will need to add an SSH key to the cloudSwXtch deployment. 

  1. Click on the Navigation menu on the left-hand corner, highlight Compute Engine, and select VM instances

    GCP_Marketplace-ComputeEngine

  2. Select the name of the cloudSwXtch deployment to open its configuration page. 

    GCP_Marketplace-VMInstances

  3. Choose Edit next to the cloudSwXtch deployment name. 

    GCP_Marketplace-EditVM

  4. Scroll down to SSH Keys under Security and Access

  5. Click +Add Item

    GCP_Marketplace-AddSSH

  6. Enter the SSH key. Users can add multiple keys. 

    GCP_Marketplace-EnterSSHKey

  7. Hit Save at the bottom of the page. 

Upgrading the cloudSwXtch Instance

After deployment, it is recommended to update the cloudSwXtch instance to the latest. Please refer to the Upgrading cloudSwXtch article for more information.

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 How to License a cloudSwXtch