BeroNet Telephony Appliance-v2

From berofix - professional SIP gateway
Jump to: navigation, search
(Howto Install an OS in a VM)
(System)
 
Line 1: Line 1:
 +
 +
[[image: overview2.png]]
 +
 +
 
= Introduction =  
 
= Introduction =  
  
Line 10: Line 14:
  
 
The beroNet Hypervisor is built on the Alpine embedded Linux with the XEN Kernel. This allows to use minimum ressources of physical Machine for the hypervisor itself and give most of the ressources to the Virtual Machines. The hypervisor only requires 2GB of disk space and 1 GB of Memory.
 
The beroNet Hypervisor is built on the Alpine embedded Linux with the XEN Kernel. This allows to use minimum ressources of physical Machine for the hypervisor itself and give most of the ressources to the Virtual Machines. The hypervisor only requires 2GB of disk space and 1 GB of Memory.
 
 
[[image: overview.png]]
 
  
 
= physical Setup =  
 
= physical Setup =  
  
The appliance has several connectors for different tasks. The minimal Setup requires only 2 cables:
+
The appliance has several connectors for different tasks.  
  
 +
[[image: hardware.png]]
 +
 +
The minimal Setup requires only 2 cables: 
 
  * power adapter to the 12V DC Jack
 
  * power adapter to the 12V DC Jack
  * LAN cable connected to either LAN1 or LAN2
+
  * LAN cable connected to LAN
  
 
After pushing the power button, you should hear a beep and the appliance should boot up.
 
After pushing the power button, you should hear a beep and the appliance should boot up.
 
[[image: hardware.png]]
 
  
 
= Network Setup =  
 
= Network Setup =  
Line 98: Line 100:
 
[[image: dashboard.png]]
 
[[image: dashboard.png]]
  
Each VM can be started by clicking the "start" link 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" link or powered off via the "Poweroff" link.  
+
Each VM can be started by clicking the "start" link 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" link or powered off via the "Poweroff" link.
  
  
=== VM Manager ===
+
=== VNC - Console/Monitor for the VMs ===
  
Under "Virtual Machines->Manage VMs" you will find the VM manager. It allows to create new VMs or to modify existing ones.
+
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: '''[http://www.tightvnc.com/download.php TightVNC]'''
 +
 +
The Dashboard provides a built-In WebtRTC based WebVNC Client from Kanaka: [http://kanaka.github.io/noVNC/ 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: [https://github.com/kanaka/websockify 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:
 +
 
 +
[[Image:VNC.png]]
 +
 
 +
=== Manager VMs ===
 +
 
 +
Under "Virtual Machines->Manage VMs" you create new VMs, delete or rename existing ones.  
  
 
[[image: vm-manager.png]]
 
[[image: vm-manager.png]]
  
 +
By clicking on '''New''' the VM Create wizard opens and allows to create a new vm.
  
To create a new VM the following parameters need to be set:
+
[[image: new-vm.png]]
  
* Machine Name        - The name of this VM   ('''NOTE: not editable''')
+
After clicking on '''Create''' you can modify the VM Details in the VM Manager.
 +
 
 +
In the List of Virtual Machines you can always find a "manage" button which brings you the the VM Manager of this machine.
 +
 
 +
==== VM Details ====
 +
 
 +
The VM Manager divided in different sections:
 +
 
 +
'''STATUS'''
 +
 
 +
Shows the current status of the VM and allows to do actions with it. The actions are:
 +
 
 +
* Power On / OFF
 +
* Shutdown
 +
* Sleep / Wakeup
 +
* Clone
 +
 
 +
[[image: vm-status.png]]
 +
 
 +
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:
 
  * # CPUs              - The amount of CPUs for this virtual machine, one is reserved for the Hypervisor
 
  * # CPUs              - The amount of CPUs for this virtual machine, one is reserved for the Hypervisor
 
  * Memory in GB        - The amount of memory for this VM, 1GB is reseved for the Hypervisor
 
  * Memory in GB        - The amount of memory for this VM, 1GB is reseved for the Hypervisor
  * Disk in GB          - The size of the Disk of the VM, 4GB are reserved for the Hypervisor ('''NOTE: not editable''')
+
  * Start on boot        - defines if the VM should be started automatically during boot
* iso-file            - The ISO file from which the VM should boot
+
 
  * Boot-Device          - defines if the VM boots from it's virtual hard-drive or from the ISO file for installation
 
  * Boot-Device          - defines if the VM boots from it's virtual hard-drive or from the ISO file for installation
 +
 +
[[image: vm-system.png]]
 +
 +
''' NETWORK '''
 +
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 activaed under System->network''')
 
  * 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 activaed under System->network''')
  * Windows-Tools        - if enabled the VM has another disk containing the PV driver for windows, which boost the performance of a windows VM ('''NOTE: preinstalled with the market windows images''')
