KVM Installation🔗

Introduction🔗

The Verity management and orchestration system is comprised of three functional components, all of which are instantiated as Virtual Machines (VMs). This document describes the installation and configuration of these VMs within a KVM environment.

Resource Calculator🔗

Use the Verity VM Resource Calculator to determine system resources.

Virtual Machine Overview🔗

Verity’s three VM functional components:

Virtual Machine	Function
Virtual Network Commander (vNetC)	Orchestration logic, GUI hosting, northbound RESTful API, and databases.
Software Defined LAN Controller (SDLC)	The SDLC VM is comprised of a series of containers that map one-to-one to the managed switch devices. Network discovery, device provisioning, and network assurance. The SDLC serves as the abstraction layer between the managed switch and the vNetC by translating the native management protocols into the vNetC’s NETCONF interface and Yang model.
Monitoring	The Monitoring VM is comprised of various containers that collect, process and display the network device details that are managed by Verity.

Topology Overview🔗

Below is the basic VM and hardware topology for reference:

Recommended Network Management Architecture🔗

Each system requires a management subnet that can support 5 system IP addresses as well as 3 IP addresses per managed switch. The breakdown is as follows:

IP address Allocations for Management Network	Component	Allocation
Verity System components	vNETC LAN side, SDLC, ACS, GuiA, Monitoring	5 Static Addresses
Managed Switches	Verity Switch Controller	1 Dynamic Address per switch
Managed Switches	Switch in ZTP Process	1 Dynamic Address per switch
Managed Switches	Switch Post ZTP Process	1 Static Address per switch

The orchestration platform (vNETC) is configured on the customer’s network with one static IP address to be accessed by users.

The following diagram shows the recommended management network architecture. Variations are possible based on individual customer’s network needs. A second diagram follows with a version showing only one connection to the vNETC.

Prerequisites🔗

vNetC
1. Resolvable, fully qualified domain name
2. Static IP address, gateway, DNS servers
3. Valid Verity license
SDLC
1. IP addressing per table above
  
  NOTE: Must be routable to the vNetC
Devcice Controllers (within SDLC)
1. IP Addressing per table above.
  
  NOTE: The diagram above shows that the controllers are bridged to NIC 2 of the SDLC. The IP MUST be on the same VLAN/subnet as the SDLC.
Monitoring
1. IP Addressing per table above.
  
  NOTE: Must be routable to the vNetC
KVM
1. Compute resources meeting Verity requirements based on the number of switches being managed. See Resource documentation for computing CPU and memory needs.
2. Virtual Switch
  1. The vNetC, SDLC and Monitoring should be on the same bridge or at minimum they must be routable.
Routable or switched network between Verity components and managed switching devices
1. If using a router or firewall between Verity and the switches, the following ports must be allowed to pass.
  1. Port 8080 for gNMI
  2. Port 80 - HTTP
  3. Port 443 - HTTPS
  4. Port 22 - SSH
  5. Port 161 - SNMP

Obtaining the vNetC and SDLC VM Images and Files🔗

Obtain the following files from BE Networks:

Description	Filename Example	File Type	Notes
vNetC VM Image	vNetC-x_x_x_x.qcow2	KVM qcow	Resources including vCPU and memory should be adjusted based on resource needs documentation. Networking will need to be altered to the correct bridge names used in the server
vNetC “core” Upgrade	core-x_x_x_x- full.tar	Tarball	vNetC needs to be updated via UI SD-Admin immediately after configuration and boot
SDLC VM Image	SDLC-x_x_x_x.qcow2	KVM qcow	Resources including vCPU and memory should be adjusted based on resource needs documentation. Networking will need to be altered to the correct virtual switch names used in the server
Firmware Upgrade Package	firmware-x_x_x_x.tar	Tarball	SDLC should be upgraded via system upgrader immediately after configuration and boot
Monitoring VM Image	verity-monitoring_x.x.x.qcow2	KVM qcow	Resources including vCPU and memory should be adjusted based on resource needs documentation. Networking will need to be altered to the correct bridge names used in the server
Monitoring Upgrade Package	verity-monitoring_x.x.x.tar	Tarball	Monitoring should be updated via UI AS-Admin immediatly after configuration and boot
License	license.cms or sitexxxxx.tar	License file	Is uploaded using UI
XML Parameters	vnetc.xml, SDLC.xml and monitoring.xml	xml	Default files are provided and are edited during the installation process

