Virtual LoadMaster for Xen (Para Virtualized)

Virtual LoadMaster for Xen (Para Virtualized) VERSION: 1.10 UPDATED: MARCH 2014 Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 1 / 18

Copyright Notices Copyright 2002-2014 KEMP Technologies, Inc.. All rights reserved.. KEMP Technologies and the KEMP Technologies logo are registered trademarks of KEMP Technologies, Inc.. KEMP Technologies, Inc. reserves all ownership rights for the LoadMaster product line including software and documentation. The use of the LoadMaster Exchange appliance is subject to the license agreement. Information in this guide may be modified at any time without prior notice. Microsoft Windows is a registered trademarks of Microsoft Corporation in the United States and other countries. All other trademarks and service marks are the property of their respective owners. Limitations: This document and all of its contents are provided as-is. KEMP Technologies has made efforts to ensure that the information presented herein are correct, but makes no warranty, express or implied, about the accuracy of this information. If any material errors or inaccuracies should occur in this document, KEMP Technologies will, if feasible, furnish appropriate correctional notices which Users will accept as the sole and exclusive remedy at law or in equity. Users of the information in this document acknowledge that KEMP Technologies cannot be held liable for any loss, injury or damage of any kind, present or prospective, including without limitation any direct, special, incidental or consequential damages (including without limitation lost profits and loss of damage to goodwill) whether suffered by recipient or third party or from any action or inaction whether or not negligent, in the compiling or in delivering or communicating or publishing this document. Any Internet Protocol (IP) addresses, phone numbers or other data that may resemble actual contact information used in this document are not intended to be actual addresses, phone numbers or contact information. Any examples, command display output, network topology diagrams, and other figures included in this document are shown for illustrative purposes only. Any use of actual addressing or contact information in illustrative content is unintentional and coincidental. Portions of this software are; copyright (c) 2004-2006 Frank Denis. All rights reserved; copyright (c) 2002 Michael Shalayeff. All rights reserved; copyright (c) 2003 Ryan McBride. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE ABOVE COPYRIGHT HOLDERS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the above copyright holders.. Portions of the LoadMaster software are copyright (C) 1989, 1991 Free Software Foundation, Inc. -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA- and KEMP Technologies Inc. is in full compliance of the GNU license requirements, Version 2, June 1991. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Portions of this software are Copyright (C) 1988, Regents of the University of California. All rights reserved. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 2 / 18

Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Portions of this software are Copyright (C) 1998, Massachusetts Institute of Technology Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Portions of this software are Copyright (C) 1995-2004, Jean-loup Gailly and Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Portions of this software are Copyright (C) 2003, Internet Systems Consortium Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Used, under license, U.S. Patent Nos. 6,473,802, 6,374,300, 8,392,563, 8,103,770, 7,831,712, 7,606,912, 7,346,695, 7,287,084 and 6,970,933 Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 3 / 18

Table of Contents 1 Introduction... 5 2 Installing Virtual LoadMaster (VLM) on a Xen Environment... 6 2.1 Download the Xen, Para-Virtualized, Files... 6 2.2 Configure the Configuration File... 6 2.2.1 Edit the Sample Configuration File... 6 2.3 Power On the LoadMaster... 8 2.4 Licensing and Configuration... 8 3 Troubleshooting and Notes... 13 3.1 Cannot access the Web User Interface... 13 3.2 Common Xen Commands... 14 3.3 Factory Reset... 14 3.4 Items of Note... 15 Appendix A: Sample Configuration File... 16 4 References... 17 Document History... 18 Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 4 / 18

