Create a VMware Site

Objective

This document provides instructions on how to install a Volterra single-node site or multi-node site on VMware ESXi. To know more about Volterra sites, see Volterra Site.

Using the instructions provided in this document, you can deploy a Volterra site by deploying a virtual machine from an Open Virtual Appliance (OVA) file containing the node as the appliance.


Prerequisites

  • A Volterra Account. If you do not have an account, see Create a Volterra Account.
  • VMware vSphere Hypervisor (ESXi) 4.0 or later. The examples in this document are based on the version 6.7u2.
  • At least one interface with internet reachability.
  • A Volterra VMware OVA image file. Click here to download.
  • A minimum of 10 GB of memory for the guest virtual machine.

Deploy Site

Perform the steps in the following sections to deploy a Volterra Site on VMware ESXi.

Create a Site Token

Create a site token or use an existing token. If you are configuring a multi-node site, use the same token for all nodes.

Step 1: Log into VoltConsole and navigate to site tokens.
  • Click on the System namespace.
  • Select Manage -> Site Management -> Site Tokens.

NameSpaceNavig
Figure: Site Tokens

Step 2: Generate a new site token.
  • Click Add site token to create a new token. This loads the Add site token form.
  • In the Name field, enter the token name.
  • In the Description field, enter a description for the token.
  • Click Add site token.

CreateSiteToken
Figure: Site Token Form

Step 3: Note down the new token.
  • Find the token previously created or choose an existing token from the list of tokens displayed.
  • Click > to expand the token details in JSON format and note down the value of the uid field.

SiteTokenUID
Figure: UID Field


Configure VMware ESXi Hypervisor

Step 1: Login to the VMware-ESXi portal using the ESXi host IP address.

ESxiLogin
Figure: Login to VMware ESXi

Step 2: Configure the host.

HostCnf
Figure: Host Configuration

Step 3: Configure the Portgroup - Management Network with a single interface.

PortGrpMGNWCnf
Figure: Portgroup Management Network Configuration

Step 4: Configure the Portgroup - VM Network with a single interface.

PortGrpVMNWCnf
Figure: Portgroup VM Network Configuration

Step 5: Configure the virtual switch.

Use the following sample topology:

VirtL2Topo
Figure: Virtual L2 Topology


Install the Volterra Node on VMware ESXi Hypervisor

Step 1: Select `Create / Register VM' from 'Virtual Machines` section.

CreateVM
Figure: Create a Virtual Machine

Step 2: Select 'Deploy a virtual machine from an OVF or OVA file' from the options listed.

NewVM
Figure: Create a new virtual machine

Step 3: Enter 'Virtual Machine Name' and click to select or drag and drop the OVA file.
  • Name: Virtual machine name to be represented in VMware environment.
  • OVA or OVF file: Click to select or drag and drop the OVA file provided or downloaded in the step above into the box.

NameandGOSProps
Figure: Name and OVA image

Step 4: Select storage as required based on the storage available on the hypervisor host.

StorageSel
Figure: Storage Selection

Additional datastores can be created as necessary using the wizard as shown below:

Step 5: Configure the deployment options.

Configure as per the following guidelines:

  • Network Mappings: Select the port-group where the VM is going to be connected.
  • Disk provisioning: Select thin or thick provisioning - Default is thin provisioning
  • Power On automatically: If enabled it will power on the Virtual Machine as soon as the setup is complete and image uploaded - Default is enabled.

Deployment options
Figure: Deployment options

Step 6: Enter additional settings.

These set of parameters enable the machine to boot up and request registration directly in your tenant. These settings also allow you to configure the static IP address. However, DHCP is used by default.

Note: The following are the only settings supported with the Volterra node Custom vApp properites.

  • Hostname: Specify the hostname for this device - example: master-0.

Note: Ensure that host names are distinct and unique incase you are installing nodes for multi-node site.

  • Token: Volterra site token required for site generation.

Note: The token should be created prior to using it in site creation. See Create a Site Token for more information.

  • Cluster Name: Set the cluster name.
  • Name for outside network interface: eth0
  • DHCP support for outside network interface: yes. By default, this is set to yes. If you want to configure static IP addresses, then set this to no.
  • Role for outside network interface: public. By default, this is set to public as the interface will have internet access.
  • IP address/bitmask for network interface: empty by default. If DHCP was set to no then you can configure your static ip address here. Example: 10.1.1.1/24

Note: Changing IP address for a registered node is not supported in case of multi-node sites. You must use either fixed IP adresses or DHCP adresses with a fixed lease.

  • Default gateway for outside network interface: empty by default. If DHCP was set to no then you can configure the default gateway for your network here. Example: 10.1.1.254
  • Route destination(destination network) for outside network interface: empty by default. If DHCP was set to no then you can configure the destination here. Because this is the default gateway we can use 0.0.0.0/0. For specific setups, you can change the default destination
  • Primary DNS: empty by default. If DHCP was set to no then you can configure your DNS Server here. Example: 8.8.8.8
  • Secondary DNS: empty by default. If DHCP was set to no then you can configure your secondary DNS server here: Example: 8.8.4.4
  • Certified Hardware: The supported options are vmware-voltmesh, vmware-voltstack-combo, vmware-regular-nic-voltmesh, vmware-multi-nic-voltmesh, vmware-multi-nic-voltstack-combo. The default option is vmware-regular-nic-voltmesh and this supports 2 interfaces. However, this is loaded by default with eth0 interface set as dedicated site local outside interface. The other interface is an optional regular interface and can be only configured from VoltConsole using fleet after the site is provisioned. For instructions on configuring interfaces using fleet, see Create a Fleet document.

