The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Getting Started (CVP)
The login screen is displayed when you first connect to the application using a web
browser.
The CloudVision Portal (CVP) application is accessible after the CVP service has been
started on the appliance. The login screen is displayed when you first connect to the
application using a web browser. JavaScript must be enabled in the browser for the web
application to work.
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Accessing the CVP Login Page
To access the login page, point your browser to the CloudVision
Portal (http://HOSTNAME or https://HOSTNAME).The system opens the CVP login
page.
Figure 1. CVP Login Page
Enter login credentials in the CVP login section.
Figure 2. Login Section
Note:
The username and passwords required will depend on the
authentication method and accounts previously set up. Login using the username
and password created when CVP was installed. If you chose the local
authentication and authorization options, login initially using
cvpadmin for the username and password.
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Accessing the Home Page
All features including Devices, Events, Provisioning, Dashboards,and Topology are displayed
on the home panel.
Note: You must have required privileges to access a switch.
Figure 1. Home Page
The home page provides the following selections.
Devices: View all
devices across multiple topologies.
Events: View multiple
events on multiple devices.
Provisioning:
Hierarchical tree structure of the network is maintained here. All the
configuration and image assignment to the network switches are made via this
module.
Dashboards: View multiple metrics across
multiple devices. Select at least one metric and one device to begin.
Topology: View the
location of devices in individual topologies.
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Accessing Help Center Documentation
Starting with 2023.2.0 release, CloudVision provides you with in-product documentation
support called Help Center. The Help Center allows you to access detailed
information on CloudVision features and functionalities. Prior to 2023.2.0 release, Help
Center was available as a beta functionality.
You can access Help Center, which is represented by a (?) icon in a circle, in the
top-right corner of every CloudVision page as shown below: Figure 1. Help Center
When you click on the Help Center icon (?), the Help Center page for the corresponding
CloudVision screen is displayed. The main article explains the CloudVision screen you
are viewing and the workflow. Additionally, the Related Articles section displays
a list of related topics that are relevant to the main topic.
Navigating the Help Center
The Help Center provides various functionalities that allow you to navigate the
CloudVision portal and documentation. By default, the displayed Help Center article
corresponds to the CloudVision page on which you clicked the Help Center icon. That
is, the Help Center and the CloudVision UI are synchronized, by default. See image
below: Figure 2. Help Center Search Functionality
The Search function within the Help Center page allows you to search the Help Center
documentation using a keyword or term, where you can find articles non-related to
the current page. When you search for a term or a keyword, the Help Center displays
a list of articles related to the searched term. For example, while in the Devices
Inventory page, if you had searched for Studios, the Help Center displays the
Studios page as shown below: Figure 3. Help Center - Searched Page
If you want to go back to the article corresponding to the CloudVision UI, click on
the Location icon on the currently displayed Help Center pageas shown below: Figure 4. Help Center - Location Page
To open the CloudVision UI page corresponding to the searched Help Center article,
click on the arrow (→) next to the Help Center article title as below: Figure 5. Help Center -Relevant UI page
By default, the Help Center page opens as a drawer in the CloudVision portal. Click
on the pop-out icon on the Help Center page (see image below) if you want to open
the Help Center page as an independent window enabling you to move around the Help
Center so that it does not obstruct the CloudVision portal. Figure 6. Help Center - Help Pop Out
On the Help Center page, you can navigate forward and backwards through opened
articles and search menus as shown below: Figure 7. Help Center - Navigation
The Help Center also supports documentation feedback. You can click on the feedback
icon, enter your comments in the text box, and then click Continue. The feedback is
emailed to the CloudVision team at Arista Support. Figure 8. Help Center - Feedback
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Omnibox
The omnibox performs a search and displays results from all sections in CloudVision.
You must select a result for navigating to the corresponding CloudVision
section.
Click the search icon at the upper-right corner of the CVP screen to access the omnibox.
Figure 1. Omnibox
Note:
You can refine search results by adding more keywords to the query.
Omnibox hotkeys are Command ⌘ + K in Mac; and Ctrl +
K in Windows.
The Omnibox provides a variety of results classifying them by the section it belongs to,
an associated device or section name, and sometimes a description that explains what
kind of result it is.The list of potential search result modules are:
Devices
Matching devices
Sections of matching devices
Events
Matching event types
If a keyword matches a device hostname, it provides an option to view all
events on that device
Matching event configurations
Metrics
Matching metrics
Matching metric dashboards
Topology - Matching devices in topology
Provisioning - Matching Provisioning sections
Settings - Matching Settings sections
Note: Multiple results from the same section are grouped together.
CloudVision displays matching results from Devices and Topology
sections when a search is performed using theJPE
keyword.
Figure 2. Omnibox Search with JPE Keyword
Note:
If you select athens from the Devices section, CloudVision
displays the Device Overview screen of athens.
If you select athens from the Topology section, CloudVision
displays athens node in the Topology view.
If a search is performed with the athens keyword, CloudVision
displays results from Devices, Event, Metrics, and
Topology sections.
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Customizing the Home Screen and Dashboard Logo
CloudVision enables you to customize the visible options and dashboard
logo shown on the home page. You change the visible options and dashboard logo
by customizing them from the Settings page.
By default, no dashboard logo is selected. The image you select for
the logo appears in the dashboard next to the notifications icon.
Note: Note Any image you select for either the Home screen background or dashboard
logo must not exceed 200 KB for each image. In addition, the images must JPG,
PNG, or GIF.
Complete the following steps to customize the visible and
dashboard logo:
Login to CVP.
Click the gear icon at the upper right corner of the page.
Click
Settings in the left menu.
Select the required options provided under
Basic Settings,
Beta Features,
Cluster Management, and
Troubleshooting sections.
Figure 1. Default Settings for Home Page and Dashboard Logo
To customize the dashboard logo, perform the following steps:
Click the image box
next to the logo field.
In the Upload logo
dialog, Click
Select file.
Navigate to the
desired image, and click
Open. (The imported image is displayed next the Select
file box.)
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Accessing CV-CUE
You can access the CV-CUE service via either the CLI Access or the UI Access.
CLI Access
To log in to the wifimanager container using CLI, run the
/cvpi/apps/wifimanager/bin/wifimanager.sh cli
2>/dev/null command on the primary or the secondary node.
Figure 1. CLI Access
You can now run wifimanager commands. See the Wifimanager CLI Commands
for a list of wifimanager CLI commands and their descriptions.
UI Access
The URL to access the wifimanager UI is
http(s)://<CVP-IP>/wifi/wifimanager
is where CVP-IP refers to the actual CloudVision Portal (CVP)
IP/domain name.
The URL to access the cognitive Wifi UI is
http(s)://<CVP-IP>/wifi/aware where
CVP-IP refers to either the actual CVP IP or domain name.
For example, if the IP address of CVP is 10.12.3.4, then the URL to access
the wifimanager UI is https://10.2.3.4/wifi.wifimanager and the
cognitive Wifi UI is https:////10.12.3.4/wifi/aware.
You can access CV-CUE UI by clicking on the WiFi tab in the CVP UI, or you can access it
directly using the URLs of either wifimanager UI or Wifi UI.
Figure 2. UI Access
When you access the UI for the first time, you need to apply the CV-CUE service license.
Figure 3. CV-CUE Service License
Note:
For the license file, please write an email to
This email address is being protected from spambots. You need JavaScript enabled to view it.
Use the
ifconfig command on the CV root shell to get the
eth0 MAC addresses of the primary and secondary CV servers (you need not access
the wifimanager CLI for this). You need to include both these MAC addresses
when you email support to request a license. One license is generated for the
two (primary and secondary) MAC addresses.
Once you apply the license, you must log in to the CV-CUE UI using the following default
credentials:
Username:
admin
Password:
admin
You can then change the password and add other users.
Note: You can now also connect Arista access points to the server.
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
CloudVision Portal (CVP) Setup
CloudVision Portal (CVP) can be run on ESX or KVM hypervisors. Before
you can begin using the CVP, you must complete the CVP setup process which,
involves the following:
There are two different deployment procedures. One for deploying
CVP on ESX, and one for deploying CVP on KVM. After you complete the deployment
procedures, you then configure CVP. The deployment procedures are:
There are two configuration methods for the CloudVision Portal
(CVP): shell-based and ISO-based. Both of these methods eliminate the need to
directly modify system and CVP configuration files. This simplifies the setup
process and reduces the potential for issues.
The configuration methods enable you to configure CVP in both
single-node systems and multi-node systems. The configuration methods are:
The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.
Deploying CVP OVA on ESX
Deploying the CVP OVA file should be the first step in any setup. After the CVP OVA file is
deployed, you can choose between the two configuration methods for CloudVision
Portal (CVP).
Note: Arista does not support VMware Snapshots on CloudVision virtual machines. For more
information, refer to VMware vMotion and Snapshot Support.
Pre-requisites:
Use of the Deploy OVF Template requires the VMware Client Integration
plugin, which is not supported by the Chrome browser after versions 42.
The OVA file can be deployed as a VM in a VMware environment by using the drop
menu under the Actions heading and selecting Deploy the OVF template.
Note: For multi-node setups, the following steps must be completed once for each
VM, three times to launch three VMs.
Figure 1. Deploy the OVF template
Having selected the Deploy OVF Template option, VCenter will
prompt for the location of the OVA file; this can be either on a local hard
disk, network share, or Internet URL. The location of the OVA file should be
entered or selected.
Figure 2. Location of the OVA file
Click
Next to go to the next task.
Type the name for the VM in the Name field and select the folder for the
OVA file.
Figure 3. Select name and folder location for the VM file
Click
Next to go to the next task.
Select the resource where you want the deployed template (OVA file) to be run.
Figure 4. Select the resource
Click Next to go to the next task.
Review the OVF template details.
Figure 5. Review OVF template details
Click
Next to go to the next task.
Select the storage location where you want the files for the deployed template
to be stored.
Figure 6. Select the destination storage
Note:
It is recommended to select Thick provision lazy zeroed under the
Select virtual disk format dropdown menu.
Click
Next to go to the next task.
Setup the networks that the deployed template should use.
Figure 7. Setup the networks
Click
Next.
VCenter loads the OVA and displays the configuration settings.
Review the configuration settings, and click
Finish to accept and save the configuration.
Figure 8. Select the Finish button to accept these settings
CloudVision includes the following infrastructure components that are used as the basis
for the application services and database. This is not an exhaustive list, but the key
components as it relates to this topic.
Hadoop - open source framework from Apache that is used to store and process
large datasets distributed across a cluster of servers
Hbase - open source database from Apache that runs on Hadoop cluster
Zookeeper - centralized service for maintaining configuration information,
naming, providing distributed synchronization, and providing group services
The CloudVision database (hbase/hadoop) is deployed across the three nodes within the
CloudVision cluster. The integrity of this database is critical to the correct
functioning of CloudVision, and thus, there are specific requirements on the hypervisor
and storage for these virtual machines forming these nodes.
VMware Snapshots
Within the CloudVision infrastructure, data is constantly being written to Apache
hadoop by all nodes. Disk snapshots used by VMware have no hooks into the hbase
quiesce states, meaning a snapshot of a disk state would almost always be
inconsistent and lead to database corruption during a restore process. This results
in a snapshot having no meaningful use as a restore point due to the nature of the
database, which is typical for database application performance using VMware
Snapshots (VMware reference).
VMware Snapshots are very I/O intensive, leaving almost no I/O for the virtual
machines during the snapshot process. Impact on resources, such as disk, can lead to
hbase and zookeeper failures. These symptoms are evident in multiple cases where the
support team has identified snapshots that were in progress before failures.
VMware does not recommend using VM Snapshots as backups (https://kb.vmware.com/s/article/1025279), therefore other backup mechanisms are recommended by Arista as outlined below.
Note: For these reasons, Arista does not support VMware Snapshots on CloudVision
virtual machines.
VMware vMotion
CloudVision supports VMware vMotion under specific configuration and operational
criteria as follows:
The virtual machine disks are shared between the source and target ESXi host
Latency between ESXi hosts is less than 5ms
Only one CloudVision node may be vMotioned at a time
Note: CVP 2020.1.0 and future releases support host-to-host vmotion where the
storage is shared between ESXI hosts. Only one host can be in vMotion at a given
time.
Backup Solutions for CloudVision
Daily backups of the CloudVision provisioning data are automatically scheduled to be
taken at 2AM UTC. This backup file is stored locally on the CloudVision cluster.
Common practice by customers is to schedule a copy of this backup file from the
CloudVision cluster to some external data store.
There is an example script to help automate the copying of the backup file
available on the Arista Github site (link).
CloudVision telemetry data received from switches is replicated between the
CloudVision clusters. In the event a single node becomes unavailable and a new node
is added to the cluster, this telemetry data is replicated to the new node.
Arista EOS with the Streaming Telemetry agent (TerminAttr v1.7.1 and later) supports
establishing connections to multiple CloudVision clusters. This enables the user to
send the telemetry data to a backup CloudVision instance, to maintain an up-to-date
redundant store.
Once you complete these tasks, you can configure the CVP VM.
Downloading and extracting the CVP KVM tarball (.tgz archive)
The first task in the deployment process involves downloading and
extracting the CVP KVM tarball. The tarball is a .tgz archive that contains:
The CVP VM
Disk images for the CVP
application
The files used to
configure CVP VM.
You download the tarball to the host server that is configured for
KVM. The files contained in the .tgz archive include:
Filename
Description
1
disk1.qcow2
VM disk image for the CVP application.
2
disk2.qcow2
Data disk image for the CVP application.
3
cvpTemplate.xml
A template for creating the XML file for libvirt domain
specification.
4
generateXmlForKvm.py
A script for generating the CVP VM definition XML based on
the XML template.
5
createNwBridges.py
A script for creating the network interfaces for the CVP
VM.
Complete the following steps to download and extract the CVP VM .tgz
archive:
Go to the Arista software downloads webpage and download the CVP
VM tarball (cvp-<version>-kvm.tgz) to the host
server set up for KVM.
Extract the tarball
(cvp-<version>-kvm.tgz).
The following example shows extracting the CVP KVM .tgz archive.
[arastra@kvm1 vms]# cd cvpTests
[arastra@kvm1 cvpTests]# ls
cvp-2022.3.0-kvm.tar
[arastra@kvm1 cvpTests]#tar -xvf cvp-2022.3.0-kvm.tar
addIsoToVM.py
createNwBridges.py
cvpTemplate.xml
disk1.qcow2
disk2.qcow2
generateXmlForKvm.py
Creating Virtual Bridge and Network Interface Cards (NIC)
The second task in deploying CVP for KVM involves creating the bridges and interfaces
that provide network connectivity for the CVP VM. You use the
CreateNwBridges.py script you extracted in the previous
task to create the required bridges and interfaces.
You have the option of deploying CVP with either two bridge interfaces or a single
bridge interface.
Two interfaces (the cluster bridge
interface and the device bridge interface).
Single interface (the device bridge
interface).
Complete the following steps to create the network interfaces for CVP KVM
connectivity:
(Optional) Use the ./createNwBridges.py -help command to
view a list of all the parameters available in the script.
Note: Install the net-tools library using the yum -y install
net-tools command before running the script.
Use the ./createNwBridges.py to create the device bridge (or
bridges) and interfaces needed.
The figure below shows an example of creating a single device bridge for a single-node
deployment.
Figure 1. Creating a device bridge (single node deployment)
(Optional) Use the brctl show command to verify that the
bridges were successfully created.
(Optional) Use the ip address show command to verify that
the IP addresses have been allocated. In this example the one IP address for the
br1 bridge.
The following output is an example of verifying bridge creation and IP
address allocation. In this example, a bridge br1 was created, and one IP
address has been allocated for the bridge.
[arastra@kvm1 ~]# ip address show br1
6: br1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000
link/ether d0:94:66:4f:56:48 brd ff:ff:ff:ff:ff:ff
inet 172.31.6.78/16 brd 172.31.255.255 scope global br1
valid_lft forever preferred_lft forever
inet6 fe80::d294:66ff:fe4f:5648/64 scope link
valid_lft forever preferred_lft forever
[arastra@kvm1 ~]# ip route show
default via 172.31.0.1 dev br1
172.31.0.0/16 dev br1 proto kernel scope link src 172.31.0.1
[arastra@kvm1 ~]#
Generating the XML file that defines the CVP VM
The third task in deploying CVP for KVM involves generating the XML
file that you use to define the CVP VM. You use generateXmlForKvm.py script and
the cvpTemplate.xml file you extracted previously to generate the XML file you
use to define the CVP VM.
The
cvpTemplate.xml file is a template that defines
wildcard values that are filled by the other parameters that are specified when
you execute the script.
Complete the following steps to generate the XML file:
(Optional) Use the python generateXmlForKvm.py -help command
to view a list of all the parameters available in the script.
Run the python generateXmlForKvm.py script using the XML
template (cvpTemplate.xml) as one of the inputs.
Generation of XML file used to define CVP VM shows an example of an
XML being generated that can be used to define a CVP VM named cvpTest. The
generated XML file is named qemuout.xml.
Figure 2. Generation of XML file used to define CVP VM
Defining and Launching the CVP VM
The last task in deploying CVP for KVM is to define and launch the
CVP VM. You use the XML file you generated in the previous task to define the
CVP VM.
Complete the following steps to define and launch the CVP VM:
Run the
virsh define command to define the CVP VM (specify
the generated XML file).
Run the
virsh start command to launch the newly defined
CVP VM.
Run the
virsh console command to attach (connect) to the
CVP VM console.
Defining and Launching the CVP VM shows an example of the use of the commands to
define and launch a CVP VM named cvpTest. The XML file
used to define the CVP VM is named qemuout.xml.