+
  * NIC-Model            - Realtek RTL8139 or Intel e1000 the emulated NIC Model for the VM
* Start on boot        - defines if the VM should be started automatically during boot
+
 
 +
Also the MAC Addresses of the VM are visible here. The WAN Mac Address is only relevant in the lan-wan mode.
 +
 
 +
[[image: vm-network.png]]
 +
 
 +
''' DISKS '''  
 +
 
 +
The Disks Manager allows to create, delete and reorder virtual disks. Also It defines if an ISO Intallation Medium is inserted in the VM.
 +
'''NOTE:''' a deleted disk can not be recovered!
 +
 
 +
[[image: vm-disks.png]]
 +
 
 +
 
 +
'''OTHER'''
 +
Under other, you can mainly find the VNC and miscalleneous settings:
 
  * VNC Display          - defines the VNC display number
 
  * VNC Display          - defines the VNC display number
 
  * VNC Password        - defines the VNC access password
 
  * VNC Password        - defines the VNC access password
 +
* VNC Keymap          - defines the VNC virtual Keyboard Keymap
 +
* HV Options          - adds the possibility to add manually XEN option, for reference: [http://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html  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 ('''NOTE: preinstalled with the market windows images''')
 +
 +
 +
[[image: vm-other.png]]
  
 +
'''CLONES'''
  
To edit a VM just click on the "edit" link and use the bottom form to change the desired settings.
+
If the VM has clones or is a clone, it displays a list of its clones or a link of its parent.
  
 
=== Backup & Restore ===  
 
=== Backup & Restore ===  
Line 171: Line 235:
  
 
With Window share credentials:  
 
With Window share credentials:  
+
 
  * Domain
+
  * Domain       e.g.  beroNet
  * Share Name
+
  * 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
+
  * user         e.g.  beroUser
  * password
+
  * password     e.g.  beroPassword
  
  
Line 192: Line 256:
  
 
'''NOTE: this can take several minutes or even hours, depending on the size and internet speed'''
 
'''NOTE: this can take several minutes or even hours, depending on the size and internet speed'''
 +
 +
=== How-to use clones / snapshots ===
 +
 +
The beroNet hypervisor GUI allows to create thin clones of existing VMS. A clone is not a full copy of a VM. The disks of the clone reference back to the parent so that only the differences for each clone are stored within the clone, while the main data resides within the parents disk. The mechanism used here is copy-on-write. The parents disk is not modified while the clones run, this means the parents VM state is saved as a snapshot. When the clones are deleted the parent can run again from the moment on when the first clone was created. At later times other clones can be created from the parent or even from clones.
 +
 +
The result is a tree, like in this example:
 +
 +
[[image: vm-clones.png]]
 +
 +
 +
'''NOTE:''' only the orange leaves of the tree can actually run. But indeed they can run at the same time!
 +
 +
"Parent" and "clone 2" can be seen as snapshots as they preserve the VM state at the time when they ran at last.
 +
 +
 +
To create a clone you need to go to the VM Manager of a VM on the STATUS Tab and click on "clone" and then provide a name of the clone (You can only create clones of powered of VMs).
 +
 +
[[image: vm-create-clone.png]]
 +
 +
After that the cloned VM becomes a parent and is in the STATUS CLONED:
 +
 +
[[image: vm-clone-status.png]]
 +
 +
Also a list of all clones of this VM is displayed:
 +
 +
[[image: vm-clone-list.png]]
 +
 +
You can always create new clones from this parent VM. These clones will have the state of the parent last time it was powered off.
 +
  
 
== System ==  
 
== System ==  
Line 208: Line 301:
 
* 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
 
* 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.
+
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.
 
+
  
 
[[image: network.png]]
 
[[image: network.png]]
Line 236: Line 328:
 
=== change password ===
 
=== change password ===
  
Under System->change password, the password of the admin GUI User can be changed.  
+
Under System->change password, the password of the admin GUI User can be changed.
 
+
  
 
== Gateways ==  
 
== Gateways ==  
Line 255: Line 346:
 
If you want to setup a Windows virtual machine you need to follow the steps:
 
If you want to setup a Windows virtual machine you need to follow the steps:
  
  1. Download a windows Installation Medium
+
  1. Download a Windows Installation Medium
 
  2. Create VM with enough CPU cores and enough memory  
 
  2. Create VM with enough CPU cores and enough memory  
 
  3. Boot and install the VM
 
  3. Boot and install the VM
Line 267: Line 358:
 
  3. turn off swap  
 
  3. turn off swap  
  
Keep in mind the the Disk is a file on a SSD. Having swap enabled means a lot of disk access from within the VM. The disk access is always slower from within the VM.  
+
Keep in mind the the Disk is a file on a SSD. Having swap enabled means a lot of disk access from within the VM. The disk access is always slower from within the VM.
  
 
== Linux ==  
 
== Linux ==  
Line 284: Line 375:
  
 
[http://www.beronet.com/wp-content/uploads/downloads/appliance/BNTA2/recovery-stick/ Recovery Stick]
 
[http://www.beronet.com/wp-content/uploads/downloads/appliance/BNTA2/recovery-stick/ Recovery Stick]
 +
 +
'''NOTE:''' lease make sure to use a USB Stick with '''at least 8GB''' of memory
 +
 +
== Steps for recovery ==
 +
 +
1. Plugin the recovery USB stick
 +
2. Hold F11 Key during boot to reach the Boot-Options Menu
 +
3. choose "General USB Flash Disk" ! (do not choose UEFI)
 +
4. Choose Web-Install
 +
5. let the appliance boot the recovery stick, after a few minutes it reveives an DHCP IP Address which will be displayed on the screen
 +
6. use a different computer to access the IP.
 +
7. In the recovery GUI, download the latest HV Image
 +
8. After download install the HV Image, the Appliance will automatically shutdown after installation
 +
9. unplug the Recovery stick and boot the appliance
 +
 +
 +
See below how the recovery Stick is booted and how to use the Sticks GUI to recover the Hypervisor.
 +
 +
== Choose right boot option ==
 +
 +
 +
[[image:stick-1.jpg]]
 +
 +
Make sure too choose "General USB Flash Disk" and NOT "UEFI".
 +
 +
== Boot the Webinstaller ==
 +
 +
Short after booting the bootloader shows 3 options. Make sure to choose the "beroNet Appliance Installer (web)"
 +
 +
[[image:stick-2.jpg]]
 +
 +
== See the IP Address obtained ==
 +
 +
After the boot process has finished, the Linux shows the IP address obtained via DHCP:
 +
 +
[[image: stick-3.jpg]]
 +
 +
 +
== The Sticks WebGUI ==
 +
 +
When you surf to the IP Address the Sticks WebGUI will be displayed.
 +
 +
[[image: stick-gui-1.png]]
 +
 +
Klick "fetch image-list" to download the current images.
 +
 +
[[image: stick-gui-2.png]]
 +
 +
chooes the latest "HV" image to download.
 +
 +
[[image: stick-gui-3.png]]
 +
 +
Now you can install the Hypervisor on the Appliance. Be Aware that the recovery stick will erase the SSD in the appliance!
  
 
= Ressources =
 
= Ressources =
Line 290: Line 434:
  
 
[http://www.beronet.com/wp-content/uploads/downloads/appliance/BNTA2/MITX_6770/ Drivers and Download]
 
[http://www.beronet.com/wp-content/uploads/downloads/appliance/BNTA2/MITX_6770/ Drivers and Download]
 +
 +
[http://apt.univention.de/download/addons/gplpv-drivers/gplpv_Vista2008x64_signed_0.11.0.373.msi PV Drivers from Univention]
 +
 +
= Known Issues =
 +
 +
* Web VNC Viewer only works properly in Firefox and Microsoft Edge
 +
* up to the Hypervisor Version 0.9.2, the '''[[VM and ISO storage space is limited to only 23G]]''', this can lead to VMs growing bigger than the storage space and failing
 +
 +
= FAQ =
 +
'''Problem''': My VNC client shows only a black screen when behind a NAT or using the beroNet Cloud
 +
'''Workaround''': read [http://wiki.beronet.com/index.php/BeroNet_Telephony_Appliance-v2#VNC_-_Console.2FMonitor_for_the_VMs VNC Guide] carefully and use an external VNC Client if necessary.
 +
 
 +
'''Problem''': Shutdown in Hypervisor of Windows doesn't work
 +
'''Workaround''': the PV Driver shutdownmon service hasn't been installed correctly. Start a command prompt as administrator and goto c:\Program files (x86)\Xen PV Drivers\bin\  and issue the command:
 +
              shutdownmon -i
 +
 +
'''Problem''': WebVNC keyboard is strange
 +
'''Solution''': Use the HV-Options in the VM Editor and add
 +
                keymap='de'
 +
                for a german keymap.
 +
 +
'''Problem''': VM Time is about 1 hour wrong
 +
'''Solution''': Use the HV-Options in the VM Editor and add
 +
                localtime=1
 +
               
 +
 +
'''Problem''': Shutdown in Windows 10 results in Hypervisor crash
 +
'''Workaround''': Windows 10 tries to use Fastboot while shutting down, this can be disable in Windows under:
 +
  Settings->System->Power&Sleep->Additional Power Settings->Choose what the power buttons do->Change->settings that are currently unavailable -> Turn on fast startup
 +
 +
[[Image:shutdown-issue.png]]
 +
 +
= CHANGELOG =
 +
 +
The Hypervisor receives new features and bugfixes frequently. Please see the [[beroNet Hypervisor Changelog]] for a list of changes.

Latest revision as of 14:55, 25 May 2016

Personal tools