Note: In case of vmware-regular-nic-voltmesh, ensure that you have 2 interfaces (eth0 and eth1) available. This option is same as vmware-multi-nic-voltmesh except that the inside interface is not a dedicated interface but it is a regular interface.

  • Latitude: Enter latitude. This can also be specified during registration in VoltConsole.
  • Longitude: Enter longitude. This can also be specified during registration in VoltConsole.

Configure additional settings
Figure: Configure additional settings

Step 7: Complete the wizard.

Complete the wizard
Figure: Complete the wizard

Step 8: The OVA gets uploaded, the virtual machine is built, and booted.
Step 9: Log on to the terminal of VM and perform initial configuration.
  • Enter admin as username and Volterra123 as the initial password. Update the password after first login as per the instructions displayed.
  • Perform inside network configuration as per the options displayed.

Register the VMware Site

After the Volterra Node is installed on VMware, it must be registered as a Site in VoltConsole.

Note: The USB allowlist is enabled by default. If you change a USB device, such as a keyboard after registration, the device will not function.

Single-node Site Registration

Step 1: Navigate to the site registration page.
  • Log into VoltConsole and then navigate to the System namespace.
  • Click Manage -> Site Management -> Registrations.

AcceptReg
Figure: Site Registration

Step 2: Complete site registration.
  • Under Pending Registrations, find your node name and then click the blue checkmark.
    Pending Registration
    Figure: Pending Registration
  • In the form that appears, fill in all required fields with the asterisk symbol (*).
  • Enter a latitude value and a longitude value.
    Form Completion
    Figure: Form Completion
  • Enter other configuration information, if needed.
  • Click Save and Exit.
Step 3: Check Site status and health.

It may take a few minutes for the site health and connectivity score information to update.

  • In the System namespace, click Sites -> Site List.
  • Click on your Site name. The Dashboard tab appears, along with many other tabs to inspect your Site.
  • Click the Site Status tab to verify the following:

    • The Update Status field has a Successful value for the Volterra OS Status section.
    • The Update Status field has a Successful value for the Volterra Software Status section.
    • The Tunnel status and Control Plane fields under the RE Connectivity section have up values.

HealthCheck
Figure: Site Status Check

Multi-node Site Registration

Step 1: Navigate to the site registration page.
  • Log into VoltConsole and then navigate to the System namespace.
  • Click Manage -> Site Management -> Registrations.

AcceptReg
Figure: Site Registration

Step 2: Accept the registration requests.

Registration requests are displayed in the Pending Registrations tab.

  • Click Accept to accept the registration requests from the master-0, master-1, and master-2nodes.
  • Enter the same values for the following parameters for all the registration requests:

    • In the Cluster name field, enter a name for the cluster. Ensure that all master nodes have the same name.
    • In the Cluster size field, enter 3. Ensure that all master nodes have the same cluster size.
  • Enter all mandatory fields marked with the asterisk (*) character.
Step 3: Check Site status and health.

It may take a few minutes for the site health and connectivity score information to update.

  • In the System namespace, click Sites -> Site List.
  • Click on your Site name. The Dashboard tab appears, along with many other tabs to inspect your Site.
  • Click the Site Status tab to verify the following:

    • The Update Status field has a Successful value for the Volterra OS Status section.
    • The Update Status field has a Successful value for the Volterra Software Status section.
    • The Tunnel status and Control Plane fields under the RE Connectivity section have up values.

HealthCheck
Figure: Site Status Check

Note: If you need to change any of the settings for your node, see Update Node Settings.


Update Node Settings

You can change node settings for an installed node or install a new node using a template.

Step 1: Update the settings for an installed node.
  • Power off the virtual machine.
  • In the vSphere/ESXi UI, change the vApp properties.
    Update Settings Using vApp Properties
    Figure: Update Settings Using vApp Properties
  • Update the settings, such as cluster, certified hardware, token, etc.
  • Perform factory reset and reboot the virtual machine.
  • Perform the post install and registration steps as instructed in the previous section.
Step 2: Create an OVF file to install a node through template.
  • Select your virtual machine and click File -> Export to OVF.
  • Enter a name for the OVF file and specify a directory in which to save it.
  • Specify to export the virtual machine as an OVF.
  • Click Export to start the OVF export process.

You can customize the node settings using the OVF files saved and boot a virtual machine using the OVF file. Perform the post install and registration steps as instructed in the previous section.

Note: To change the node from single-nic to multi-nic, you must first create a template, add a new NIC, and update the Certified Hardware option before performing factory reset and registration.


Volterra Concepts