Hypervisor Web-Interface (Appliance)

Current beroNet Hypervisor State is Beta. Please see Hypervisor State for more details.

Logging in


As soon as you have accessed the Hypervisor Web-interface you can login with the default credentials:

  • Username: admin
  • Password: beronet


Make sure to change the password later in the menu under "Settings+ → Security Settings → GUI-Password"


The Hypervisor GUI allows it to:

  • manage virtual machines
  • create and restore backups of machines
  • use the beroNet Appliance Market to download ready Apps and ISO Installation Media
  • discover a built in beroNet Gateway or beroNet Gateways in the local network

Virtual Machines


How to install an OS in a VM

To install an operating system as a VM you need to follow the steps:

  1. Download an ISO file which contains the operating system either from a web-URL or from the Market; or upload an ISO file using the upload feature in the GUI
  2. Create a VM and define its metric and select your chosen ISO under "boot from ISO".
  3. Start the VM from the Dashboard
  4. Access the VNC console via the VNC link in the Dashboard
  5. Complete the installation using the prompts provide by your chosen OS. When completed, use the hypervisor dashboard to shutdown or poweroff the machine.
  6. On the Dashboard select "manage" next to your recently installed VM. Under "system" change the boot-device disk to "c (disk)"
  7. Restart the VM

Dashboard

The Dashboard shows all VMs and current system loadout.



Each VM can be started by clicking on "Start" if they are in the state "STOPPED". If they are in the state "RUNNING" the VM can be accessed via VNC, halted via the "Shutdown" button or powered off via the "Stop" button.

VNC - Console/Monitor for the VMs

By default each Virtual Machine starts a VNC Server on the Ports between 5900 - 5905. Any VNC tool can connect to this port, e.g. tightvnc for linux and windows: TightVNC

The Dashboard provides a built-In WebtRTC based WebVNC Client from Kanaka: noVNC Client. As the VNC Server of the VM is not a WebRTC Server, a WebRTC Proxy is used to connect the VM VNC Server and the noVNC Client. We're using again Kanakas Socket Proxy: websockify for that.

The Websockify Proxy opens a WebRTC Port on the Ports 6900 - 6905 corrresponding to the VNC Server ports. This needs to be understand and considered when creating NAT rules to the Hypervisors WebGui. It is easier to use an external VNC client like tightvnc in this case (the VNC port must still be natted).

The following picture shows how a browser can use the WebVNC on port 6900 and the Webserver on port 80 and how a VNC client can directly connect to the VMs VNC Server on port 5900:

Manage VMs

Under "Dashboard" you can create new VMs, edit, delete or rename existing ones.



By clicking on "+" the VM Create wizard opens and allows to create a new VM.



After clicking on "+" you can modify the VM Details in the VM Manager.

By selecting the VM you want to edit and clicking on "Open Management-Page" the VM can be modified any time.


VM Details

The VM Manager is divided in different sections:

Virtual Machine Status

Shows the current status of the VM and allows to:

  • Open VNC-Console
  • Suspend
  • Start / Stop
  • Reboot
  • Shutdown
  • Rename (VM must be stopped)
  • Delete (VM must be stopped)

Additionally you can use the built-in WebVNC tool to connect to the console of the VM.

SYSTEM

In the System Settings you can define:

* Assigned Cores:      -The amount of CPUs for this virtual machine, one is reserved for the Hypervisor
* Assigned Memory:     -The amount of memory for this VM, 1GB is reserved for the Hypervisor
* Boot-Device:         -Defines if the VM boots from it's virtual hard-drive or from the ISO file for installation
* Start on boot: -Defines if the VM should start automatically during boot


Network-Settings

Under the network settings you can define:

* NIC-Mode             - defines if the VM should access both the LAN and WAN port or only the LAN port of the appliance (NOTE: for LAN-WAN mode, LAN-WAN mode needs to be activated under Settings+ --> Network Configuration)
* NIC-Model            - Realtek RTL8139 or Intel e1000 the emulated NIC Model for the VM

Also the MAC Addresses of the VM are visible here. The WAN Mac Address is only relevant in the lan-wan mode.


Virtual Disk-Settings

The Disks Manager allows to create, delete and reorder virtual disks. Also It defines if an ISO Installation Medium is inserted in the VM. NOTE: a deleted disk can not be recovered!


Miscellaneous Settings

Under other, you can mainly find the VNC and miscellaneous settings:

* Console Port (VNC):      -Defines the VNC display port number
* Console Password (VNC):  -Defines the VNC access password
* Console Keymap (VNC):    -Defines the VNC virtual Keyboard Keymap
* Hypervisor Options       -Adds the possibility to add manually XEN option, for reference: xen options, multiple settings can be seperated by ; as localtime=1;
* Windows-Tools            -If enabled the VM has another disk containing the PV driver for windows, which boost the performance of a windows VM


