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 GCP documentation on how to create and modify VPCs
    • Note: GCP does not allow you to have 2 NICs on the same VPC. It will return an error message. The Control and Data NIC must be assigned their own VPC. 

Please review cloudSwXtch System Requirements for additional prerequisites. 

Step One: Navigate to cloudSwXtch in the GCP Marketplace

  1. Log into the Google Cloud ConsoleGCP_ConsolePage
  2. Navigate to the Google Cloud Marketplace using the Navigation menu at the top left corner. GCP_NavigationBars
  3. Select MarketplaceGCP_Navigate-Marketplace
  4. Search for cloudSwXtchGCP_Marketplace_Search
  5. Select the product, cloudSwXtch BYOLGCP_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 you to enable Google APIs. You must enable the suggested APIs to continue. 

Step Two: Configure cloudSwXtch Deployment

  1. Enter a Deployment name for your cloudSwXtch. 
  2. Select an Existing account under Deployment Service Account. GCP_Configure-cloudSwXtch
    1. If you do not have a Deployment Service Account, select New Account. You will need permissions from your Project IAM Admin (or someone with the resourcemanager.projects.setiampolicy permissions) to allow you to create a new Deployment Service Account. 
    2. Enter the same name used for your 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 you deploy your 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 your sizing under Machine Type. The default is set to n2-standard-16, which is 16 core. A cloudSwXtch must have a minimum of 8 cores. For cloudSwXtch Sizing guidelines, see cloudSwXtch System Requirements
  5. Confirm your desired ZoneGCP_Marketplace-MachineType
  6. Use the dropdown arrow under Control network interface to open the configuration panel. If your default subnet is already selected and you do not wish to set a public IP, continue you on Step 10.  GCP_Marketplace-ControlNIC-Arrow
  7. Select a Network and Subnetwork. This subnet will be used for your 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 when you are happy with your selections.
  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 your 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 when you are happy with your selections. 
  12. Click DeployGCP_Marketplace-Deploy(1)

Your cloudSwXtch instance will now be deployed. GCP_Marketplace-Deployed

Step Three: Add SSH Key(s)

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

  1. Click on the Navigation menu on the left hand corner, highlight Compute Engine and select VM instancesGCP_Marketplace-ComputeEngine
  2. Select the name of your cloudSwXtch deployment to open its configuration page. GCP_Marketplace-VMInstances
  3. Choose Edit next to your cloudSwXtch deployment name. GCP_Marketplace-EditVM
  4. Scroll down to SSH Keys under Security and Access
  5. Click +Add ItemGCP_Marketplace-AddSSH
  6. Enter your SSH key. You can add multiple. GCP_Marketplace-EnterSSHKey
  7. Hit Save at the bottom of the page. 
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: 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