Creating the Virtual Machines🔗

The following instructions explain how to create virtual machines for both the vNetC and SDLC.

Copy vnetc, sdlc and monitoring qcow and xml files to host (root directory):
1. vnetc.qcow2
2. SDLC.qcow2
3. monitoring.qcow2
4. vnetc.xml
5. SDLC.xml
6. monitoring.xml
Make sure you have the bridge name from host for VMs: `
```
nmcli connection show
```
`

Edit xml files (vnetc.xml, SDLC.xml and monitoring.xml) to have bridge name on the correct interfaces, number of CPU, and number RAM needed for each VM. Example:

`

<memory unit='KiB'\>**8388608**\</memory\>

<currentMemory unit='KiB'\>**8388608**\</currentMemory\>

<vcpu placement='static'\>**8**\</vcpu\>

<interface type='bridge'\>

<source bridge=**'br0'**/\>

<interface type='bridge'\>

<source bridge=**'br1'**/\>

<model type='virtio'/\>

`

Adjust xml file for Linux variants

For Centos and Redhat

`

<devices>
<emulator>/usr/libexec/qemu-kvm</emulator>

<os>
<type arch='x86_64' machine='pc-i440fx-rhel7.6.0'>hvm</type>

`

For Ubuntu

`

<devices> 
<emulator>/usr/bin/qemu-system-x86_64</emulator>

<os>
<type arch='x86_64' machine='pc-i440fx-jammy'>hvm</type>

`

Move qcow (vnetc, SDLC and monitoring) to /var/lib/libvirt/images directory
Define VMs using the edited xml files:

virsh define vnetc.xml

(Domain 'vnetc' defined from vnetc.xml)

virsh define SDLC.xml

(Domain 'SDLC' defined from SDLC.xml)

virsh define monitoring.xml

(Domain 'monitoring' defined from monitoring.xml)
Set VMs to autostart on boot:

virsh autostart vnetc

(Domain 'vnetc' marked as autostarted)

virsh autostart SDLC

(Domain 'SDLC' marked as autostarted)

virsh autostart monitoring

(Domain 'monitoring' marked as autostarted)
Start vnetc VM

virsh start vnetc

(Domain 'vnetc' started)

Configure the vNetC from the Console🔗

This step requires you to configure the vNetC with an IP address and Fully Qualified Domain Name (FQDN). To do so, you need to open the VM console: virsh console vnetc

The VM console appears. The vNetc initialization may take several minutes. While waiting you can press Enter and wait for login prompt.