Backup & Restore

The Hypervisor can backup & restore full VMs and ISO files. All local storage disks are shown under "Backup+". 



If no disk was found, attach a USB drive and click on "Scan for Disks". If the drive is not yet a "backup-space" for the Hypervisor, the drive needs to be formatted as backup space.

To make a backup or restore already made backups click on "View Backups".


In the "Restore Virtual Machines" tab, previously backuped ISO files and Apps (VMs) can be restored back to the Hypervisor disk. This may take several minutes and even hours depending on the file size and if the file is compressed. The backups can also be deleted here.

In the "Backup Virtual Machines" tab local VMs and ISO files can be backuped. VMs can be compressed in order to save drive space.



Make sure that the drive is large enough to hold a complete VM. Creating a backup can take several minutes and even hours, depending on the file size and whether compression is used or not.

Remote Backups

The Appliance Hypervisor provides the possibility to backup your VM's via ssh to a remote second Appliance in the same network on a schedule or directly.

For a full in-depth Tutorial, check out this Guide:

ISO Manager

The ISO Manager shows the local stored ISO files which can be used to boot a VM to install the OS provided in the ISO file (e.g. an Ubuntu ISO for installing Ubuntu in a VM). 



There are 2 ways to get an ISO on the appliance:

  1. Web-Download
    1. The Web-URL of the ISO can be provided. If it is protected with basic authentication, a username and password can be provided in the syntax "user:password". NOTE: this can take several minutes and even hours, depending of the size of the ISO and the internet speed.
  2. Upload 
    1. An ISO of up to 8GB can be uploaded directly via the browser. NOTE: this can take several minutes and even hours, depending of the size of the ISO
  3. Windows Share Download ONLY V0.3
    1. With Window share credentials:
      * Domain        e.g.  beroNet 
      * Share Name    e.g.  //beronas/ISOs   (the share is only one Folder on the Server, like //SERVER/SHARE and SHARE does not have subfolders) 
      * user          e.g.  beroUser
      * password      e.g.  beroPassword

      a windows share, fileserver or NAS can be browsed. After clicking on an ISO File, the file will be downloaded. NOTE: this can take several minutes and even hours, depending of the size of the ISO

beroNet Appliance Market

The beroNet Appliance Market allows it to download pre-installed Virtual Machines. These machines can be started directly in the Hypervisor. The Market also allows to donwload ISO Installation Media for setting up new Virtual Machines.



Each VM or ISO has additional Meta Information like the version and the size. By clicking the download icon the VM or ISO will be downloaded to the lokal appliance.

NOTE: this can take several minutes or even hours, depending on the size and internet speed

System


Update Hypervisor

In order to update the Hypervisor navigate to "Management+ → Hypervisor Update" and select the version you want to install.


Network Settings

Navigate to "Settings+ → Network Configuration".

The Network Manager allows you to choose the Interface Mode of the appliance:

  • LAN - Both LAN Ports are bridged into a single network bridge
  • LAN-WAN - the 2 LAN Ports are put into seperate bridges, VMs which have LAN-WAN mode have the WAN Bridge as additional Network adapter

The LAN Mode can be defined as DHCP or static. If it is static the LAN Settings need to be defined. These settings do only apply to the LAN interface of the Appliance. The WAN Port however can only be controlled from within a VM which has the LAN-WAN mode enabled.


Cloud Settings

Navigate to "Settings+ → Remote Management".

The Cloud Manager allows to register the appliance into the beroNet Cloud or into a private beroNet Cloud.



After successful registration a cloud key appears. The appliance starts communication with the beroNet Cloud after enabling the cloud and after clicking "Enable".


NOTE: a reboot of the hypervisor might be needed to register the appliance in a different cloud

Reboot & Halt

Navigate to "Management+ –> Reboot & Shutdown".



By selecting "Reboot Appliance", the appliance will reboot.

NOTE: all VMs will be halted ungracefully

By selecting "Shutdown Appliance", the appliance will turn off.

NOTE: remote Power ON is not possible

Change password

Under "Settings+ → Security Settings", the password of the admin GUI User can be changed.



Gateways


The Gateways Manager starts a "bfdetect" in the background and shows a list of all local beroNet Appliances and Gateways with their serial numbers, Firmware Versions, IP Addresses and MAC Addresses.

Navigate to "Devices+ → Gateways".


By clicking on the IP Address, the browser will be redirected to the gateway/appliance GUI.


Setup Gateway: Gateways and Cards