Product Documentation

Installing NetScaler MAS on Linux-KVM Server

Aug 30, 2017

Virtualization platforms on which the Citrix NetScaler Management and Analytics System (MAS) can be provisioned include Linux-KVM.

Before you install NetScaler MAS on Linux-KVM, make sure that your system has the hardware virtualization extensions, and verify that the CPU virtualization extensions are available. Verify that virsh (a command-line tool for managing virtual machines) is available on the hypervisor.

Use your administrator credentials to log on to Citrix.com website, access the latest NetScaler MAS setup files, and download them onto your computer. Then, install the NetScaler MAS on your Linux-KVM platform and configure it for your network.

Prerequisites

Before installing the NetScaler MAS virtual appliance, verify that Linux-KVM version 3.6.11-4 and later is installed on hardware that meets the minimum requirements.

Hardware Requirements

Component Requirement

CPU

A 64-bit x86 processor with the hardware virtualization features that are included in the AMD-V and Intel VT-X processors. Provide at least 2 CPU cores to host Linux-KVM.

Note: To test whether your CPU supports Linux host, enter the following command at the host Linux shell prompt:

. egrep'^flags.* ( vmx | svm ) '/proc/cpuinfo

If the BIOS settings for the above extension are disabled, you must enable them in BIOS.

There is no specific recommendation for processor speed, but higher the speed, better is the performance of the NetScaler MAS.

Memory (RAM)

Minimum 4 GB for the host Linux kernel. Add additional memory as required by the VMs.

Hard Disk

Calculate the space for Host Linux kernel and VM requirements. A single NetScaler MAS VM requires 120 GB of disk space.

Note

The memory and hard disk requirements specified above are for deploying NetScaler MAS on the OpenStack platform, considering that there are no other virtual machines running on the host. The hardware requirements for OpenStack depends on the number of virtual machines running on it.

Software Requirements

Citrix recommends newer kernels, such as the 64-bit version of the 3.6.11-4 kernel or later.

Guest Virtual Machine Hardware Requirements

NetScaler virtual machine and NetScaler MAS support only IDE hard disk type.

Component Requirement
RAM

32 GB

Note: The default value is 8 GB. Citrix recommends that you increase the default value to 32 GB for better performance.

Virtual CPU

8 CPUs

Note: The default is 2 CPUs. Citrix recommends that you increase the default value to 8 CPUs for better performance.

Storage Space

The default value is 120 GB. Actual storage requirement will depend on NetScaler MAS sizing estimation.

If your NetScaler MAS storage requirement exceeds 120 GB, you to have to attach an additional disk. Note that you can add only one additional disk.

Citrix recommends you to estimate storage and attach additional disk at the time of initial deployment.

For more information, see How to Attach an Additional Disk to NetScaler MAS.

Virtual Network Interfaces 1
Throughput 1Gbps or 100 Mbps

 

8 CPUs

Note: The default is 2 CPUs. Citrix recommends that you increase the default value to 8 CPUs for better performance.

8 CPUs

Note: The default is 2 CPUs. Citrix recommends that you increase the default value to 8 CPUs for better performance.

Networking Requirements

NetScaler MAS supports only one virtIO para-virtualized network interface. This interface should be connected to the management network of the Linux-KVM host, so that the NetScaler MAS and Linux-KVM can communicate.

Downloading NetScaler Management and Analytics System Setup Files

To download the NetScaler Management and Analytics System setup files from www.citrix.com:

  1. Open a web browser and type www.citrix.com in the address bar.
  2. Click Log In, enter your login credentials, and then again click Log In.
  3. Navigate to Downloads section.
  4. From the Downloads drop-down list, select NetScaler ADC.
  5. On the NetScaler ADC page, select the release. For example, select Release 11.1.
  6. Click Components to expand it, and click NetScaler Management and Analytics System.
  7. Scroll down to the list of available builds, and then select a build. For example, select NetScaler MAS Image for Linux-KVM, 11.1-Build 44.5.
  8. Click Download File, accept the end-user license agreement, and download the compressed image file to any folder on your local machine.  

Installing the NetScaler Management and Analytics System on Linux-KVM

  1. Using SSH, log on to the KVM host.
  2. At the CLI prompt, by using any of the file transfer programs, copy the image to a folder on the server.
  3. Navigate to the directory where you have saved the downloaded image.
  4. Perform these at the command line:
    1. List the files in the directory verify the presence of the image file.
    2. Use the tar command to untar the NetScaler Management and Analytics System image file. The unzipped package contains the following components:
      1. A domain XML file that specifies the NetScaler MAS attributes
      2. A text file that specifies the check sum of the domain disk image
      3. A domain disk image
         