1 Introduction The KEMP Virtual LoadMaster is a version of the KEMP LoadMaster that runs as a virtual machine within a hypervisor and can provide all the features and functions of a hardware-based LoadMaster. This document describes the installation of the Virtual LoadMaster (VLM) within a Xen, paravirtualized environment. The VLM has been tested with Xen.org versions 3.1, 4.0 and 4.1. There are several different versions of the VLM available. Full details of the currently supported versions are available on our website: www.kemptechnologies.com. The Xen virtual machine guest environment for the VLM, at minimum, must include: 1 GB RAM 32 GB virtual hard disk capacity Para-virtualization requires some modification of the guest OS or application. The guest OS or applications are aware that they are in a virtual environment which allows for a near-native performance. There may be maximum configuration limits imposed by Xen such as maximum RAM per VM, Virtual NICs per VM etc. For further details regarding the configuration limits imposed by Xen, please refer to the relevant Xen documentation. A wide variety of Linux distributions can be used as the Dom0 operating system. For a full list of the compatible Linux distributions, please refer to www.xen.org. KEMP LoadMaster has been tested with OpenSUSE 12.1 as the Dom0 operating systems and the 3.1 Xen.org version. If you have any issues with the Virtual LoadMaster when using a different combination of Xen.org versions and Linux distributions as the Dom0, then please contact KEMP Support. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 5 / 18

2 Installing Virtual LoadMaster (VLM) on a Xen Environment The following instructions describe how to install a Virtual LoadMaster on a Xen environment. 2.1 Download the Xen, Para-Virtualized, Files The VLM is packaged within a zip file for ease of deployment. This file can be freely downloaded from KEMP Technologies for a 30 day evaluation period. To download the VLM please follow the instructions below: 1. Log on to http://www.kemptechnologies.com/try 2. Within the Select the hypervisor platform section, select the option for Download Xen, Para-Virtualized 3. Read the end user agreement. 4. If you wish to continue, select your country from the drop-down list. 5. Click on the Agree button. 6. Download the Xen zip file. 7. Unzip the contents of the file to an accessible location within the Xen environment. The zip file contains the following files, where x.x-xx denotes the release number: LoadMaster-VLM-x.x-xx-XEN.disk: the disk image LICENSE: the end-user agreement LoadMaster-VLM-x.x-xx-XEN.config.sample: a sample configuration file LoadMaster-VLM-x.x-xx-XEN.initrd LoadMaster-VLM-x.x-xx-XEN.linux README: an installation readme file 2.2 Configure the Configuration File To install a Virtual LoadMaster as a guest virtual machine within a Xen, para-virtualized environment, the first step is to create a configuration file detailing the correct parameters for your installation. The values for these parameters may differ depending on the Linux distribution in use as the Dom0 and on your networking requirements. KEMP provides a sample configuration file within the Xen zip file, LoadMaster-VLM-x.x-xx- XEN.config.sample which you can edit to create your own configuration file. 2.2.1 Edit the Sample Configuration File Within the Xen zip file, KEMP have provided a sample configuration file, LoadMaster-VLM x.xxx-xen.config.sample. This file can be used to configure the required parameters for the Virtual LoadMaster. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 6 / 18

Kernel path Configure the path to hvmloader. This path may differ depending on the Linux distribution being used as Dom0. kernel = "/path/to/hvmloader" Device Model path Configure the path to qemu-dm. This path may differ depending on the Linux distribution being used as Dom0 device_model="/path/to /qemu-dm" Within the sample configuration file the correct settings for the kernel and device_model are provided for OpenSUSE 12.1, Debian 6.0 and CentOS 6.3. Comment out the operating systems not in use. Location of the LoadMaster-VLM-x.x-xx.disk file Configure the path to the location of the LoadMaster-VLM-x.x-xx.disk file. disk=[ 'tap:aio:/path/to/loadmaster-vlm-x.x-xx-xen.disk,xvda,w' ] Where x.x-xx denotes the release number MAC Addresses Enter the MAC address and network bridge information for each NIC required in the installation. vif=[ 'mac=00:16:3e:xx:xx:xx, bridge=br0, model=e1000', 'mac=00:16:3e:xx:xx:xx, bridge=br1, model=e1000'] It's recommended to use a MAC address inside the range 00:16:3e:xx:xx:xx. This address range is reserved for use by Xen. Only NIC types of e1000 are currently supported VNC Support It is recommended to use VNC to administer the console. vnc=1 Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 7 / 18