Login to the vNetC with username admin and password vnc1234. Enter a new password if prompted. If not prompted for the password, you can continue to use the default password or change it with the passwd command.
In the Admin Menu, select Network Configuration. Press Enter.
Select FQDN (Fully Qualified Domain Name). Press Enter and set to the desired Fully Qualified Domain Name. If the field is prepopulated, it is required that you replace the default text with your own FQDN.
Verify that WAN IP DHCP is disabled. If WAN IP DHCP is enabled, disable it using the menu.
Select WAN Static IP Settings, press enter.
- Enter: IPv4 Address and subnet in CIDR format (x.x.x.x/##) where x.x.x.x is the IPv4 address and ## is the CIDR subnet mask prefix
- Enter: Default Route (Gateway)
- Enter: DNS Server 1
- Enter: DNS Server 2 (if required)
Return to the network configuration menu.
Save Settings

Follow the prompt and the VM will reboot with the new settings configured.

Install the License (required) and Upgrade to the Latest vNetC Core Software🔗

Use Chrome Web Browser to access the vNetC IP address that was just configured.
At the login prompt enter username admin and the administration password configured in the menu during installation. These are the credentials you entered in step 3 of Configure the vNetC from the Console.
When the window appears, record the information on the Licensing tied to line. Provide this information to BE Networks to obtain your license file.
After you obtain your license.cms file you are required to upload it to the application. In the License window select data center or campus (depending on your system). Use the drag and drop palette to upload the file or browse for the file. The license file may also be embedded in a \<filename>.tar file and this can also be directly imported and the system will extract the license.cms file.
After you upload the file make sure a success message is presented.
Click the button that says Complete.
After the Verity window has fully completed populating select the Administration tab.
Select Administration/Software Packages and click vNetC Packages.
Using the Browse Files (or drag and drop) field, import the vNetC Core Upgrade file provided by BE Networks.
When the process is complete you are presented with a success message.
Click the Deploy button.
When prompted to continue, click Yes. The software updates.

Temporary Error Message

You may see an error titled Fatal Error WebSocket Error: Connection lost -2 appear, this is normal. The browser may temporarily say that the site cannot be reached. When the process is done the landing page will render.

If you see a migrations prompt click Accept. .
If you see a tan prompt that says GuiA not attached, no GuiA Switch, clear the message by clicking it.
The display should look like the following image:
Go back to the VNC Console in VMware and type poweroff in the CLI. This will cleanly shutdown the VNC.

Configure the SDLC from the Console🔗

The SDLC must be configured with a Static IP address and the vNetC FQDN.

Select the SDLC from the VMWARE ESXi interface and click the Console tab.
Select Open browser console.
The console appears.

DHCP Error Messages

During the following process DHCP errors may appear. These can be ignored.
Press Enter to get the login prompt, enter username: admin and password: admin.
At the command line interface (CLI) press Enter to see a list of options.
Select Admin and press Enter.
Type Wizard and press Enter.

Note

If vNetC and SDLC (GuiA, ACS) are on different subnets, it is recommended to have three consecutive static IP addresses on the same subnet for GuiA, ACS and DHCP. However, if vNetC is on the same subnet as GuiA, ACS and DHCP, it is recommended to use four sequential IP addresses.

Prompt	Answer
Enter new hostname	SDLC
Enter MGMT IP or enter 'd' to use DHCP	Enter management IP
Enter URL connection protocol	http
Enter default gateway IP/Prefix in CIDR format	Enter the default gateway IP address
Enter ACS IP or type 'none' to remove config	Enter IP
Enter vNetC FQDN or IP	vNetC IP address
Enter DNS server	Enter DNS server IP
Enter Comma separated NTP server(s)	Enter vNetCs IP address
Enter ACS url	Press Enter or Enter a different url

Type y and press Enter
Reboot is required for any changes to take effect. In the console, type reboot and press Enter.

Power On the vNetC🔗

Open the GUI and select Administration in the lower left. Click the Network tab and select the Settings tile.

Set up the Management VLAN used to access the Management network. This field is required even if your management switches are untagged connections. Note: If untagged select “Managed on Native VLAN” checkbox.

In Permissible IP Address Ranges on Managed Devices enter the relevant IP address range (IP address and Mask).

Click the checkbox icon to save your settings.

Go to the Topology navigation window. If a beige notification box appears in the lower right, click it to close it.

Wait until the process is finished. The application landing page resembles the image below when all processes have been completed.

Update SDLC🔗

In Topology/Topology uncheck the box titled Disable Upgrades .
Click the Administration tab.
Click Software Packages.
Double-click Image Packages.
Select and place the SDLC Binary Firmware Upgrade firmware file on the Drag & Drop area or use the Browse Files button to select the file.
When uploaded, you are prompted with a green success message.
Deploy the upgrade by clicking the Deploy button.
A validation message appears. Click Yes.
Wait while the package is applied.
Click the Administration icon then click the VNFs tab.
Double click the SDLC section.
Double click the box with the title of SW Version.
Set the Target Package field to the Firmware version .
Click the Save button ().
Click Yes to the validation message.
Let the process complete.
When the window appears the initial state of System Applications are offline. When the System Applications come online their LED icons render green. This may take up to 5 minutes.

Site Certificate🔗

In order to avoid having to accept the self signed certificate delivered with the system you will need to add a server.pem file to the system. This will need to be obtained from your internet domain administrator.

Go to Administration/Certificates/Vnetc Server Certificates
Click on vNetC Server Certificate box.
Drag and drop the server.pem file.

The installation and updates of Verity for Cloud software components is now complete.

Create the Monitoring VM 🔗