Example Copy

tar -xvfz MAS-KVM.tgz

MAS-KVM.xml

MAS-KVM.qcow2

checksum.txt

localized image

          c.  Create a copy of MAS-KVM.xml as MAS1-KVM.xml, as a back-up option. Open the MAS1-KVM.xml file by using the vi editor.

          d.  Edit MAS1-KVM.xml for the following networking attributes:
               i.  name - Specify the name.
               ii.  mac - Specify the MAC address.
               iii.  source file - Specify the absolute disk-image source path. The file path has to be absolute.

Note

The domain name and the MAC address must be unique.

               iv.  mode - Specify the mode.
               v.  model type - Set to virtIO.
               vi.  source dev - Specify the interface.

Example Copy

<name> MAS1-KVM</name>

<mac address='52:54:00:29:74:b3'/>

<source file='/var/ MAS-KVM.qcow2'/>

<source dev='eth0' mode='bridge'/>

<model type='virtio'/>

          e. Define the VM attributes in the MAS1-KVM.xml file by using the following command:
              virsh define <FileName>.xml
 

Example Copy

virsh define MAS-KVM.xml

Domain MAS defined from MAS-KVM.xml

localized image

          f.  Start the NetScaler MAS by entering the following command: 
              virsh start [<DomainName> | <DomainUUID>]

Example Copy

virsh start MAS

Domain MAS started

localized image

          g. You can connect to the NetScaler MAS virtual machine by using the following command: 
              virsh console <DomainName>

Example Copy

virsh console MAS

Connected to domain MAS

Escape character is ^]

localized image

Configuring the NetScaler Management and Analytics System

Note

On some Linux KVM hosts, FreeBSD guests fail to restart properly if they have more than one CPU. When The NetScaler MAS virtual appliance is restarted, the NetScaler MAS CLI and GUI become unresponsive.For details, see https://bugs.launchpad.net/qemu/+bug/1329956

To avoid the NetScaler MAS CLI and GUI from becoming unresponsive when the NetScaler MAS virtual appliance is restarted, shut down all the virtual machines on the KVM host, and perform the following on the KVM host:

  1. Remove the kvm_intel module using the following command:
    rmmod kvm_intel
  2. Disable APICv and reload kvm_intel module using the following command:
    modprobe kvm_intel enable_apicv=N
  3. Start the virtual machines on the KVM host.

After installing the NetScaler MAS, allow about ten minutes for the services to become available, and then log on to the NetScaler MAS.

  1. At the command line, use the default system administrator credentials to log on to the system:
    • Username: nsroot
    • Password: nsroot

Note

After logging on for the first time, you should change the administrative password. Then, configure the MAS to function in your network. You can change the password from the NetScaler MAS user interface. From the NetScaler MAS home page, navigate to System > User Administration > Users. Select the user and click Edit, and then update the password in the Password field.

     2.  At the prompt, type:
          shell
     3.  Type networkconfig to enter the NetScaler MAS initial network configuration menu. Configure the management IP address.
     4.  To complete the initial network configuration of NetScaler MAS, follow the prompts. The console displays the NetScaler MAS initial network configuration options for setting the following parameters for the NetScaler MAS. The host name is populated by default.
          a.   Enter 2 to update NetScaler MAS IPv4 address - management IP address at which you access a NetScaler MAS
          b.   Enter 3 to update Netmask - subnet mask associated with the Management IP address
          c.   Enter 4 to update Gateway IPv4 address - default gateway IP address for the subnet of the Management IP address of the NetScaler MAS
          d.   Enter 7 to save and quit - saves your configuration changes and exits the system.

localized image

     5.   Execute the deployment script by typing the command at the shell prompt:

deployment_type.py

      6.   In the deployment screen that appears, select the deployment type as NetScaler MAS server.

localized image

 7.     Type Yes to deploy NetScaler MAS as a standalone deployment.

 8.     Type Yes to restart the NetScaler MAS server.

 9.     After NetScaler MAS server restarts, log on to NetScaler MAS by using the default administrator credentials as nsroot/nsroot through the command line or the GUI.

You can later access the NetScaler MAS by typing the IP address of the NetScaler MAS server in the address bar of your browser. The default administrator credentials to log on to the server are nsroot/nsroot.