Page History

Assumptions

The following instructions assume the VCL database has been installed and configured and that the managment node information has been added to the database as described on the web code installation page. This also assumes that the perl-DBD-MySQL-3.x and the mysql client (mysql-5.x) packages are installed, for database communications.

Installing VCL Management Node Code - Perl Daemon

1. If you haven't already done so, download and extract a copy of the latest release. There is a link to it under the Project Resources section on our wiki home page. Look for "Current version".
2. copy the "managementnode" directory to a location, typically /usr/local

   Code Block
   cp -r managementnode /usr/local/vcl

Install Required Packages

The following packages to be installed on the OS before installing the required Perl modules.  These packages must be installed if they were not installed as part of your base Linux install.  It is easiest to use the package management utility for your OS --- yum, rpm, or other.

• expat
• expat-devel
• gcc
• krb5-libs
• krb5-devel
• libxml2
• libxml2-devel
• nmap
• openssl
• openssl-devel
• perl-DBD-MySQL
• xmlsec1-openssl

To install these packages using yum:

yum install expat expat-devel gcc krb5-libs krb5-devel libxml2 libxml2-devel openssl openssl-devel perl-DBD-MySQL xmlsec1-openssl nmap -y

Install Required Perl Modules

The VCL Perl code running on the management node requires additional Perl modules in order to run. These Perl modules are available from CPAN - The Comprehensive Perl Archive Network. A search engine for CPAN modules is available at search.cpan.org. The Perl modules are licensed under the Artistic and GPL licenses.

• Class-Data-Inheritable
• Compress-Raw-Zlib
• Crypt-SSLeay
• DBI
• Devel-StackTrace
• Digest-SHA1
• Exception-Class
• HTML-Parser
• IO-Compress
• libwww-perl
• MailTools
• Object-InsideOut
• RPC-XML
• XML-Parser
• YAML

Run install_perl_libs.pl Script

A script is provided in the managementnode/bin directory called install_perl_libs.pl which will attempt to download and install the required perl libraries.  Run the script:

perl /usr/local/vcl/bin/install_perl_libs.pl

The script will hang or terminate if it encounters a problem.  If this occurs, manually run the last command the script attempted.  The command should be listed in the output.  You will need to troubleshoot the problem.  The most likely cause of the problem is a missing Linux package.  Make sure the required packages are installed.

How to Test if Required Perl Modules are Installed

Run the following command to execute the utils.pm file:

perl /usr/local/vcl/lib/VCL/utils.pm

Executing utils.pm does not actually do anything but this will tell you if VCL will be able to run.  If any Perl modules are missing you will see "Can't locate" lines:

Can't locate HTTP/Headers.pm in @INC (@INC contains:...)

Once all of the required modules are installed, you should see output similar to the following:

BIN PATH: /usr/local/vcl/lib/VCL
pre-execution: config file being used: /etc/vcl/vcld.conf
Uncaught exception from user code:
        VCLD : /etc/vcl/vcld.conf does not exist, exiting --  No such file or directory
BEGIN failed--compilation aborted at /usr/local/vcl/lib/VCL/utils.pm line 616.
 at /usr/local/vcl/lib/VCL/utils.pm line 616

What to do if a Module is Missing

1. Determine the name of the missing module by looking at the "Can't locate" line
2. Search for the missing module on search.cpan.org and install it manually

How to Install a Perl Module Manually

1. Change directories to /tmp:
   cd /tmp 
2. Download the module's source package using wget:
   wget http://search.cpan.org/CPAN/authors/id/G/GA/GAAS/libwww-perl-5.827.tar.gz
3. Unpack the source package using tar:
   tar xzf libwww-perl-5.827.tar.gz
4. The previous command should have created a libwww-perl-5.827 directory, change to this directory:
   cd libwww-perl-5.827
5. Create a makefile with the following command:
   perl Makefile.PL
6. Compile the module:
   make
7. Test the module:
   make test
8. Install the module:
   make install
   The last line you should see should be:

   No Format
   /usr/bin/make install  -- OK

How to Install a Perl Module Using CPAN

1. Enter the CPAN shell:
   perl -MCPAN -e shell
2. You will need to configure CPAN if it's the first time it is being run. Enter No at the first prompt to auto-configure the CPAN module.
3. Search for a module using the "m" command:
   m /Zlib/
   You should find the module you were looking for on a line like this:

   No Format
   Module          Compress::Zlib  (P/PM/PMQS/IO-Compress-2.020.tar.gz)

4. Install the module:
   install Compress::Zlib
5. Answer yes if asked to install any prerequisite modules
   The last line you should see should be:

   No Format
   /usr/bin/make install  -- OK

Configure vcld.conf

1. Create the /etc/vcl directory:
   mkdir /etc/vcl 
2. Copy the generic vcld.conf file to /etc/vcl:
   cp /usr/local/vcl/etc/vcl/vcld.conf /etc/vcl
3. Edit the /etc/vcl/vcld.conf file:
   vi /etc/vcl/vcld.conf
   The following lines must be configured in order to start the VCL daemon (vcld) and allow it to check in to the database:
   • FQDN - the fully qualified name of the management node, this should match the name that was configured for the management node in the database
   • server - the IP address or FQDN of the database server
   • LockerWrtUser - database user account with write privileges
   • wrtPass - database user password
4. Save the vcld.conf file

Install the VCL Daemon (vcld) Service

1. Copy the vcld service script to /etc/init.d and name it vcld:
   cp /usr/local/vcl/bin/S99vcld.linux /etc/init.d/vcld
2. Add the vcld service using chkconfig:
   /sbin/chkconfig --add vcld
