{excerpt}This page describes how to install and configure the backend VCL management node components including the required Perl modules, VCL daemon (vcld), and Windows utility dependencies.{excerpt}
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|Web Code Installation] . This also assumes that the perl-DBD-MySQL-3.x and the mysql client (mysql-5.x) packages are installed, for database communications.
Install the Subversion client if it is not already installed:
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.
To install these packages using yum:
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|http://search.cpan.org/] .
{}Note: Licensing information for each required Perl module is included below. The content of the “License:” lines was copied from the CPAN page for each module. The content of the other line was copied from the copyright section in the module‘s source code or from the module’s readme file.
This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
You may distribute under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl 5.10.0 README file.
Devel-StackTrace ** License: Perl (Artistic and [GPL|http://www.opensource.org/licenses/gpl-license.php] ) ** Copyright (c) 2000-2006 David Rolsky. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Exception-Class ** License: Perl (Artistic and [GPL|http://www.opensource.org/licenses/gpl-license.php] ) ** Copyright (c) 2000-2009 David Rolsky. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
HTML-Parser ** License: Perl (Artistic and [GPL|http://www.opensource.org/licenses/gpl-license.php] ) ** Copyright 1996-2008 Gisle Aas. All rights reserved. Copyright 1999-2000 Michael A. Chase. All rights reserved. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
IO-Compress ** License: Perl (Artistic and [GPL|http://www.opensource.org/licenses/gpl-license.php] )
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Copying and distribution are permitted under the terms of the Artistic License 2.0 (http://www.opensource.org/licenses/artistic-license-2.0.php ) or the GNU LGPL 2.1 ([http://www.opensource.org/licenses/lgpl-2.1.php|http://www.opensource.org/licenses/lgpl-2.1.php]).
Copyright (c) 2001, 2002, 2005. Brian Ingerson.
Some parts copyright (c) 2009 Adam Kennedy
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The following Perl modules are only required if VCL is configured to send instant messages via Jabber. Jabber support can be enabled or disabled by configuring the “jabber=” line in the vcld.conf file. The following modules do not need to be installed if Jabber support is disabled.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
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:
Run the script a 2nd time to check if all of the modules the script is configured to install were successfully installed. Output similar to the following should be displayed for each module:
URL: http://search.cpan.org/CPAN/authors/id/T/TI/TIMB/DBI-1.609.tar.gz Module filename: DBI-1.609.tar.gz Module name: DBI-1.609 Module package: DBI Checking if DBI is installed Module is already installed: DBI ==============================================================================
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:
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
Enter the CPAN shell: perl -MCPAN -e shell
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.
Search for a module using the “m” command: m /Zlib/ You should find the module you were looking for on a line like this:
Install the module: install Compress::Zlib
Answer yes if asked to install any prerequisite modules The last line you should see should be:
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 Vista or Server 2008 because it is included in the operating system.
Links to the downloads are below. You should be able to use the XP SP2 or SP3 version assuming the image you are capturing contains Windows XP Service Pack 3. We have seen problems with drivers not being installed correctly using the SP3 version of the deployment tools so the SP2 version is recommended.
Download: Windows XP Service Pack 2 Deployment Tools 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: {panel} /usr/local/vcl/tools/Windows_XP/Utilities/Sysprep {panel}Copy the extracted Windows Server 2003 Sysprep files to the following directory on the management node after they have been extracted: {panel} /usr/local/vcl/tools/Windows_Server_2003/Utilities/Sysprep {panel}The Sysprep directories should already exist on the management node because they exist the Subversion repository. There should already be a sysprep.inf file in each Sysprep directory. This is the base Sysprep template file for VCL included in the Subversion repository.
The Sysprep directories should contain the following files at a minimum: {panel} -rw-rw-r-- 1 root root 25600 Aug 18 17:32 setupcl.exe -rw-rw-r-- 1 root root 88576 Aug 18 17:32 sysprep.exe -rw-rw-r-- 1 root root 2574 Aug 18 17:32 sysprep.inf {panel}
Your organizations‘s Windows XP product key needs to be entered into the Windows XP sysprep.inf file. Find the ProductKey line and replace WIN_XP_PRO_KEY with *your organization’s Windows XP product key* in the following file: {panel} /usr/local/vcl/tools/Windows_XP/Utilities/Sysprep/sysprep.inf {panel}Your organizations‘s Windows Server 2003 product key needs to be entered into the Windows Server 2003 sysprep.inf file. Find the ProductKey line and replace WIN_2003_ENT_KEY with *your organization’s Windows Server 2003 product key* in the following file: {panel} /usr/local/vcl/tools/Windows_Server_2003/Utilities/Sysprep/sysprep.inf {panel}
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:
The resulting directory structure on the Windows computer will be:
The following list shows which driver files should be saved in the driver directories:
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:
This step is complicated. 3rd party mass storage hardware IDs and driver .inf file paths must be added to the SysprepMassStorage section in sysprep.inf for Windows XP and Windows Server 2003 in order for the saved image to boot properly on different hardware.
Example: LSI SAS drivers commonly need to be downloaded and the hardware IDs need to be added to the sysprep.inf files in order for computers with LSI SAS controllers to boot.
{color:#ff0000}{}NOTICE:{color} The WSName.exe utility is no longer available. The set_computer_name.vbs script which calls WSName.exe will be rewritten for the 2.2 release of VCL. In the meantime, this script is being left intact in case you have a previously released version of WSName.exe or are able to obtain it from another source.
The wsname.exe utility is used by VCL to name Windows computers. It does a reverse DNS lookup so that the computer name is set to the name registered for its public IP address. The utility is called by set_computer_name.vbs when a Windows image is loaded. The utility is not vital for the load process to work. However, the computer will receive a random name if the script is missing or fails to run.
If you do have a previously released version of WSName.exe or are able to locate it from another souce, save WSName.exe in the following location on the management node: {panel} /usr/local/vcl/tools/Windows/Utilities/WSName/wsname.exe {panel}
NewSID.exe is used to change the SID of a Windows computer if Sysprep is not used. Download the NewSID.exe utility:
Download: NewSID.exe
Save the NewSID.exe utility in the following location on the management node: {panel} /usr/local/vcl/tools/Windows/Utilities/NewSID/newsid.exe {panel}
SPDrvScn.exe is used before an image is captured to enter the paths of drivers to the Windows registry so that they are loaded when Sysprep attempts to install devices. Download the SPDrvScn.exe utility:
Download: SPDrvScn.exe
Save the SPDrvScn.exe utility in the following location on the management node: {panel} /usr/local/vcl/tools/Windows/Utilities/SPDrvScn/spdrvscn.exe {panel}
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:
Add the following lines to the top of the configuration file.
Host <vmhost> <vmhost ip> UserKnownHostsFile /dev/null StrictHostKeyChecking no
Where:
- Is a wildcard reference to the hostnames for your virtual machines. ** For example, if your VM hostnames look like: vmhost1, vmhost2, vmhost3.... then replace with “vmhost*”
- 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 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.
Start the vcld service: /sbin/service vcld start You should see output similar to the following:
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� ]
/etc/init.d/vcld start