VIRL 1.2.83 (October 2016 Release)

     

    IMPORTANT - Start Here

    VIRL October (1.2.83) release consists primarily of bug fixes and begins to lay the groundwork for future releases.

    NOTE: If you are running VIRL 1.2.64, 1.1.1, or 1.0.26 today, you can perform an in-place upgrade now.

    In-place upgrade from VIRL versions below 1.0.26 is NOT supported. If you are running an earlier release, you MUST deploy a new image.

    Availability:

    Installation images for VMware Workstation, Workstation Player, Fusion Pro, ESXi and Bare-metal systems (ISO) are available now.

    Please see the section below on Self-Service Download for instructions on how to obtain the appropriate installation image.

    ATTENTION: SUPPORT FOR VIRL v1.2.64 WILL END ON 31 December. PLEASE UPGRADE AS SOON AS POSSIBLE!

    Online training material is available - this is designed to help get you started and productive quickly - http://virl-dev-innovate.cisco.com/tutorial.php - NOTE, this includes video walkthroughs - ensure that your browser supports H.264 video and any plugins are enabled.


    New Features

    This release focuses more on bug fixes and stability. It also begins to lay the groundwork which will enable us to build a more robust and feature rich versions. No new features are introduced with this release, just a few minor enhancements.

     

    Enhancements

     

    Openstack Networking

    • Changing the ext-net subnet should no longer fail even with custom projects present. The L3 SNAT router gateway ports are now torn down and re-created automatically for all projects.

     

    VIRL Core

    Ostinato Drone

    • Updated template for ostinato LXC for improved packaging of Ostinato version 0.8.
    • Automatically create a port forwarding rule to the ostinato drone from the VIRL host’s public IP, when the node has access to either Flat or Flat1 network. An user can statically assign the TCP port via the Ostinato's Node properties pane. A new section "Port Forwarding" is now available when using VM Maestro 1.2.7dev474. This feature is set via the 'tcp_port' extension.

    LXC - Linux Containers

    • Updated template for small LXCs (ostinato, iperf, routem, sshd, mgmt) to include a ‘rosh’ command for a simple root shell.
    • Fixed templates for small LXCs to prefer binaries and libraries included in the image over those installed on the VIRL host.

    STD

    • The simengine launch and node-start APIs will now prevent a simulation from starting if the vCPU resources required by the simulation are not available.  This check is similar to the existing check that VIRL performs to ensure that there is sufficient virtual memory available before launching a simulation or starting a node. 
    • The STD call openstack-create-port works for users without an endpoint (e.g., uwmadmin).
    • Fixed volume attachment failures (i.e. use of vmVolume attribute on a topology node, or attachment at runtime with STD call simengine-attach-volume)

     

    UWM

    • Fixed port range checks for live traffic captures.
    • Create traffic capture dialog pre-checks 'Start capture right away'
    • Removed refresh button from Simulation Details page, which already updates itself periodically.
    • My Simulations page is now automatically updated.
    • Improve page redirects between My Simulations, Simulation Details, and Overview pages.
    • Custom colors for themes are loaded for graphs on the Traffic Counters page.
    • Fixed background color for date and time picker when using the dark theme.
    • Allow or Hide applicable functions for admin users viewing Simulation Details of other users.
    • Stricter checks for hostname validaton in the UWM's System > Configuration page.
    • Removed field for unused SSH host private key from UWM user settings.
    • Special ports owned by L3 SNAT routers [network:router_interface and network:router_gateway] are removeable via VM Control.

     

    ANK

    • VIRLDEV-4605: user: fix issue with internal API attribute call for external BGP.
    • Fixed issue with VTP which caused errors when generating configurations where the topology consisted of only L2 devices.
    • VIRLDEV-1838 fixed typo in warning message.

    Live Visualization

    • VIRLDEV-3393: (user-reported) add option to connect to server management IP.
    • Fixed popover ordering.
    • Fixed the pre-selected interface when opening the UWM Create Traffic Capture form.

     

    VM Maestro

    • VIRLDEV-2299: Interface selection now works on Win10 touchscreen computers. This bug impacted Win10 users who unchecked the "Associate new connections with interfaces silently" in the Preferences > Topology Editor dialog.  With that preference setting, when clicking on a node with the Connection tool to draw a connection, the interface selection pop-up dialog was shown, but clicking on an interface in the list did not work, and a connection would not be created.

    • VIRLDEV-4535: When editing a .virl file with the XML Editor, adding a vmVolume attribute to a node no longer causes existing configs in the file to lose newlines.
    • VIRLDEV-4547: The topology editor now permits the user to drag a site to a new position. Sites may be dragged both when expanded and when collapsed.
    • VIRLDEV-4566: Removed the "breadcrumb" widget at the top of the topology editor. This approach to navigating into sites is no longer used in VM Maestro version 1.2.7 and later.  Instead, users may expand sites (and nodes) to see their contents in the main canvas by double-clicking on the figure or by using View > Expand All.  Since the breadcrumb widget was no longer needed and could actually cause problems, it was simply removed.

    • VIRLDEV-4667: VM Maestro no longer idles at 100% CPU on Ubuntu 16.04. This problem was caused by a combination of VM Maestro's current widget library version and GTK 3, which is the default on Ubuntu 16.04.  Fixed for now adding an option to VMMaestro.ini to force Linux to fall back to GTK 2.x.

    • VIRLDEV-4666: Field added to the the Properties view for Ostinato drone port forwarding.

     

     

    How to Upgrade

     

    Self-Service Download

    Every registered VIRL user is now able to download the OVA and ISO images from https://virl.mediuscorp.com/my-account/. The new 'Download VIRL' link on this page will take you through to a self-service selection page where you are able to select the image you would like.

    self-service.png

    Please note that the downloads are large. The use of download manager application is strongly recommended.

     

    In-Place Upgrade Instructions

    NOTES:

    • You must have communication to a Cisco salt-master and have a valid license key in order to perform the upgrade.
    • Once you have installed the latest VIRL package set, two new LXC images will be presented and available for installation. If you used the 'Full' upgrade option, these images will already be installed. If you have used the 'Core' upgrade option, you must use the 'LXC Image upgrades' section of the 'VIRL Software' page. Select the new images and press the 'Start installation' button.

    Known Issues:

    • Upgrade fails due to unknown version - From UWM, overview reports 'Release' as N/A. If this happens, you need to run the commands from your VIRL server console as outlined in the answer of this post: VIRL Upgrade Problem; once you have verified that UWM is reporting the appropriate version, you may continue with the in-place upgrade.
    • New deployment from ISO v1.2.84 shows upgrade available - If user deploys a new VIRL server using the current release, UWM will report an upgrade is available. Users should ignore the warning and follow workaround described in this post:  VIRL Upgrade Problem; but set the version to 1.2.83.
    • Upgrade to 1.2.83 breaks telnet connections to simulation nodes - During upgrade, the process incorrectly sets an environmental variable for the VIRL server. This causes the system to initiate telnet sessions to wrong VIRL server interface, and VM Maestro returns error of 'connection refused'. Please read workaround in this thread: Re: Upgraded to  1.2.83 now I cannot telnet into nodes FIXED! Only applies to users who upgraded prior to Oct 31, 2016.
    • Upgrade to 1.2.83 prevents simulations that used to run from launching - ATTENTION: since the vCPU check during simulation launch was added in this release, you may find that simulations that you used to be able to launch in previous VIRL releases are prevented from launching in version 1.2.83+.  If you see an error, such as Exceeded quota(s): {'VCPUS': {'required': 14, 'available': 12.0}} when you launch a topology simulation, then you may need to increase the vCPU Overcommit Value in the UWM.  The default value is 3.0, but depending on the topologies that you simulate, higher values should be safe, especially if you are simply increasing the value to launch a topology that you were able to simulation successfully in the previous release.  Users have reported that a vCPU Overcommit Value of 6.0 is working well, especially if you are primarily work with IOSv, IOSvL2, and Server nodes.

     

    Existing VIRL 1.0.26 Users

    READ THIS - You are able to upgrade to the latest release by logging into the User Workspace Managment (UWM) interface as 'uwmadmin'.

    From the menu on the left-hand side of the page, select 'VIRL Server'/'VIRL Software'. After a ~60 seconds a list of available images will be presented. New packages will be shown as available for installation with a tick-box present in the 'Install Y/N' column. Select the package and press the 'Start installation' button. The system will now perform the first stage of the upgrade.

    Once completed, from the menu on the left-hand side of the page, select 'VIRL Server'/'System Upgrade'. A list of available upgrade options (Core, Full or Advanced) will be presented. At a minimum, select the 'Core' upgrade, enable maintenance mode and press the 'Start installation' button.

    Updated Virtual machine images are available for installation, either by using the 'Full' or 'Advanced' upgrade options or by selecting from the 'Cisco VM image upgrades' section of the VIRL Software package.

    The upgrade will not only install the latest VIRL software set but will also update critical components of the Ubuntu operating system. The time taken will depend on your network connectivity.

    Progress can be monitored by expanding the 'vinstall upgrade' panel on the 'System Upgrade' page.

     

    Watch the video: VIRL 1.0 to 1.2 Upgrade - YouTube

     

    Existing VIRL 1.2.x and 1.1.x Users

    READ THIS - You are able to upgrade to the latest release by logging into the User Workspace Managment (UWM) interface as 'uwmadmin'. From the menu on the left-hand side of the page, select 'VIRL Server'/'System Upgrade'. A list of available upgrade options (Core, Full or Advanced) will be presented. At a minimum, select the 'Core' upgrade, enable maintenance mode and press the 'Start installation' button.

    Updated Virtual machine images are available for installation, either by using the 'Full' or 'Advanced' upgrade options or by selecting from the 'Cisco VM image upgrades' section of the VIRL Software package.

    The upgrade will not only install the latest VIRL software set but will also update critical components of the Ubuntu operating system. The time taken will depend on your network connectivity.

    Progress can be monitored by expanding the 'vinstall upgrade' panel on the 'System Upgrade' page.

     

    Watch the video: VIRL 1.0 to 1.2 Upgrade - YouTube

     

    Existing VIRL 1.2.x and 1.1.x Cluster Users

    READ THIS - You are able to upgrade to the latest release by logging into the User Workspace Managment (UWM) interface as 'uwmadmin' on the Cluster CONTROLLER node. From the menu on the left-hand side of the page, select 'VIRL Server'/'System Upgrade'. A list of available upgrade options (Core, Full or Advanced) will be presented. At a minimum, select the 'Core' upgrade, enable maintenance mode and press the 'Start installation' button.

    Updated Virtual machine images are available for installation, either by using the 'Full' or 'Advanced' upgrade options or by selecting from the 'Cisco VM image upgrades' section of the VIRL Software package.

    The upgrade will not only install the latest VIRL software set but will also update critical components of the Ubuntu operating system. The time taken will depend on your network connectivity.

    Progress can be monitored by expanding the 'vinstall upgrade' panel on the 'System Upgrade' page.

     

    At the end of the upgrade process, the cluster controller will be rebooted. Once it has rebooted, you need to reboot each one of the compute nodes within your cluster. To do this:

      1. Log in to UWM on the Cluster Controller node as 'uwmadmin'
      2. Navigate to the 'VIRL Server / System Tools' panel and select 'System console'
      3. For each one of the compute servers in your cluster, issue the following command sequence:
        1. ssh virl@compute[1-4]
        2. sudo reboot
      4. Once all compute nodes have rebooted, issue the following command in the 'System console' window:
        1. nova service-list | grep compute
        2. The following output should be reported:

    2016-07-01 11.13.59 am.png

     

    Upgrade VIRL Client (VM Maestro) required

    You must update VM Maestro to version 1.2.7 Dev-474 or later. Older releases are not supported with VIRL 1.2.83. Download the new VM Maestro client from "http://your.VIRL.server.IP/download". Once installed, update the available node types as follows:

    1. Launch VM Maestro
    2. Select 'File / Preferences / Node Subtypes'
    3. Press 'Fetch From Server'
    4. Press 'Apply'

     

    Performing a New Installation

    Please use the installation guides posted at http://virl-dev-innovate.cisco.com/ and select the instructions appropriate for your platform.

    Deployment instructions for:

     

    VIRL Server Component Versions

    This release contains the following component versions:

    • Openstack Kilo
    • VM Maestro 1.2.8 Build Dev-474 (NEW)
    • AutoNetkit 0.23.5/0.23.9 (NEW)
    • Live Network Collection Engine 0.11.6
    • VIRL_CORE 0.10.28.7 (NEW)

     

    Cisco Platform VMs

    • IOSv - 15.6(2)T image
    • IOSvL2 - 15.2.4055 DSGS image
    • IOSXRv - 6.0.1 image
    • IOS XRv 9000 - 6.0.1 image (NOT BUNDLED - visit IOS XRv 9000 - more info (updated 1/12/16) for details)
    • CSR1000v - 16.3.1 XE-based image
    • NX-OSv 7.3.0.1
    • ASAv 9.5.2
    • Ubuntu 14.4.2 Cloud-init

     

    Linux Container Images

    • Ubuntu 14.4.2 LXC
    • iPerf LXC
    • Routem LXC
    • Ostinato-drone 0.8 LXC (NEW)

     

    Important Notes

     

    Bare-Metal Installation Image (.ISO)

    The .ISO installer image will install the Ubuntu 14.4.3 operating system as well as all of the software stack for VIRL. Due to space issues, the CSR1000v image is not included in the .ISO installation image. Once VIRL has been installed, your salt-key has been applied and communication established to the Cisco salt-masters, you will be able to install the CSR1000v 3.17 image from the VIRL Software panel in the User Workspace Management interface. Use a Web-browser to log into the User Workspace Management interface and select the 'VIRL Software' tab from the panel on the left. Select the CSR1000v and then press 'Start Installation'.

    Salt Master Settings

    Once you have installed VIRL, apply for VIRL license key as per the installation instructions. You should enter at least two salt masters, picking a number between 1 and 4. Do not enter the same number twice! You can list up to four salt-masters. When specifying multiple salt masters, separate each one with a comma followed by a space; as shown below. Update you salt-master list if needed.

    US

    us-1.virl.info, us-2.virl.info, us-3.virl.info, us-4.virl.info

    EU

    eu-1.virl.info, eu-2.virl.info, eu-3.virl.info, eu-4.virl.info

     

    Caveats

     

    • CSR1000v 16.2.2 - this image CANNOT be used with VIRL and has been deferred and is no longer available.
      Workaround: none
    • CSR1000v 16.2.1 - this image CANNOT be used with VIRL due to a defect CSCuz09110. This image has been deferred and no longer available.
      Workaround: none
    • VIRLDEV-3525 - Scroll bar on Preferences > Node Subtypes dialog doesn't work on OS X 10.11
      When using VM Maestro on Mac OS X 10.11.x, the scroll-bar that should be displayed inside the Node Subtype list panel, may be missing.
      Workround: Open the Mac System Preferences pane. Under 'General' select 'Show scroll bars' and set to 'Always'.
    • Bare-metal installation (ISO) - when following the installation instructions and selecting 'LVM' for partition management, the system will report that there is insufficient disk space and that you should increase the size of the /boot partition. THIS MESSAGE CAN BE IGNORED. Press the 'continue' button. The installation will proceed without issue.
    • Following an upgrade from 1.0.11 to 1.0.26, the following message may be observed when trying to start up a simulation:
      (ERROR) [Feb/04/2016 21:14:51] Failed to start simulation "LXC_demo-clsv9_": local variable 'message' referenced before assignment
      Workaround: Reboot your VIRL server and re-try simulation.
    • IOSv 15.6(2)T - On boot-up the following message may be observed:%SYS-3-CPUHOG: Task is running for (1997)msecs, more than (2000)msecs (0/0),process = TTY Background.-Traceback= 114ECF8z 130425z 15E20Ez 15DF30z 15DD3Dz 157D75z 158A2Bz 1589BFz 159B67z 153672z 3C9740Az 3C868CEz 3C89BEFz 5125F91z 491D86Cz 492E540z - Process "Crypto CA", CPU hog, PC 0x00157D2C
      Workaround: This is cosmetic and can be ignored.
    • IOSv 15.6(1)T / IOSvL2 15.2(4055) DSGS - CSCuv77089 - CVAC: day0 configuration only partially saved
      When booting an IOSv or IOSvL2 instance within VIRL, it will insert the bootstrap configuration into running-config and report the following message:

    Aug 10 15:06:08.555: %CVAC-4-CONFIG_DONE: Configuration generated from file flash3:/ios_config.txt was applied and saved to NVRAM. See 'show running-config' or 'show startup-config' for more details.

    The running-config is fully applied. However, the startup configuration only contains partial content.
    Workaround: issuing the command 'copy run start' after the device has fully booted, will copy the running-configuration content to the startup-configuration as expected.Note: VIRL's configuration extraction function performs a 'copy run start' operation as part of its execution.

    • VIRLDEV-3119 - Rehost operation - changing the internalnetport IP address from 172.16.10.250 results in broken system_
      Changing the internalnet_port IP address from the default (172.16.10.250) value and then performing the 'vinstall rehost' operation results in an VIRL system which is not operational.
      Workaround: None. Changing the internalnet_port IP address is NOT supported.
    • VM Maestro - terminal preference for detached internal terminals - this function has been deprecated in VM Maestro 1.2.4 onwards.
      Workaround: you can manual 'tear' the terminal pane from the main VM Maestro window. Use this in conjunction with the VM Maestro preference (Cisco terminal) - "multiple tabs for one simulation".
    • VIRLDEV-4517: No VM Maestro splash screen on Windows
      On Windows, when VM Maestro starts, the splash screen is not being shown.
      Workaround: None.  After clicking VM Maestro, wait for the main VM Maestro window appears. Typically takes about 10-15 seconds or less for the application to start on most systems.

     

    Community Found Defects; Resolved

    VIRL is a community supported and community shaped application. As VIRL grows and evolves, the feedback received from the community shapes and enhances the user experience. The following resolved defects were reported by our community and users:

    • VIRLDEV-2299: Interface selection failing on Win10 touchscreen computers.
    • VIRLDEV-3393: Add option to connect to server management IP.
    • VIRLDEV-4547: User cannot drag a site to a new position in the topology editor.
    • VIRLDEV-4566: Remove the "breadcrumb" widget at the top of the topology editor.
    • VIRLDEV-4667: VM Maestro idles at 100% CPU on Ubuntu 16.04.