3. Configure the vcld service to automatically run at runtime levels 3-5:
   /sbin/chkconfig --level 345 vcld on

Start and Check the vcld Service

1. Start the vcld service:
   /sbin/service vcld start
   You should see output similar to the following:

   No Format

   Starting vcld daemon: BIN PATH: /usr/local/vcl/bin pre-execution: config file being used: /etc/vcl/vcld.conf FQDN is not listed pre-execution: process name is set to: vcld pre-execution: verbose mode is set to: 1 pre-execution: testing mode is set to: 0 pre-execution: log file being used: /var/log/vcld.log pre-execution: PID file being used: /var/run/vcld.pid Created process 23696 renamed to vcld ...                                                            [  OK  ]

   Note: the vcld service can also be started by running the service script directly:
   /etc/init.d/vcld start
2. Check the vcld service by monitoring the vcld.log file:
   tail -f /var/log/vcld.log
   You should see the following being added to the log file every few seconds if the management node is checking in with the database:

   No Format
   2009-06-16 16:57:15|15792|vcld:main(165)|lastcheckin time updated for management node 18: 2009-06-16 16:57:15

   
   

Configure the SSH Client

To insure that the management node can SSH into your virtual machines without problems, you will need to edit the SSH client config for the root user:

vi /root/.ssh/config

Add the following lines to the top of the configuration file.

Host <vmhost> <vmhost ip>
   UserKnownHostsFile /dev/null
   StrictHostKeyChecking no

Where:

• <vmhost> - Is a wildcard reference to the hostnames for your virtual machines.
  • For example, if your VM hostnames look like: vmhost1, vmhost2, vmhost3.... then replace <vmhost> with "vmhost*"

• <vmhost ip> - Is a wildcard IP reference to the IPs used by your virtual machines.
  • For example, if your VMs all have IP addresses starting with 10.0.0, then replace <vmhost ip> with "10.0.0.*"

This will insure that new VM hosts will not hang on the known hosts prompts when the management node attempts to connect to them for the first time.

Download Required Utilities & Drivers

Windows XP and Server 2003 Deployment Tools (Sysprep)

The Windows XP and Server 2003 Deployment Tools are available for free from Microsoft and are required in order for the capture of Windows XP and Server 2003 VCL images to work.  The Sysprep utility is included in the Deployment Tools.  You do not need to download Sysprep for Windows 7 or Windows Server 2008 because it is included in the operating system.

Download: Windows XP Service Pack 3 Deployment Tools
Download: System Preparation tool for Windows Server 2003 Service Pack 2 Deployment

The Sysprep files need to be extracted from the file you download which is in Microsoft's .cab format.  It is easiest to extract the files on a Windows computer.  Windows Explorer is able to open the .cab file and then the files contained within can be copied elsewhere.  There are also some Linux utilities which claim to be able to extract .cab files.

Copy the extracted Windows XP Sysprep files to the following directory on the management node after they have been extracted:

The Sysprep directories should already exist on the management node because they exist the Subversion repository.  The Sysprep directories should contain the following files at a minimum:

Your Windows product keys and/or KMS server addresses need to be entered into the VCL database in order to capture a Windows image using Sysprep.  Enter the information into the database by running the the following command:

Select "Windows OS Module" and follow the prompts.

Download Drivers

Drivers which aren't included with Windows must be downloaded and saved to the management node. The drivers required will vary greatly depending on the hardware. The only way to know what additional drivers you need is to install Windows on a computer and check for missing drivers.

The drivers must be copied to the appropriate directory on the management node. The VCL image capture process copies the driver directories to the computer before an image is captured. Drivers from multiple directories will be copied based on the version of Windows being captured. There are driver directories under tools for each version of Windows (Windows XP, Windows Vista) and for each version group of Windows (version 5, 6). This allows drivers which are common to multiple versions of Windows to be shared in the management node tools directory structure.

For example, if a chipset driver works for all versions of Windows, it can be saved in:
tools/Windows/Drivers/Chipset

If Windows XP and Windows Server 2003 both use the same network driver, it can be saved in:
tools/Windows_Version_5/Drivers/Network

If a storage driver only works for Windows XP, it should be saved in:
tools/Windows_XP/Drivers/Storage

During the image capture process, each Windows version directory is copied to the computer under C:\Cygwin\home\root\VCL. The order in which the Windows version directories are copied goes from most general to most specific.  In the example above, the order would be:

1. tools/Windows/Drivers/Chipset
2. tools/Windows_Version_5/Drivers/Network
3. tools/Windows_XP/Drivers/Storage

The resulting directory structure on the Windows computer will be:

• C:\Cygwin\home\root\VCL\Drivers
  • \Chipset - driver works for all versions of windows
  • \Network - driver works for Windows XP and Server 2003
  • \Storage - driver only works for Windows XP

The following list shows which driver files should be saved in the driver directories:

• tools/Windows/Drivers - drivers common to all versions of Windows
  • tools/Windows_Version_5/Drivers - drivers used by Windows XP and Server 2003
    • tools/Windows_Version_XP/Drivers - drivers only used by Windows XP
    • tools/Windows_Version_Server_2003/Drivers - drivers only used by Windows Server 2003
  • tools/Windows_Version_6/Drivers - drivers used by Windows Vista and Server 2008
    • tools/Windows_Vista/Drivers - drivers only used by Windows Vista
    • tools/Windows_Server_2008/Drivers - drivers only used by Windows Server 2008

The directory structure under each Drivers directory does not matter. It is helpful to organize each directory by driver class, and each directory should be organized using the same theme.  For example:

• tools/Windows_Version_XP/Drivers
  • Chipset
  • Network
  • Storage
  • Video