If you intend to configure a Virtual Service that utilizes L7 transparency, it is highly recommended that the NICs on Dom0 have the Generic Receive Offload (GRO) option turned off as otherwise performance levels may be impacted. 2.3 Power On the LoadMaster Once the VLM has been deployed it can be powered on. To do this, from within the location where the Xen zip file was unzipped, type the following command: xm create c LoadMasterVLM This starts the Virtual LoadMaster boot process and is immediately attached to the serial console. Figure 2-1: IP address The VLM should obtain an IP address via DHCP. Make a note of this address. If the VLM does not obtain an IP address, or if the IP address needs to be changed, it can be manually configured in the console by following the steps in Section 3.1. 2.4 Licensing and Configuration The LoadMaster must now be configured to operate within the network configuration. 1. In an internet browser enter the IP address that was noted previously. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 8 / 18

Ensure to enter https:// before the IP address. 2. A warning may appear regarding website security certificates. Please click the continue/ignore option. 3. The LoadMaster End User License Agreement screen appears. Please read the license agreement and, if willing to accept the conditions therein, click on the Agree button to proceed. 4. A screen will then appear asking if you are OK with the LoadMaster regularly contacting KEMP to check for updates and other information. Click the relevant button to proceed. Figure 2-2: License Required 5. If using the Online licensing method, fill out the fields and click License Now. If you are starting with a trial license, there is no need to enter an Order ID. If you are starting with a permanent license, enter the KEMP Order ID# if this was provided to you. If using the Offline Licensing method, select Offline Licensing, obtain the license text, paste it into the License field and click Apply License. For detailed instructions on how to register for a KEMP ID and license the LoadMaster, refer to the Licensing, Feature Description. Figure 2-3: Authentication Required Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 9 / 18

6. After the LoadMaster is licensed, a prompt will appear asking to log in. Enter the user name and password and click OK. Please use the following login credentials: lb100 login: bal Password: 1fourall 7. The Change Password screen appears 8. Enter a new password for the bal user in the Password input field and retype it in the Retype Password input field. 9. The login screen appears again, enter the bal user name and the new password as defined in the previous step. 10. In the screen informing you that the password has changed, press the Continue button 11. If your machine has shipped with a temporary license you should get a warning informing you that a temporary license has been installed on your machine and for how long the license is valid. 12. Click on the OK button 13. You should now connect to the Appliance Vitals screen of the LoadMaster. Figure 2-4: Home Page Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 10 / 18

14. Click the System Configuration menu option. 15. Click the eth0 menu option within the Interfaces section. 16. In the Network Interface 0 screen, enter the IP address of the eth0 interface, the network facing interface of the LoadMaster, in the Interface Address input field. 17. Click on the Set Address button 18. Click on the eth1 menu option within the Interfaces section 19. In the Network Interface 1 screen, enter the IP address of the eth1 interface, the farmside interface of the LoadMaster, in the Interface Address input field. 20. Click on the Set Address button This interface is optional, depending on the network configuration. 21. Click on the Local DNS Configuration > Hostname Configuration menu option. 22. In the Hostname configuration screen, enter the hostname into the Current Hostname input field. 23. Click on the Set Hostname button. 24. Click on the Local DNS Configuration > DNS Configuration menu option. 25. In the DNS configuration screen, enter the IP address(es) of the DNS Server(s) which will be used to resolve names locally on the LoadMaster into the DNS NameServer input field. 26. Click on the Add button. 27. Enter the domain name that is to be prepended to requests to the DNS nameserver into the DNS NameServer input field. 28. Click on the Add button. 29. Click on the Route Management > Default Gateway menu option. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 11 / 18

30. In the DNS configuration screen, enter the IP address of the default gateway into the IPv4 Default Gateway Address input field. 31. If you have an IPv6 Default Gateway, please enter the value in the IPv6 Default Gateway Address input field. 32. Click on the Set IPv4 Default Gateway button. The LoadMaster is now fully installed and ready to be used. For further information on how to configure and implement the Virtual LoadMaster, please refer to the LoadMaster documentation which can be downloaded from the http://www.kemptechnologies.com/documentation page. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 12 / 18

3 Troubleshooting and Notes 3.1 Cannot access the Web User Interface If a connection to the WUI cannot be established, network settings can be configured via the console view. 1. Login into the VLM via the console using the settings: lb100 login: bal Password: 1fourall Figure 3-1: Enter IP address 2. Enter the IP address of the eth0 interface, the network-facing interface of the LoadMaster, in the input field within the Network Side Interface Address field and press Enter on the keyboard. Figure 3-2: Enter default gateway address 3. Enter the IP address of the Default Gateway. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 13 / 18

Figure 3-3: Nameserver IP addresses 4. Enter a space-separated list of nameserver IP addresses. 5. A message will appear asking to continue licensing via the WUI. Try to access the IP address via a web browser. Ensure to enter https:// before the IP address. 6. Contact the local KEMP Customer Services Representative for further support if needed. 3.2 Common Xen Commands The following list describes some commonly used Xen commands. xm list Shows a list of running Xen systems xm create <filename> Starts a DomU on a Dom0 using configuration set in the filename xm create -c <filename> Starts a DomU on a Dom0 using configuration set in the filename and immediately attach to the serial console xm console <Domain> Attach to the serial console of the domain xm destroy <Domain> Turn off the VM 3.3 Factory Reset If you perform a factory reset on your VLM, all configuration data, including the VLM s IP address is deleted. During the subsequent reboot the VLM attempts to obtain an IP address via DHCP. If the VLM is on a different subnet to the DHCP server then an IP address will not be obtained and the IP address is set to the default 192.168.1.101. The VLM may not be accessible using this address. If this is the case then you must run through the quick setup via the console as described in Section 3.1. Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 14 / 18

3.4 Items of Note The following are some items to note when using LoadMaster in a Xen environment. A filename may not match the running DomU name. Do an XM list to get the DomU name. Xen VM's can be administered "locally" by either emulated serial, via xm console OR emulated VGA via VNC Usually the customer will have a bridge for networking, /dev/br0 or br1, etc. A VM will not start unless their networking is perfect. Xen logs are located in: /var/log/xen/qemu-dm-loadmaster_vlm.log /var/log/xen/xend.log Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 15 / 18

Appendix A: Sample Configuration File #DO NOT EDIT name="loadmaster-vlm" description="loadmaster_vlm_6.0-40cm" memory=1024 maxmem=1024 vcpus=2 localtime=0 keymap="en-us" boot="c" #END OF DO NOT EDIT # Add MAC address here. Please preserve the 00:16:3e as they are reserved for Xen vif=[ 'mac=00:16:3e:xx:xx:xx, bridge=br1', 'mac=00:16:3e:xx:xx:xx, bridge=br2', 'mac=00:16:3e:xx:xx:xx, bridge=br3', 'mac=00:16:3e:xx:xx:xx, bridge=br4', ] # Specify the path to the VLM disk file disk = [ 'tap:aio:/path/to/loadmaster-vlm-6.0-40cm-xen.disk,xvda,w' ] # Specify the path to the kernel and ramdisk root = "/dev/ram0" kernel = "/path/to/loadmaster-vlm-6.0-40cm-xen.linux" ramdisk = "/path/to/loadmaster-vlm-6.0-40cm-xen.initrd" vfb=['type=vnc,vncunused=1'] on_poweroff="destroy" on_reboot="restart" on_crash="destroy" #VNC Support. It is recommended to use VNC to administer the console. Use vncdisplay field to determine what port the VLM is piped to. vnc=1 vncviewer=1 vncdisplay=6 #DO NOT EDIT stdvga=0 viridian=0 apic=0 acpi=1 pae=1 serial="pty" Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 16 / 18

4 References Unless otherwise specified, the below documents can be found at http://www.kemptechnologies.com/documentation. Licensing, Feature Description Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 17 / 18

Document History Date Ver. Change Reason for Change Resp. Nov 2012 1.0 Initial draft of the document Initial draft of the document DD Nov 2012 1.1 Updates made Introduction of VLM-DE product DD Jan 2013 1.2 Minor updates made As per 6.0-42 updates DD May 2013 1.3 Updates made As per 7.0-4 updates DD July 2013 1.4 Minor updates Updates made LB Aug 2013 1.5 Updates made New licensing process LB Sep 2013 1.6 Minor changes Minor updates for 7.0-8 release LB Sep 2013 1.7 Minor changes Aesthetic changes LB Nov 2013 1.8 Release updates Minor updates for 7.0-8e release DD Jan 2014 1.9 Minor update Release update LB Mar 2014 1.10 Release update 7.0-14 release LB Copyright 2002-2014 KEMP Technologies, Inc. All Rights Reserved. Page 18 / 18