install

FAST Enterprise Search Platform version:5.1 ESP Installation Guide Document Number: ESP1026, Document Revision: D, September 28, 2007Copyright Copyright © 1997-2007 by Fast Search & Transfer ASA (“FAST”). Some portions may be copyrighted by FAST’s licensors. All rights reserved.The documentation is protected by the copyright laws of Norway, the United States, and other countries and international treaties. No copyright notices may be removed from the documentation. No part of this document may be reproduced, modified, copied, stored in a retrieval system, or transmitted in any form or any means, electronic or mechanical, including photocopying and recording, for any purpose other than the purchaser’s use, without the written permission of FAST. Information in this documentation is subject to change without notice. The software described in this document is furnished under a license agreement and may be used only in accordance with the terms of the agreement. Trademarks FAST ESP, the FAST logos, FAST Personal Search, FAST mSearch, FAST InStream, FAST AdVisor, FAST Marketrac, FAST ProPublish, FAST Sentimeter, FAST Scope Search, FAST Live Analytics, FAST Contextual Insight, FAST Dynamic Merchandising, FAST SDA, FAST MetaWeb, FAST InPerspective, GetSmart, NXT, LivePublish, Folio, FAST Unity, and other FAST product names contained herein are either registered trademarks or trademarks of Fast Search & Transfer ASA in Norway, the United States and/or other countries. All rights reserved. This documentation is published in the United States and/or other countries. Sun, Sun Microsystems, the Sun Logo, all SPARC trademarks, Java, and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Netscape is a registered trademark of Netscape Communications Corporation in the United States and other countries. Microsoft, Windows, Visual Basic, and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Red Hat is a registered trademark of Red Hat, Inc. UNIX is a registered trademark of The Open Group in the United States and other countries. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. AIX and IBM Classes for Unicode are registered trademarks or trademarks of International Business Machines Corporation in the United States, other countries, or both. HP and the names of HP products referenced herein are either registered trademarks or service marks, or trademarks or service marks, of Hewlett-Packard Company in the United States and/or other countries. Remedy is a registered trademark, and Magic is a trademark, of BMC Software, Inc. in the United States and/or other countries. XML Parser is a trademark of The Apache Software Foundation. All other company, product, and service names are the property of their respective holders and may be registered trademarks or trademarks in the United States and/or other countries. Restricted Rights Legend The documentation and accompanying software are provided to the U.S. government in a transaction subject to the Federal Acquisition Regulations with Restricted Rights. Use, duplication, or disclosure of the documentation and software by the government is subject to restrictions as set forth in FAR 52.227-19 Commercial Computer Software-Restricted Rights (June 1987).Contact Us Web Site Please visit us at: http://www.fastsearch.com/Contacting FAST Fast Search & Transfer, Inc. Cutler Lake Corporate Center 117 Kendrick Street, Suite 100 Needham, MA 02492 USA Tel: +1 (781) 304-2400 (8:30am -5:30pm EST) Fax: +1 (781) 304-2410 Technical Support and Licensing Procedures Technical support for customers with active FAST Maintenance and Support agreements, e-mail: tech-support@fastsearch.com For obtaining FAST licenses or software, contact your FAST Account Manager or e-mail: customerservice@fastsearch.com For evaluations, contact your FAST Sales Representative or FAST Sales Engineer. Product Training E-mail: fastuniversity@fastsearch.com Sales E-mail: sales@fastsearch.comContents Preface..................................................................................................ii Copyright.................................................................................................................................ii Contact Us..............................................................................................................................iii Chapter 1: Introduction.......................................................................7 Introduction..............................................................................................................................8 Installation Types...........................................................................................................8 Key Concepts................................................................................................................8 Chapter 2: Requirements..................................................................11 Requirements........................................................................................................................12 Operating Systems......................................................................................................12 Software......................................................................................................................15 Hosts..........................................................................................................................16 Hardware.....................................................................................................................17 Chapter 3: License.............................................................................19 License..................................................................................................................................20 Installing the License File............................................................................................20 Upgrading the License File..........................................................................................21 License File Reference................................................................................................22 Chapter 4: Before you begin.............................................................23 Before You Begin....................................................................................................................24 Chapter 5: Standard Installation.......................................................27 Standard Installation...............................................................................................................28 Starting the Installer....................................................................................................28 Installing a Single-Node Configuration........................................................................29 Installing a Multinode Configuration............................................................................30 Repeating an Installation.............................................................................................37 Chapter 6: Silent Installation............................................................39 Silent Installation...................................................................................................................40 Running the Silent Installer..........................................................................................40 Defining a Configuration File.......................................................................................42 5Chapter 7: Verifying the Installation.................................................57 Verifying the Installation.........................................................................................................58 Chapter 8: Uninstalling......................................................................61 Uninstalling............................................................................................................................62 Chapter 9: Fault Tolerance................................................................63 Installing Multiple License Servers.........................................................................................64 Chapter 10: Install Profile DTD.........................................................65 Install Profile DTD..................................................................................................................66 6FAST Enterprise Search PlatformChapter 1Introduction This chapter provides an introduction to the FAST ESP installer, the installation types and the key concepts used in this guide. Topics: • IntroductionIntroduction A FAST ESP installation provides content collection, document processing, indexing and query processing, and administrative services. Installations typically span multiple host nodes, where each node hosts one or more of these components, but it is also possible to install FAST ESP on a single host node for evaluation or demonstration purposes. The memory, disk and CPU consumption of FAST ESP's various components, for example content collection and document processing, varies. For that reason, you might want to refer to the Deployment Planning Guide before you start installing, to determine how to distribute the various components and meet your system requirements in a cost-efficient manner. The standard FAST ESP installer can be run both with a graphical user interface and in a console mode. This is further described in the Standard Installation chapter. In addition, FAST ESP provides a silent installer that is launched as an ordinary executable with a configuration file as a parameter. Please refer to the Silent Installation chapter for details. Installation Types The FAST ESP Installer provides three different installation types: single-node, multinode and advanced. Single-node The single-node installation type is provided for evaluation and demonstration purposes. Using the single-node configuration, the FAST ESP installer installs all the required (as well as the most common) components on one single machine. Multinode FAST ESP installations typically span multiple host nodes. Using the multinode configuration, the FAST ESP installer enables you to select and deploy components across the available hosts. Note that the installer's console mode does not support multinode configuration due to the interface complexity. Please refer to the advanced installation type for details on how to install multinode configurations on machines that do not support the graphical user interface. Advanced The advanced installation type allows you to repeat a previous FAST ESP installation by providing the installer with an install profile describing the installation. Whenever you install FAST ESP, an install profile ( InstallProfile.xml ) is automatically created and located in your installation directory. In particular, the advanced installation type allows you to install a multinode configuration on a machine that does not support the installer's graphical user interface: First, you complete a multi-node installation on a machine that does support the GUI mode. Save the install profile that is automatically generated during the installation. Then you can run the installer in console mode on the machine in question. By choosing the advanced installation type, the installer allows you to use the previously created multinode install profile to set up your configuration. In addition, you can use the advanced installation type to add new nodes to a running installation. Please refer to the Installing Nodes from an Install Profile in the Operations Guide for details. Key Concepts This section introduces you to some of the basic concepts of FAST ESP, i.e., the ones that are useful to know about when installing. Please refer to the Product Overview Guide for a more elaborated description and explanation of FAST ESP's basic concepts, features, and components. 8FAST Enterprise Search PlatformContent Collection In FAST ESP, content can be collected by crawling a set of web-servers, traversing locally accessible file servers, using connectors, or using the Content API from custom built applications. Document Processing The document processing component processes the collected data through a series of pipelines. Typical tasks include teaser generation, vectorization, lemmatization, language detection, encoding normalization, XSLT processing of XML Data and web analyzer. Indexing and Query Processing The indexing and query processing component indexes the processed data and makes it available to the end user. Administrative Services The administrative service component provides central control of configuration, logging and licenses. Installation Directory The installation directory is the FAST ESP installer's target directory. For example /home/fastuser/ESP on UNIX. Please note that this should not be an existing directory. Base Port FAST ESP uses the base port when calculating its static ports, i.e., FAST ESP's static ports are offset from this value. The default base port is 13000. Install Profile The install profile ( InstallProfile.xml ) is automatically created when you install FAST ESP and is located in the installation directory. It contains a complete system description, allocating hosts to services. Index Profile An index profile defines the layout of the searchable index, and specifies how fields will be treated by query and result processing. An index profile is defined through an XML based configuration file that you can upload and deploy using FAST ESP's administrator interface. On the other hand, during the installation process, the installer will ask for an index profile. For that reason you should decide which one to use before you begin, since altering the profile later on might require re-feeding of all content. For a test or development installation you may use one of the default index profiles, but in most cases you will have to customize one of the default profiles to fit your application's needs. The default profiles are: Index Profile Description Standard Web Profile The default index profile for web search applications. The default index profile for web search applications that utilize lemmatization (i.e., grammatical normalization), an advanced linguistic feature. Web Profile with Lemmatization The default index profile for use with geo-search, i.e., sorting and/or filtering query results based on geographical distance from a defined geographical location. Profile with geo-search Tip: After installation, you can find the default index profiles in the index-profiles directory in your installation directory. 9 IntroductionWhen creating a custom index profile, you must edit and save it prior to installation. Please refer to the Index Profile Feature Management chapter of the Configuration Guide for a detailed description of the various options and features. 10 FAST Enterprise Search PlatformChapter 2Requirements Topics: This chapter describes the requirements for installing FAST ESP. • RequirementsRequirements There are several requirements that must be met to install and make full use of FAST ESP.These requirements span from operating systems and software to hosts and hardware. Operating Systems FAST ESP runs on multiple platforms. Please refer to the release notes and the readme.txt file for the latest updates on patches and kernel versions. Important: FAST ESP is verified against the updates and patch levels indicated in the tables below. You should not use lower update/patch levels. FAST normally expects higher update/patch levels for the same operating system version to work equally good or better. Important: Running ESP on VMware is only supported for small installations with performance requirements substantially lower than a single server node. Benchmarking indicates a performance degradation of 30-40% when running in a virtual environment, and FAST does not recommend using VMware unless there are very strong reasons for doing so. Contact FAST Global Services for more information. Important: Certain new server architectures (in particular SUN T1000/T2000 servers) include CPUs that are able to handle a large number of parallel threads, where each thread has relatively low performance. Note that parts of ESP are not optimized for such architectures, e.g., indexing, document processing and execution of complex queries. For this reason, FAST does not recommend deploying ESP on such large multi-CPU architectures. Important: When installing a multinode configuration, all hosts must be running on the same platform type. Red Hat Platform OS Requirements and Patch Level Red Hat Enterprise Linux 3 -Taroon (Update Intel x86 4) 2.4.21-27.EL Wed Dec 1 21:59:02 EST 2004 i686 i686 i386 WS, ES, AS GNU/Linux glibc-2.3.2-95.30 compat-libstdc++-7.3-2.96.128 Red Hat Enterprise Linux 4 -Nahant (Release Intel x86 4) 2.6.9-5.EL Wed Jan 5 19:30:39 EST 2005 i686 i686 i386 GNU/Linux WS, ES, AS glibc-2.3.4-2 compat-libstdc++-33-3.2.3-47.3 Red Hat Enterprise Linux 4 (64 bit) -Nahant Intel x86 or AMD (Update 2) 2.6.9-22.EL Mon Sep 19 18:00:54 EDT 2005 x86_64 x86_64 x86_64 WS, ES, AS GNU/Linux (ESP running 32-bit mode) glibc-2.3.4-2.13 compat-libstdc++-33-3.2.3-47.3 12 FAST Enterprise Search PlatformNote: When deploying on a Red Hat platform, please note that FAST recommends the latest available update version. Tip: Use the following commands to retrieve your platform's characteristics. • cat /etc/redhat-release • uname -a • rpm -qa | grep compat • Red Hat Enterprise Linux 4: rpm -q -f /lib/libc-2.3.4.so | grep -F"glibc" Red Hat Enterprise Linux 3: rpm -q -f /lib/libc-2.3.2.so | grep -F"glibc" SuSE Platform OS Requirements and Patch Level Intel x86 SuSE Linux Enterprise Server 9 Linux 2.6.5-7.97 #1 SMP Fri Jul 2 14:21:59 UTC 2004 i686 compat-2004.7.1-1.2 (or later) X-free libraries: • xf86tools-0.1-955.5 • XFree86-4.3.99.902-43.22 Intel x86 SuSE 10 SUSE LINUX 10.1 (i586) 2.6.16.13-4-bigsmp #1 SMP Wed May 3 04:53:23 UTC 2006 i686 i686 i386 GNU/Linux compat-libstdc++-5.0.7-20 compat-2006.1.25-9 Tip: Use the following commands to retrieve your platform's characteristics. • uname -a • rpm -qa |grep xf86 • rpm -qa | grep compat • cat /etc/SuSE-release Sun Solaris Platform OS Requirements and Patch Level Release: 5.9 Sun Solaris 9 (sparc) Kernel architecture: sun4u Application architecture: sparc Kernel version: SunOS 5.9 Generic 118558-11 Jul 2005 13 RequirementsPlatform OS Requirements and Patch Level Shared library patch for C++: 111711-12 Wed Nov 10 09:44:44 MST 2004 Math Library (libm) patch id 111722-04 Release: 5.10 Sun Solaris 10 (sparc) Kernel architecture: sun4u Application architecture: sparc Kernel version: SunOS 5.10 Generic Release: 5.10 Sun Solaris 10 (x86) Kernel architecture: x86 Kernel version: SunOS 5.10 Generic_118855-36 Recommended filesystem: USF Note: The ZFS filesystem is not recommended for use with FAST ESP. The rationale is that ZFS is not suitable for applications where random read is predominant, because it uses a large block size and makes extensive use of prefetching of data during reads. The block size may be tuned to help I/O performance, but the prefetching of data cannot. Important: When installing a multinode configuration on Solaris, Open SSH must run on all hosts in the configuration. Tip: Use the following commands to retrieve your platform's characteristics. • /usr/bin/showrev • cat /etc/release • uname -a • ls -l /usr/lib/libC* Windows Platform OS Requirements and Patch Level Version: 5.00.2195 Microsoft Windows Server 2000, Std. Edition Service Pack: 4 Version: 5.2.3790 Microsoft Windows Server 2003, Std. Edition Service Pack: 1 Note: When installing a multinode configuration under Windows, your temporary directory must be on a partition where the administrative share is enabled, and that you are able to access. To test if the administrative share is enabled and accessible on partition C: on the myhost.example.com host , for example, you can call dir \\myhost.example.com\c$ from a different host. This should produce the same output as if the command was run locally on myhost.example.com . Tip: Use the following resources to retrieve your platform's characteristics. • Start>Control Panel>System>General 14 FAST Enterprise Search Platform• C:\Program Files\Common Files\Microsoft Shared\MSInfo\msinfo32.exe Software This section describes the software requirements that you must take into consideration when installing FAST ESP.Important: In general, FAST recommends that the ESP hosts do not run any other heavy software. Web Browsers FAST ESP supports the following web browsers: • Microsoft Internet Explorer (version 6.0 or later) • Netscape (version 7.1 or later) • Safari • Firefox Note: When using Microsoft Internet Explorer to access the FAST ESP administrator interface, you must either disable the Internet Explorer Enhanced Security Configuration or add the URL pointing to the FAST ESP Administrator Interface to the list of trusted sites. Clock FAST search servers require that the clock is kept in sync, and that it is not abruptly corrected forwards or backwards. Abrupt clock-changes may lead internal processes (such as the query and result server and the dispatch processes) to believe that there are communication problems or that some processes have been silent for too long (i.e., that they have died). This will in turn lead to warnings in the logs and automatic restart of processes. For this reason you might want to consider using professional software for keeping clocks adjusted and in sync, avoiding manual clock adjustments. Note: FAST ESP does not support daylight saving time on Windows. Network File System (NFS) For a small-scale search system with limited I/O load, FAST ESP may use a NAS based storage system. When combining this with a NFS mounted directory, a lock daemon must be running on the NFS server. FLEXLM License Manager Ensure that the FLEXLM license manager is not running on any of your installation hosts. Internal Firewall FAST recommends that you do not have any active internal firewalls (e.g., iptables and Windows firewall) on any host running FAST ESP. UNIX: Shell Please note that FAST ESP only supports Bourne shell variants as default login shell on UNIX, i.e., C-shell is not supported. 15 RequirementsWindows: Anti-virus Software FAST recommends that you do not have anti-virus software on servers running FAST ESP under Windows. If anti-virus software must be installed as a business requirement for your environment, you must configure exclude rules within the anti-virus software to avoid scanning the entire FAST ESP data directory (i.e., $FASTSEARCH/data ). Note: Some anti-virus and worm protection software may give warnings when ESP is being installed, e.g., Norton Internet Worm Protection that warns that the installer executes unknown scripts. These scripts must be allowed to run to complete the installation successfully. Windows: New Technology File System (NTFS) In order to support installation in a directory with a path that contains spaces, the NFTS file system must be configured to generate 8.3 file names. Verify that the HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation registry key is not set to the value "1". HostsThis section describes the host requirements that you must take into consideration when installing FAST ESP. Hostname and IP Adresses The hosts must have fully qualified domain names (FQDN), i.e., all hosts must have a domain and a static IP address. In addition, the fully qualified domain name must be the primary name of the host (i.e., it should not be listed as an alias). Ensure that the network configuration and Domain Name Service (DNS) is set up properly, before you start installing FAST ESP. DNS is set up correctly when all hostnames resolve to the correct IP address, and all IPs resolve to the correct FQDN host names. Important: Do not use DHCP when assigning addresses to your hosts. Host Information Unix Command Windows Command Control Panel>System>Computer Name hostname Name of the current host system ifconfig ipconfig Current network configuration nslookup nslookup Information about a given host or IP address Port Allocation On each host there should be a span of 4000 ports between FAST's default base port (13000) and the FAST ESP installation. The rationale is that FAST ESP offsets its static ports from the base port (e.g., the administration GUI port number is 16000). Using ports below 1024 is not supported. It is not recommended to use a base port in the range 23000-27000 since the license server always uses port number 27000. Refer to Installing the License File for details. Important: All hosts must have unrestricted network access in the full port range (e.g., 13000-16999). Important: Fast recommends that ESP is not installed in the dynamic port range, since random ports in this range typically are in use by other processes. 16 FAST Enterprise Search PlatformFile Descriptors In general, the maximum number of open file descriptors must be 1024. For example: ulimit -n 1024 or ulimit -n -H 1024 On search-, index-and QR server-nodes on the other hand, the maximum number of open file descriptors should be 8193. Host Files The host file on all hosts must have the 127.0.0.1 localhost.localdomain localhost entry on a separate line. If other hosts are mentioned, they must be specified with the fully qualified host name before the short entry. For example: 127.0.0.1 localhost.localdomain localhost 80.91.35.43 myserver.example.com server Tip: The host file ( host ) is typically located in the /etc/directory in an UNIX environment, and in C:\WINDOWS\system32\drivers\etc under Windows. Hardware This section describes the hardware requirements that you must take into consideration when installing FAST ESP. Fast recommends the following hardware as a minimum: Unit Description Memory The memory should be 4GB (although FAST will run on machines with less memory). Swap Space The swap space should be twice the machine's physical memory. The disk storage system should be able to handle a high number of disk transactions per second. Disk Storage System CPU A typical machine should have one or two 1 GHz (or faster) CPUs. RAID The RAID stripe size should be as high as possible (i.e., 256K or higher). Fast ESP includes software that may make use of IP multicasting. Multicasting can be used to distribute an index to a remote search node, but this must be explicitly enabled in the indexer configuration after installation. Switches and Routers If you are planning to deploy ESP using IP multicasting, ensure that your switches and routers support multicasting and have ICMP Snooping enabled. 17 RequirementsChapter 3License This chapter describes how licenses are managed, and how to retrieve as well as upgrade the license file. Topics: • LicenseLicense FAST ESP licenses are managed by a dedicated license manager that is included in every FAST ESP installation. To retrieve a production license for a purchased version of FAST ESP, you must send a request to FAST with a valid host ID for the server where you plan to install FAST ESP. In case of a multinode configuration, FAST requires the ID of the host where the license manager will reside. In a multinode configuration, the license manager normally runs on the same host as the FAST configuration server. When installing a multinode configuration, a copy of the license file is installed on each node in the configuration during the installation process. The first lines in this copy tell the processes on each node where to send license requests, identifying the node that hosts the license manager. Note that moving the license manager to another machine will invalidate the license, i.e., if you want to move the license manager, you must send a request for a new license file to FAST and attach the host ID identifying the new location. In addition, you must edit all the local license file copies to point to the new location. The license manager within FAST ESP is based on FLEXlm licensing software provided by MacroVision. The initialization and usage of the different license features is written to the lmgrd.scrap log file in the FAST ESP installation's /var/log/lmgrd directory. Failures when checking out FAST ESP features that are not included in the license file, on the other hand, are written to the default log file and can be viewed in the FAST ESP administrator interface. For detailed information regarding FLEXlm, please refer to the FLEXlm User Guide at http://www.macrovision.com/pdfs/flexlm_licensing_end_user_guide.pdf . Installing the License File Perform the following steps to install the FAST ESP license file. If your installation is going to have a multinode configuration, you must know which host the license manager will reside on, i.e., the host that will act as the administration node. During installation, the FAST ESP installer will ask for the path to the license file, and copy the file into the /etc folder in your installation directory. 1. Run the lmhost utility program on the host that will act as the administration node. The lmhost utility program is provided with your FAST distribution. Do not use any other program for this purpose. Some systems include other programs for retrieving the host ID, but using these may result in an invalid license file. If you already have installed FAST ESP, lmhost is located in the FAST ESP installation's /bin directory. The lmhost utility program's outpout is a host ID. 2. Send a request for a license file to FAST, attaching the host ID from the previous step and the FQDN for the host running the license manager. You will receive a valid license file for your installation. 3. Save the license file as fastsearch.lic . By default the license server selects a port number within the default range of 27000 and 27009 for the license manager and the next free port for the vendor daemon (i.e., FASTSCHR). This numbering can interfere with other FAST ESP components if the base port for the FAST ESP installation is in the 23000 -27000 range. If required, it is possible to specify another port number for the license manager and vendor daemon in the license file. The port number may specify any unused port. Please refer to the License File Reference section for details. Note: If you are installing a new license file for a running FAST ESP installation, please refer to the Upgrading the License File section for details about how activate the new license. 20 FAST Enterprise Search PlatformUpgrading the License File Perform the following steps to upgrade your FAST ESP license file. If your existing FAST ESP installation has a multinode configuration, you must know which host the license manager will reside on, i.e., the host that will act as the administration node. Typically, you must upgrade the license file when you have added new optional features or you want to move the license manager to another host. 1. Request a new license file from FAST by following the steps described in Installing The License File procedure. You will receive a new license file for your installation. 2. Update the SERVER and VENDOR line in the new license file with the information from your existing license file. Important: Note that any other changes to the new license file will invalidate it. The existing license file is located on the node running the license manager, i.e., $FASTSEARCH/etc/fastsearch.lic on UNIX and %FASTSEARCH%\etc\fastsearch.lic on Windows. a) Replace this_host on the SERVER line in the new license file, with the fully qualified host name found in your existing license file. SERVER hostname.subdomain.yourdomain.com ANY 16055 Note: This is an optional step on single-node installations. b) If port numbers are specified in your existing license file, make sure that the port number to the end of the SERVER and VENDOR lines is equal to your existing license file. 3. Copy the new license file to /etc/fastsearch.lic on all servers within your FAST ESP installation, replacing the existing license files. 4. Restart the installation as described in the Restarting FAST ESP procedure, to activate the new license. Tip: If you are upgrading with a new license for Increased Data Volume (GB) or additional Content Connectors, it is not necessary to restart FAST ESP entirely; restarting the license manager is sufficient. This is described in the Restarting the License Manager procedure. Note that if the licensed amount of QPS (Queries Per Second) has changed with the upgrade, you must also restart the QRServer, the topfdispatch process and the search-1 process, to activate the change. Restarting FAST ESP Perform the following steps to restart FAST ESP. 1. Stop the installation. • On UNIX, go to your installation's /bin directory, and run source ./setupenv.sh or source ./setupenv.csh depending on your command line shell. Then run ./nctrl stop . • On Windows, select Start>All Programs>FAST ESP>FAST ESP -Stop . 2. Wait until all the FAST ESP processes are properly terminated. 3. Start the installation. • On UNIX, run ./nctrl start from the /bin directory. 21 License• On Windows, select Start>All Programs>FAST ESP>FAST ESP -Start . Restarting the License Manager Perform the following steps to restart the license manager. 1. Select System Management from the Administrator interface. 2. Click the restart button to the right of License Manager in the Installed module list . This action does not affect the operation of FAST ESP; all processes continue to run during the restart of the license manager. License File Reference The license file is called fastsearch.lic . When the installation process is completed, it is located in the installation's /etc directory, and is represented by the LM_LICENSE_FILE environment variable. Parameter Line Description This line specifies the name of the machine hosting the license manager, the FLEXlm host ID of that machine, and optionally the port number. For example: SERVER SERVER myhost 000102dffcd1 16055 This line specifies the name of the vendor daemon (i.e., FASTSRCH). It may also include daemon's path and port number. For example: VENDOR VENDOR FASTSRCH port=16057 This line redirects all license processing to the license manager. USE SERVER The license file contains several INCREMENT lines, one for each feature that is enabled. Each line specifies the following information: INCREMENT • The licensed feature • The vendor daemon (FASTSRCH) • The version number of the feature • The expiry date for the license (this element can have the value permanent , or dd-mmm-yyyy for time limited licenses) • The number of licenses that are enabled for this feature • A notice associated with the license • A signature ensuring the validity of the license Important: The signature is a calculated value; changing this information will invalidate the license. 22 FAST Enterprise Search PlatformChapter 4Before you begin Topics: This chapter provides a pre-install checklist. • Before You BeginBefore You Begin Before you start installing FAST ESP, ensure that you have covered the following action points. 1. Read the release notes of your FAST ESP distribution carefully. 2. Retrieve and install the license file as described in the License chapter. 3. Ensure that all hosts, their configuration and operating systems are supported, that the software requirements are met, and that the partitions are large enough. Please refer to the Requirements chapter for details. 4. Ensure that you have the necessary privileges depending on your installation environment: • If you are going to install FAST ESP in a UNIX environment using the ssh command interface, you must ensure that you have a login account on all your hosts. In particular, the user must have write access to the temporary directory. It is recommended that you have a dedicated local account on all hosts that will not be used for any other purposes. Change the permissions for the user's home directory to enable read and execute permissions for group and others, i.e., mode 0755 ( rwxr-xr-x ). In addition, ensure that the temporary directory is not mounted with the "noexec" flag. The rationale is that the installer relies on executing binaries from the system temporary directory. If necessary, you can specify an alternative temporary directory to the installer on the line like this: ./setup_Linux.bin -is:tempdir /my/tmp/dir • If you are going to install FAST ESP in a Windows environment , the user running the installer must have administrative privileges. In particular, this user must have Log-On as a Service privileges. To enable the latter, select Start>Control Panel> Administrative Tools > Local Security Policy >Local Policies> User Rights Assignment > Log on as a Service >Add User or Group and add the user. Note: The password for the user's account must be the same on all hosts. 5. Set the $FASTSEARCH and $LD_LIBRARY_PATH environment variables. 6. Ensure that you know which index profile(s) you intend to use. Important: When using a custom index profile, you must edit and save it prior to installation. Please refer to the Key Concepts section of the Introduction chapter for more details about index profiles. 7. If you are going to install FAST ESP in a UNIX environment, perform the following steps: Note: This is only required for multinode configurations. a) Generate public keys. Interface Version Commands ssh2 ssh-keygen -t rsa , ssh-keygen -t dsa ssh1 ssh-keygen , ssh-keygen -t rsa1 The resulting authentication identities and public keys are located in the .ssh directory in your home directory. In case of a multinode configuration, append the public-key of the FAST user to the appropriate authorized keys directory on all the remote hosts. Use permission mode 0700 ( rwx------) for the .ssh directory, and mode 0644 ( rw-r--r--) on the authorized_keys file. 24 FAST Enterprise Search Platformb) Ensure that all the target nodes are listed in your known_hosts file ( known_hosts2 for ssh2 ). This file is located in the $HOME/.shh directory. To do this, you can run a simple ssh call to all your hosts. If a node is not in the known_hosts file, you will get a warning. Choose to continue connecting, to place the node in the known_hosts file. Note: This is required to make the installer able to access the remote nodes during the installation process. c) Test the setup. Go to instmaster..com as the FAST user, and run ssh echo hello for each host in your configuration. If the terminal output for all hosts is hello , the setup is successful. Ensure that no password has to be entered while testing the setup. 25 Before you beginChapter 5Standard Installation This chapter describes FAST ESP's standard installer, and provides procedures describing how to do an installation using the various available installation types. Topics: • Standard InstallationStandard Installation The standard FAST ESP installer installs the selected components on all target machines, from a single source host. The standard installer provides an interactive wizard that guides you through the installation process. It can be run in both GUI mode and console mode (i.e., text only), and supports installation of both single-node and multinode configurations as well as the advanced installation type (please refer to the Installation Types section in the Introduction chapter for details). Tip: FAST ESP also provides a silent installer, requiring no user input, that is further described in the Silent Installation section. Starting the Installer This procedure describes how to start FAST ESP's standard installer. Please refer to the Before You Begin chapter to ensure that you are ready to start the installation. 1. Run the executable. The standard installer runs in GUI mode by default; add the -console command line option to run it in console mode. • On UNIX, download and extract the setup_.tar.gz file like this: gunzip setup_.tar.gz tar -xvf setup_.tar Run ./setup_.bin to start the installer. • On Windows, download and extract the setup_WindowsNT.zip file.Then select Start>Control Panel> Add/Remove Programs and install setup.exe . 2. Provide a valid license file. The installation wizard will first present you with the license agreement and then ask for the location of your license file; ensure that you provide the file's absolute path. Refer to the License chapter for more details. 3. Choose the installation type. 28 FAST Enterprise Search PlatformThe wizard allows you to choose between three different installation types: single-node, multinode and advanced. Please refer to the Installation Types section of the Introduction chapter for details. 4. (Windows only) Enter the username and password for registering and running the FAST ESP Services. Proceed with the installation process following the steps described by the Installing a Single-Node Configuration , Installing a Multinode Configuration or Repeating an Installation procedures, depending on the installation type that you have chosen. Tip: You may at any point choose to cancel the installation, but note that you cannot resume (i.e., if you cancel you have to start all over again to complete the installation). Installing a Single-Node Configuration This procedure describes how to install a single-node configuration of FAST ESP. 1. Start the installer. Follow the steps described by the Starting the Installer procedure. When the installer starts, it will prompt you for the license file location, the installation type and (on Windows) the username and password for registering and running the FAST ESP services. 2. Specify the installation directory. On UNIX, the default installation directory is the /esp subdirectory located in the FAST user's home directory, while it is C:\ESP on Windows. If possible, install FAST ESP on a separate physical disk than the one Windows is running on (i.e., C:\ ), as this partition should only be used if evaluating FAST ESP (the optimal is to install FAST ESP on a striped disk array, e.g., RAID 5). Important: If you select a different installation directory, you must ensure that the location name you choose does not contain spaces. 3. Specify the index storage location. 4. Select the languages that will be used for the advanced linguistics processing. In order to reduce memory consumption, you may want to consider activating only those dictionaries that will be used. For information on how lemmatization impacts the memory consumption, please refer to the FAST ESP Benchmarking chapter and the Resource Usage in FAST ESP appendix in the Deployment Guide . Consult FAST if you need to add new dictionaries after installation. 29 Standard Installation5. Configure the base port number. The default base port number is 13000. Please refer to the Hosts section of the Requirements chapter for details. 6. Choose an index profile. For a test or development installation you may use one of the default index profiles, but in most cases it is required to customize one of the default profiles to fit your application's needs. Please refer to the Key Concepts section in the Introduction chapter for more details about the index profile. 7. If your license includes a web crawler, the installer will prompt you for your company or organization name and an administrator e-mail address. This information is used as the crawler's user-agent identification value when crawling web sites. 8. Enable FAST ESP to send emails by entering the name of the email server. Note: This step is optional. FAST ESP can be configured to, for example, send an email to the administrator when certain events occur. Leave this field blank if you do not want to use this feature. Tip: The email service can also be enabled after the installation, please refer to the Basic Setup chapter in the Configuration Guide for more details. 9. Verify your configuration. Before the actual installation takes place, the wizard displays an installation summary. Click Next to start the installation process. During this process, you are given the option of starting your FAST ESP installation. This completes the installation. Please refer to the Verifying the Installation chapter to verify that FAST ESP was installed successfully, and to the Basic Setup chapter in the Configuration Guide for further instructions on how to make your first documents searchable in FAST ESP. Installing a Multinode Configuration This procedure describes how to install a multinode configuration of FAST ESP. 1. Start the installer. Follow the steps described by the Starting the Installer procedure. Note: The installer's console mode does not support multinode configuration due to the interface complexity. Please refer to the advanced installation type in the Installation Type section of the Introduction chapter for details on how to install multinode configurations on machines that do not support the graphical user interface. 30 FAST Enterprise Search PlatformWhen the installer starts it will prompt you for the license file location, the installation type and (on Windows) the username and password for registering and running the FAST ESP Services. Then, the installation wizard displays the Introduction page showing a summary of the configuration setup procedure. 2. Open the Hosts page and add your hosts to the configuration. Pressing the Add host button will create a new host entry that identifies the machine running the installation script. Add a sufficient number of new entries and edit these to reflect your hosts. Note: You must provide the host name and the name of the user running FAST ESP, and specify the installation directory and temporary directory as well as the base port for the installation.The index directory is optional. You can test the connection to the host by clicking the corresponding button. Alternatively, you can choose to test all the connections when you have added all your hosts. 3. Open the Services page, and allocate additional service instances by pressing the Add Services button and selecting the relevant services. 31 Standard InstallationNote: This step is optional. Initially, the Services page displays a default set of services, i.e., the set of services required to complete the installation.You might want to allocate some additional instances of these services to increase your systems capacity and fault tolerance. Please refer to the Deployment Guide for more details. The services that can be allocated more than once are: • Document Processor • Indexing Dispatcher • Query Result Processor • Search service When clicking OK the selected services will be added to the default service set. 4. Open the Services page, and configure the set of services, i.e., select each service and click the Configure service and allocate host(s) button. The required input varies depending on the selected service. Please refer to the Service Configuration in a Multinode Environment section for details. A configured service is listed in black (as opposed to the initial red color). When all the services have been configured, the Next button is enabled. 5. Click the Next button to finish the installation. At this stage, the installer will test the specified connections. If the test is not successful, the installation wizard returns you to the previous page allowing you to reconfigure. 32 FAST Enterprise Search PlatformThe Installation overview contains a configuration summary, i.e., the current status, supported services and the generated InstallProfile.xml . This completes the installation. Please refer to the Verifying the Installation chapter to verify that FAST ESP was installed successfully, and to the Basic Setup chapter in the Configuration Guide for further instructions on how to make your first documents searchable in FAST ESP. Service Configuration in a Multinode Environment When installing FAST ESP using the multinode installation type, one of the steps in the process is to configure and deploy ESP's services. This section describes the required input for the various services. Administrative Services Select a host for the service and enable FAST ESP to send emails by entering the name of the email server. FAST ESP can, for example, be configured to send an email to an administrator when certain events occur. The email service is optional; leave this field blank if you do not want to use this feature. Tip: The email service can also be enabled after the installation, please refer to the Basic Setup chapter in the Configuration Guide for more details. Name Service Select host(s) for the service. Tip: Select several hosts to provide fault-tolerance. Log Transformer Select a host for the service. WebAnalyzer Service The WebAnalyzer service improves search relevance by analyzing the link graph and adding anchor texts and a query independent rank boost based on link cardinality to the documents in the index. Anchor text analysis is automatically enabled for all collections that use either the SiteSearch or the NewsSearch document processing pipeline. 33 Standard InstallationThe WebAnalyzer service consists of a Server (the WebAnalyzer master process) and one or more LinkProcessors and LookupDBs. When selecting WebAnalyzer and pressing the Configure service and allocate host(s) button, you will be shown a screen where you need to select hosts to your WebAnalyzer service. Use the Add or Remove buttons to add or remove hosts from the service. A WebAnalyzer service needs one Server, and one or more of each of the LinkProcessors and LookupDBs. LinkProcessors and Lookupdbs can run on the same host as eachother, as well as on the host running the Server. The more LinkProcessors and Lookupdbs a WebAnalyzer service has, the better it scales, both with regard to document volume and for processing time. Refer to the WebAnalyzer Guide for more information about sizing the Webanalyzer service. You can also configure the number of processes (CPUs/cores) each LinkProcessor should use. If your hosts have multiple cores or CPUs, increasing this number to the desired amount will speed up the link processing. Note: Setting this number larger than the actual amount of CPUs/cores will not crash the service, but it will not speed up processing either. Content Distributor Select a host for the service. Tip: Select several hosts to provide fault-tolerance. Crawler Select host(s) for the service, and provide your company or organization name and an administrator e-mail address. Note that the browser engine service is also installed on the selected host. The crawler is using the browser engine to process JavaScript and Flash documents. The name and email address are used as the crawler's user-agent identification value when crawling web sites. 34 FAST Enterprise Search PlatformNote: Selecting several hosts will create independent crawlers. It is possible for these crawlers to cooperate, increasing the performance and fault-tolerance. Please refer to the Enterprise Crawler Guide for more details. Document Processor Select a host for the service. Search Service A search service, i.e., a cluster, consists of one or more search engines sharing a common index profile. When selecting a search service and pressing the Configure service and allocate host(s) button, you will first be prompted for a cluster name. Important: When selecting names for search clusters, only characters a-z and 0-9 are supported, i.e., other characters will not be accepted by the installer. Select hosts (i.e., search engines) to your search service structure using the Add host button (you can remove them using the Remove host button). Use the Add Column and Remove Column buttons to alter the cluster structure. When adding a node to the cluster you must assign it to either search or indexing or both. Note that each column must have one indexing node, but to add more than one indexer to a column, you must check the Fault tolerant indexing option. Use the Index copying option to specify whether index copying from the index hosts to the search hosts should be done automatically or not. Tip: Refer to the Deployment Planning Guide for more information. 35 Standard InstallationFor a test or development installation you may use one of the default index profiles, but in most cases it is required to customize one of the default profiles to fit your application's needs. Please refer to the Key Concepts section in the Introduction chapter for more details about the index profile. A search service requires that both an query result processor as well as an indexing dispatcher are assigned to the cluster, for the installation to succeed; otherwise warnings will be displayed in the properties overview. Query Result Processor Select the languages that will be used for the advanced linguistics processing, assign the processor to a search service cluster and select a host for the service. 36 FAST Enterprise Search PlatformIn order to reduce memory consumption, you may want to consider activating only those dictionaries that will be used. For information on how lemmatization impacts the memory consumption, please refer to the Deployment documentation. Consult FAST if you need to add new dictionaries after installation. Indexing Dispatcher Select a host for the service, and assign the dispatcher to a search service cluster. Repeating an Installation The advanced installation type allows you to repeat a FAST ESP installation by providing the associated install profile that was automatically generated during the first installation process. 1. Start the installer. Follow the steps described by the Starting the Installer procedure. When the installer starts, it will prompt you for the license file location, the installation type and (on Windows) the username and password for registering and running the FAST ESP Services. 2. Specify the install profile and the scope of the installation and system testing. 37 Standard InstallationBy default, the installer performs a full installation and runs system tests on all hosts. 3. Click the Next button to finish the installation At this stage, the installer will test the configuration specified by the install profile. If this test is successful, FAST ESP will be installed using the specified configuration and the installation wizard will finish; otherwise the wizard returns you to the previous page, allowing you to reconfigure. This completes the installation. Please refer to the Verifying the Installation chapter to verify that FAST ESP was installed successfully, and to the Basic Setup chapter in the Configuration Guide for further instructions on how to make your first documents searchable in FAST ESP. 38 FAST Enterprise Search PlatformChapter 6Silent Installation This chapter describes FAST ESP's silent installer, and provides procedures describing how to do a silent install. Topics: • Silent InstallationSilent Installation A standard installation of FAST ESP is performed using an interactive installer program; the silent installer requires no user input during the installation process, installing a pre-defined configuration and feature set. To create and run a silent installation you must first define a configuration file. The configuration file is an XML file that describes the deployment configuration, feature set and optional customization of the installation. The silent installer runs in two phases: • First, it launches the standard FAST ESP installer with the options specified in the section of the given configuration file. • Then it configures custom modules and features as specified in the section of the given configuration file. Tip: The configuration phase may be run at any later time to reconfigure the installation (provided that there is an existing installation). The Installation Phase The silent installer invokes the standard installer with the information specified in the configuration file including initial configuration parameters, such as advanced linguistics settings and index profile selection. In multinode configurations, the silent installer automatically runs on all hosts. During the installation process, an uninstall script is generated and added to the installation. The silent installer checks a number of prerequisites before installing: it checks the operating system platform for compatibility, and it ensures that there are no previous installations (only on Windows since Unix supports multiple installations). It also ensures that the DNS setup is correct. The Configuration Phase When the installation is completed, the silent installer performs the post-install customization specified in the configuration file, e.g., adding a set of pre-configured collections, copy or replace files within the installation, update hostname parameters and suspending processes from execution. In particular, it is possible to modify files within the installation. If parts of the post-install modifications fail, rollback functionality is provided, ensuring consistent state. If one or more of the specified tasks fails, all changes are rolled back to avoid getting into an inconsistent state. For example, if you were able to modify the contents of one file, but a later replace token task failed due to a typo. If you then fix the typo and run the silent installer again with the -p config option, the replace token task that succeeded the first time will fail because the file has already been modified. Refer to the Defining a Configuration File section for more details. Important: The untar archive and unzip archive tasks do not support this rollback functionality since there is no way of knowing what has been extracted onto the installation. Running the Silent Installer This procedure describes how to run the silent installer. The silent installer takes a configuration file as parameter, i.e., you must first define a suitable configuration and copy the file into your installation's updates folder. Please refer to the Defining a Configuration File section for details. Please refer to the Before You Begin chapter to ensure that you are ready to start the installation. 40 FAST Enterprise Search PlatformNote: When performing a multinode installation, the current working directory of the silent installer must be the directory where the installation files are unpacked. For example, if the setup_WindowsNT.zip file is extracted in the C:\espinstaller directory, the silent installer must be launched from here as well. 1. Open a command prompt or command shell, and go to the directory containing the installation files. 2. Run the installation script. • UNIX: ./install.sh -f updates/ • Windows: install.cmd -f updates\ Log messages are displayed on standard out.You might want to increase the verbosity of the installer to get debug messages. This can be done by adding the -v command line option, e.g., -v 7 . Please refer to the Command Line Options section for a complete overview of the available command line options for the silent installer. This completes the installation. Please refer to the Verifying the Installation chapter to verify that FAST ESP was installed successfully, and to the Basic Setup chapter in the Configuration Guide for further instructions on how to make your first documents searchable in FAST ESP. Command Line Options The following command line options are available to FAST ESP's silent installer. Option Description This option specifies the configuration file for the installation. -f Important: This option is required to run the installer. This option specifies a logfile for the installer. By default, the log messages are displayed on standard out. -l This option specifies which phase to run. The possible values are install (the default) and config . -p Note that the install option makes the installer perform both the installation and the post-install configuration, while the config option makes the installer perform the configuration part only. This option specifies the level of verbosity: 0 means nothing, 7 means everything. The default value is 5. -v (Windows only) This option specifies the user that is going to run the Windows service, i.e., making it possible to avoid storing credentials as clear-text in the configuration file. The option is optional, but please note that there is no default value. -U (Windows only) This option specifies the password of the user that is going to run the Windows service, i.e., making it possible to avoid storing credentials as clear-text in the configuration file. The option is optional, but please note that there is no default value. -P This option informs the installer that it is performing a multi-node installation, i.e., this option is required to install a multinode configuration. -m -o This option overrides the platform check, i.e., the installation will continue even if the check fails. This option overrides the hostname check, i.e., the installation will continue even if the check fails. Please note that this option is set by default on Windows. -h (Windows only) This option enables the hostname check, i.e., the installation will not continue if the check fails. -H This option overrides the network loop back check, i.e., the installation will continue even if the check fails. -n -w This option enables warnings when installing a multinode configuration and files are missing. 41 Silent InstallationOption Description This option adds a top-level fdispatch process to the installation. -t Note: A single node installation normally does not have a top level fdispatch process. Using this option will cause a top level fdispatch to be installed even in a single node system. -i This option makes the installer run in an interactive mode with a graphical user interface. -c This option specifies the search cluster name for the installation. The default is webcluster . Defining a Configuration File This procedure describes how to define a configuration file for the silent installer. The configuration file is an XML file containing information for the installation process as well as the post-installation phase. It is specified using the following format: ... ... Tip: See Configuration Example for an example file, and Configuration DTD for the configuration file DTD. 1. Define the installation information parameters. ... These parameters correspond to the ones used by the standard FAST ESP installer. Please refer to the Installation Parameters section for a description of the various parameter names and values. The parameter value may be specified in one of the following ways: Format Description Specify the value as the content of the parameter element. For example: 13000 Element standard Specify the value as an attribute of the parameter element. For example: Attribute Using CDATA enables proper handling of special characters. For example, it may be used if the actual value string is not known in advance: CDATA 42 FAST Enterprise Search Platform2. Define the desired post-installation configuration tasks. Please refer to the Configuration Tasks section for a description of the various tasks. Note that when performing a multinode installation, some restrictions are placed on the tasks that reference external files (e.g., the CopyReplaceFile and UnzipArchive tasks). In these tasks, the given files will be copied to all nodes in the installation, i.e., ensure that you specify paths to the files in question that are valid on all nodes.This can be achieved by putting all the files in question into a subdirectory of the updates folder, and specifying all paths relative to the parent directory of this folder. Tip: Several of the configuration tasks imply advanced re-configuration of the FAST ESP installation that may have unexpected side-effects if not performed properly.We recommend that you consult FAST in order to determine which re-configurations that may safely be applied within your application. This applies to all tasks except Collections and Lemmatization. Once the configuration file is defined, copy it to the installation's updates folder and you are all set to run the installation script. Installation Parameters The following installation information parameters are available to FAST ESP's silent installer.These parameters correspond to the ones used by the standard FAST ESP installer. Parameter Name Description Required/Optional Required unless the installation directory is This parameter specifies the full path of the directory where to install FAST ESP. InstallPath specified through the InstallProfile parameter. Required This parameter specifies whether to use the default installation directory, or not. UseDefaultInstallPath Note: The value must be false to make the installer use the directory provided by the InstallPath parameter. Required unless the base port is specified This parameter specifies the base port for the range of TCP port numbers that FAST ESP will use. Please refer to the Hosts section of the Requirements chapter for details. BasePort through the InstallProfile parameter. Required This parameter specifies the full path of a logfile for the installer. LogOutput In a multinode installation, there will be one log file in the temporary directory on each node, named fastinstall_remote_.log , where is the name of the user running the installation script. This parameter specifies the full path of the license file. This Required must be a valid FAST ESP license file reflecting the feature set to be installed. Please refer to the License chapter for details. LicenseFile Required unless the temporary directory is This parameter specifies the temporary directory that will be used during the installation. TempDir specified through the InstallProfile parameter. This parameter specifies the type of index profile the installation Optional will use. The valid values are standard , lemmas , geo and IndexProfileType custom . Please refer to the Key Concepts section in the Introduction chapter for more details about the index profile types. 43 Silent InstallationParameter Name Description Required/Optional Required if the optional IndexProfileType IndexProfile This parameter specifies the full path of the index profile. parameter is set to custom . Optional This parameter specifies the languages you want to install spellcheck dictionaries for. The default value is en . SpellCheckLanguages Note: This is related to the installation, not the languages you are entitled to use according to your license. This parameter specifies the default language code for queries Optional (i.e., for spell checking, lemmatization and Asian language DefaultSpellCheckLanguage tokenization). This is the default language code that is used if the query doesn't indicate a code. The default value is en . Required This parameter specifies whether the installation should terminate if an error occurs. ExitOnError Important: The default value is true , setting it to false is only for internal debugging, and may cause the installer to hang. This parameter specifies whether the installation should terminate Optional if a warning occurs. The valid values are true and false (the default). ExitOnWarning (Windows only) This parameter ensures that the installer checks Optional that the user credentials are correct and that the user has Log CheckPasswordOnWindows on as a Service privileges.The valid values are true and false . (Windows only) This parameter specifies the FAST ESP user Required who must have Log on as a Service privileges. UserName (Windows only) This parameter specifies the password for the Required user indicated by the UserName parameter. Password (Windows only) This parameter indicates how the FAST ESP Optional windows service is started. The valid values are Automatic and Manual . DataSearchServiceStartMode Required for multinode installations; otherwise optional This parameter allows you to specify an install profile ( InstallProfile.xml ), overriding the following installation parameters defined in the configuration file: InstallProfile • InstallPath • IndexPath • TempDir • LogOutput • IndexProfile • IndexProfileType • SpellCheckLanguage • DefaultSpellCheckLanguages This parameter ensures that FAST ESP is only installed on the Optional local node (even if you have an install profile defining multiple InstallLocalNodeOnly nodes).You can, for exampel, use this parameter to add a node to an existing installation. 44 FAST Enterprise Search PlatformParameter Name Description Required/Optional (Windows only) This parameter specifies whether shortcuts for Optional starting and stopping FAST ESP will be removed from the Start menu. The valid values are true and false . RemoveShortcuts Optional (Windows only) This parameter allows the user to define the Start menu shortcuts for starting and stopping FAST ESP. WindowsShortcuts Important: If you do not specify a value, the shortcuts will be installed with the default values unless you set the RemoveShortcuts parameter to true . Please refer to the Windows Shortcuts section for details. This parameter can be used to specify additional parameters for Optional the standard FAST ESP installer. AdditionalParameters Windows Shortcuts The WindowsShortcuts installation parameter allows you to define the Start menu shortcuts for starting and stopping FAST ESP on Windows. The table below describes the elements available for describing the "Start" and "Stop" shortcuts. Syntax The enable attribute is optional, and its valid values are true (the default) and false . Element Description Required/Optional Folder This element specifies the Start menu folder to put the shortcut in. Required Name This element specifies the name that will appear in the Start menu. Required This element specifies what program to run when the shortcut is invoked Optional (the default is %WINDIR%/system32/cmd . Target This element specifies the arguments to the target program.The default Optional values are /C net start FASTDSService and /C net stop FASTDSService . Args This element specifies whether the target program is represented by Optional its relative or its absolute path. The valid values are true and false (the default). RelativeTarget This element specifies the working directory to use when invoking the Optional target program. The default value is %WINDIR% . WorkingDirectory This element specifies whether the working directory's path is relative Optional or absolute. The valid values are true and false (the default). WorkingDirectoryRelative Configuration Tasks The following configuration tasks are available to FAST ESP's silent installer in its configuration phase. 45 Silent InstallationThe configuration tasks are executed in the following order (note that you can base any task on the previous ones, but not the other way around): 1. CreateFolder 2. RecursiveCopyReplace 3. UnzipArchive 4. UntarArchive 5. CopyReplaceFile 6. DeleteFile 7. AddTopLevelDispatcher 8. EnableIndexingDispatcher 9. Collections 10. SuspendedProcesses 11. RemovedProcesses 12. Lemmatization 13. (MatchSeverity) 14. ReplaceToken 15. ReplaceString 16. ExecuteExternalCommand 17. PluginConfiguration Note: The MatchSeverity task is not executed on it's own, i.e., it only acts as a rule for the subsequent ReplaceToken and ReplaceString tasks. Refer to the MatchSeverity section for details. Important: Use forward slash ( /) for all pathname attributes that are relative to the InstallPath parameter specified in the section (i.e., the FAST ESP installation directory). This also applies for Windows. For example: CreateFolder This task creates a folder in the FAST ESP installation directory. The path attribute must be relative to the installation directory, for example: RecursiveCopyReplace This task recursively copies all the contents from the given source folder to the specified destination folder. It is specified as follows: The path in the dest attribute must be relative to the InstallPath parameter specified in the section, i.e., the installation directory. If the destination folder does not exist, it will be created. The execution of this task can be limited to certain platforms using either the platforms or the notplatforms attribute. The values of these attributes should be comma-separated strings containing one or more of the following platform identifiers: win32 , linux2 and sunos5 . 46 FAST Enterprise Search PlatformTypically, you will use either platforms or notplatforms . For example, both and will only be executed on Windows and Linux. UnzipArchive This task extracts the given zip file on top of the installation folder, and can be used to deploy an overlay of files on top of the installation. This is specified as follows: The destination folder is always the directory specified by the InstallPath installation parameter (i.e., the installation directory). This means that the archive must contain a structure that corresponds with the installation's structure. Important: In case of a failure, there is no rollback for the changes made by this task since there is no way of knowing what has been extracted onto the installation. The execution of this task can be limited to certain platforms using either the platforms or the notplatforms attribute. The values of these attributes should be comma-separated strings containing one or more of the following platform identifiers: win32 , linux2 and sunos5 . Typically, you will use either platforms or notplatforms . For example, both and will only be executed on Windows and Linux. UntarArchive This task extracts the given archive on top of the installation folder, and can be used to deploy an overlay of files on top of the installation. This is specified as follows: The destination folder is always the directory specified by the InstallPath installation parameter (i.e., the installation directory). This means that the archive must contain a structure that corresponds with the installation's structure. Compressed archives are supported provided that the tar command on the given machine supports it. If the file name of the archive ends with 'z' (e.g., .tar.gz or .tgz ), the command tar xfz will be used instead of the standard tar xf . Important: In case of a failure, there is no rollback for the changes made by this task since there is no way of knowing what has been extracted onto the installation. 47 Silent InstallationThe execution of this task can be limited to certain platforms using either the platforms or the notplatforms attribute. The values of these attributes should be comma-separated strings containing one or more of the following platform identifiers: win32 , linux2 and sunos5 . Typically, you will use either platforms or notplatforms . For example, both and will only be executed on Windows and Linux. CopyReplaceFile This task copies one or more files into the installation. This is specified as follows: If a file already exists, it is replaced and a backup is created. The dest attribute should be relative to the InstallPath parameter specified in the section (i.e., the installation directory). It must include a file name or the wildcard asterisk unless the source attribute includes a wildcard asterisk. A wildcard asterisk in the source attribute will copy all files in the source folder into the destination folder. For example: If the destination folder does not exist, it will be created. Note that this is not a recursive copy operation; only the files in the source folder will be copied. The execution of this task can be limited to certain platforms using either the platforms or the notplatforms attribute. The values of these attributes should be comma-separated strings containing one or more of the following platform identifiers: win32 , linux2 and sunos5 . Typically, you will use either platforms or notplatforms . For example, both and will only be executed on Windows and Linux. DeleteFile This task deletes the specified file or folder from the installation. It is specified as follows: The file attribute must be relative to the installation folder. A backed up file or folder will be present with the .bak extension. 48 FAST Enterprise Search PlatformThe execution of this task can be limited to certain platforms using either the platforms or the notplatforms attribute. The values of these attributes should be comma-separated strings containing one or more of the following platform identifiers: win32 , linux2 and sunos5 . Typically, you will use either platforms or notplatforms . For example, both and will only be executed on Windows and Linux. AddTopLevelDispatcher This task adds a top level search dispatcher (i.e., a fdispatch process) to the installation. This task is specified as follows: Note: It is required to have a top level fdispatch process when installing a multinode configuration with multiple search nodes. A single node installation normally does not have a top level fdispatch process. Using the AddTopLevelDispatcher task will cause a top level fdispatch to be installed even in a single node system. The value attribute is a boolean determining whether to add the top level dispatcher process or not. The enable attribute is a boolean determining whether to enable the new process or not. If you set enable="false" , you must manually edit the installation's etc/qrserver/webcluster.spec file when you want to put the process into production. If the FAST ESP nameservice is running on a different host than this one, you should add the nameservicehost attribute. EnableIndexingDispatcher This task defines whether the indexing dispatcher should be enabled or not. It is specified as follows: The default behavior (i.e., if you do not include this task) is to disable the indexing dispatcher on single-node configurations and enable it on multinode configurations. Tip: The indexing dispatcher is not required in a single-column installation, i.e., you can save resources by disabling it when it is not in use. Collections This task adds the given list of collections to the installation. This is specified as follows: If a collection already exists, the corresponding element in the configuration file is skipped. 49 Silent InstallationThe name and pipeline attributes are required for all collection elements, while the description attribute is optional. SuspendedProcesses This task specifies a list of processes that should be suspended when FAST ESP is started. This is specified as follows: This will reduce the memory consumption related to processes that is not really needed. When suspending processes in this way, it is possible to resume them later on using the Administration interface or the FAST ESP Admin API. Please refer to the FAST ESP Administrator Interface chapter in the Configuration Guide for details. RemovedProcesses This task is a list of processes that should be removed when FAST ESP starts for the first time. It is specified as follows: The difference between removing a process and suspending it is that a suspended process can be resumed while a removed process cannot. A suspended process will show up as paused in the FAST ESP Admin GUI (i.e., in the system management tab). Lemmatization This task allows you to configure lemmatization for the installation. It is specified as follows: The available types are: Type Description No modification is made to the contents of the index. The query is expanded to all lemmatized forms of the word. queryexpansion (default) Words are expanded into all lemmatized forms in the index. No modification is made to the query. documentexpansion Words are reduced to the base form in the index and the same reduction is performed in the query. reduction The languages attribute specifies what languages to lemmatize. The installer will verify that the corresponding language dictionaries exist in the installation before enabling each language, in case you have configured a language that is not supported. The languages are specified using the iso-639-two-letter code, e.g., en . The default attribute specifies the default lemmatization language. Finally, the pos attribute what parts-of-speech to lemmatize. This is typically one of the following: • N : Only nouns are lemmatized • NA : Nouns and adjectives are lemmatized 50 FAST Enterprise Search Platform• NAV : Nouns, adjectives and verbs are lemmatized Note: This task does not affect whether lemmatization is enabled or disabled that is controlled by the index-profile; if you are not using lemmatization, this task is irrelevant. ReplaceToken This task replaces all occurrences of token X by token Y in file Z using a regular expression search-and-replace operation. This is specified as follows: The file attribute should be relative to the InstallPath parameter specified in the section, i.e., the installation directory. The given source attribute is treated as a regular expression. For example, you may use an expression like "<element_to_replace>.*?</element_to_replace>" to replace an entire XML tag and all of its contents. The given dest attribute can contain an expression enclosed by square brackets. Certain keywords are recognized when evaluating the expression: Keyword Description BASEPORT This keyword corresponds to the BasePort parameter specified in the section. This keyword corresponds with the InstallPath parameter specified in the section. INSTALLPATH HOSTNAME This keyword corresponds with the hostname returned by the hostname command. This keyword specifies the IP address (on the form a.b.c.d ) of the hostname returned by the hostname command. IP This keyword is the fully qualified domain name of "this host" (this may or may not be the same as the hostname returned by the hostname command). FQDN Tip: The source and dest attributes can also be specified using sub-tags. This enables you to wrap the contents in CDATA tags that can contain raw XML, i.e., you don't have to escape the XML markup. For example, to remove the ... element, you can create the following configuration entry: .*?]]> Any specified source and/or dest attributes will override the corresponding sub-tags. 51 Silent InstallationThe matchseverity attribute specifies how severely to treat a mismatch for this task (i.e., if source does not exist in the given file ). The attribute's value must be a numeric value in the range of 0 to 7 (e.g., 0 will make the installer log a CRITICAL error and terminate). Tip: The match severity can also be specified using a separate task element, MatchSeverity. Finally, you can add conditions to the task using the ifexists and ifnotexists attributes. In this way, you can ensure that the given token is replaced only if the phrase specified by one of these attributes either exists or doesn't exists, respectively, in the given file. The execution of this task can be limited to certain platforms using either the platforms or the notplatforms attribute. The values of these attributes should be comma-separated strings containing one or more of the following platform identifiers: win32 , linux2 and sunos5 . Typically, you will use either platforms or notplatforms . For example, both .*?]]> and .*?]]> will only be executed on Windows and Linux. ReplaceString This task replaces all occurrences of string X by string Y in file Z. This is specified as follows: This task basically provides the same functionality as the ReplaceToken task. The difference is that this is a simple string search-and-replace operation while ReplaceToken is a regular expression search-and-replace operation. MatchSeverity This task specifies how severely to treat a mismatch in the ReplaceToken and ReplaceString tasks (i.e., if the specified source does not exist in the given file ). The given value must be a numeric value between 0 and 7. It is specified as follows: This task is useful when testing your configuration either during development or when upgrading to a new version of FAST ESP. For example, if your ReplaceToken or ReplaceString tasks do not find a match of the given source in the specified file , a MatchSeverity value of 0 will cause the silent installer to log a CRITICAL error and terminate. Note: The matchseverity attribute of the ReplaceToken and ReplaceString tasks take precedence over the value specified by this task. 52 FAST Enterprise Search PlatformExecuteExternalCommand This task attempts to execute the given external command.The command can be a standard system command (e.g., ìchmod +x *î ) or a script that performs some custom operations. This is specified as follows: Note: There is no handling of return values from the external command or script.The command is simply attempted, and if it fails, this is only logged as a WARNING and the execution proceeds. PluginConfiguration This task specifies an external plug-in module that can be invoked after all other configuration tasks are completed. The purpose of this task is to allow custom code to be invoked at the very end of the installation. This is specified as follows: The module attribute specifies the script to run, and the order attribute specifies the order in which the plug-in will be invoked. Note that the order attribute is relative to other plug-ins if you have more than one. Finally, the parameters attribute specifies the parameters required by the script's main() method. Note: The script specified by the module parameter must contain a main() method and be located in the updates/bin/folder. Important: Only Python code is supported. Configuration File Example The silent installer installs a pre-defined configuration and feature set using a XML configuration file. This topic shows an example configuration file. 13000 Configuration File DTD The silent installer installs a pre-defined configuration and feature set using a XML configuration file. This topic shows the associated DTD. 54 FAST Enterprise Search Platform 55 Silent InstallationChapter 7Verifying the Installation This chapter describes how you can use FAST Home and the administration interface to verify that your installation has completed successfully. Topics: • Verifying the InstallationVerifying the Installation This procedure describes how to use FAST ESP's administration interface to verify that an installation has completed successfully. When the installation wizard is finished, the FAST Home interface is running at http://: (provided that you chose to start the FAST ESP installation during the installation process). The hostname is the name of the node hosting the Admin GUI component, and base_port is the FAST ESP installation's base port. 1. Start the installation Note that this step may be redundant if you chose to start the installation during the installation process. • On UNIX, go to your installation's /bin directory and run source ./setupenv.sh or source ./setupenv.csh depending on your command line shell. Then run ./nctrl start . • On Windows, select Start>All Programs>FAST ESP>FAST ESP -Start . 2. Log in to access the FAST Home interface. Enter Admin for the username and leave the password area empty. The username and password can be changed later on. 3. Follow the ESP Admin GUI link. You will then enter the FAST ESP administrator interface. 4. Verify the installation. 58 FAST Enterprise Search Platforma) Select System Overview and verify that the status of all the components is Responding . This interface also shows you the number of node controllers and the host listings for the various modules (with the configured node names). b) Select Logs to verify that there are no errors. c) Select System Management to verfiy the node configuration. This interface lists the number of node controllers registered with the Config server, as well as all the hosts that were configured during the installation.You can click on any host to obtain more detailed information. d) Select Matching Engines to verify the search engines. The primary host is listed as the search column. If there are multiple columns, all backup hosts will be listed below the primary node. 59 Verifying the InstallationChapter 8Uninstalling Topics: This chapter describes how to uninstall FAST ESP. • UninstallingUninstalling Perform the following steps to uninstall FAST ESP. Important: The uninstall program will remove all files in the installation directory. 1. Save you license file and any other file and web collections that you want to keep, in a location outside the installation directory. 2. Run the uninstall program. • On UNIX, the uninstall script is located in the installation's _uninst directory if you installed FAST ESP using the standard installer. If you used the silent installer, on the other hand, the uninstall script is called uninstall.[sh|bat] and is located in the installation directory. Important: Running this script will uninstall FAST ESP from all hosts included in the original configuration. • On Windows, select Start>Control Panel> Add/Remove Programs and remove the FAST ESP program. Important: You must run the uninstall program on each host in a Windows configuration. The uninstall program might leave some processes called .tmp . This is due to a problem with the 3rdparty installer software, but the processes can safely be killed as soon as the uninstall program has completed. When running the uninstall program in silent mode, or when uninstalling a multi node installation, there may also be some files left in the installation directory. This can happen if the files are in use by other programs than ESP. These files will automatically be removed the next time Windows is rebooted. 62 FAST Enterprise Search PlatformChapter 9Fault Tolerance This chapter describes procedures you can use to improve your system's fault tolerance. Topics: • Installing Multiple License ServersInstalling Multiple License Servers In order to provide an end to end fault-tolerant ESP system for feeding, indexing and search, it is recommended to set up the license server in a fault-tolerant configuration. This procedure describes how to set up multiple license servers in a FAST ESP multi-node installation. Before you start installing, you must determine on which hosts you want to install the license servers, and how you want to distribute the license requests from ESP's various components. The license server itself provides built-in fault-tolerance support, but FAST recommends using a fault-tolerance scheme based on using multiple independent license servers serving fault-tolerant parts of the ESP multi-node installation. The components that are involved in the fault-tolerance scheme are the content distributor, the document processor (ProccessorServer), the indexing dispatcher, indexer nodes, search nodes and associated QRServers. For all these components you will typically have multiple servers running the same component in a fault-tolerant configuration. Note: Ensure that components with fault-tolerance support are evenly distributed towards the associated license servers. In most cases it is convenient to install one license server on the ESP administration node, and one or more additional license servers on separate servers that are not involved in the feeding/indexing/search chain, or other ESP servers that are not heavily loaded. 1. Request license files for the nodes that will host your license servers, from FAST. These license files will look exactly like standard license files; the SERVER line will be pointing to the respective node with its host name and host ID. 2. Install one of the license files on the node specified by the file's SERVER line. 3. Install ESP the normal way, assigning the administrative service to the node with the license file installed. During installation a license server will be started on the given host, and the license file will be copied to all the other nodes in the configuration. 4. Install and start the additional license servers. For each node that will host a license server: a) Replace the license file that was installed during the ESP installation process, with the license file requested for the given node. b) Modify the etc/NodeConf.xml file on the given node: Add lmgrd in the section. c) Run nctrl reloadcfg to start the license server. d) Edit the license file on all the nodes that you want to connect to the new license server. Modify the SERVER line to point to the given node. 5. Restart ESP. You only have to restart processes that were started while the system was configured with only the inital license server (the one set up during the ESP installation process). Note: Verify that fault-tolerance works properly by shutting down each node hosting a license server, one at a time, and verify that search and feeding works properly. 64 FAST Enterprise Search PlatformChapter 10 Install Profile DTD Topics: This chapter provides an example of an install profile. • Install Profile DTDInstall Profile DTD The install profile is automatically created when you install FAST ESP and is located in the installation directory. It contains a complete system description, allocating hosts to services. This DTD is typically used by OEMs and partners that want to integrate their installer with the FAST ESP installer. The system-configuration Element The system-configuration element is the root element. It contains a host set describing the hosts in the installation and an element for each service that is part of the installation. Attributes: Attribute Description name Specifies a name for the install profile Specifies the version of the install profile format (note that this is not necessarily the same as the ESP version, the DTD version specified here is 5.1.3) version The host-set Element The host-set element contains one host element for each host in the installation. The host Element The host element specifies a host in the installation. Properties: Property Description hostname The fully qualified host name of the host platform The name of operating system (i.e., Linux, Windows or SunOS) username The name of the user performing the installation install-dir The installation directory 66 FAST Enterprise Search PlatformProperty Description index-dir The directory where index data are stored (optional) fixml-dir The directory where fixml data are stored (optional) temp-dir The temporary directory used when installing on the given host The remote execution method, i.e., ssh or ssh2 (note that this property is only significant in multi-node installations on Unix and Linux) remote-cmd base-port The base port of installation on the given host Attributes: Attribute Description Specifies a unique identifier (used when referring to this host from other elements in the install profile) id The property Element The property element specifies a property of a host, service or component. Attributes: Attribute Description name Specifies the name of the property value Specifies the value of the property The administration-set Element The administration-set element list services that always run on the admin node. The configuration-service Element The configuration-service element specifies the location of the configserver component. Attributes: 67 Install Profile DTDAttribute Description id Specifies a unique identifier host-ref Identifies the host running the configserver The log-service Element The log-service element specifies the location of the log server component. Attributes: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the logserver The clarity Element The clarity element specifies the location of the clarity component. Attributes: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the clarity The administration-gui Element The administration-gui element specifies the location of the admin gui. Attributes: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the admin gui The resource-service Element The resource-service element specifies the location of the resource service. Attributes: 68 FAST Enterprise Search PlatformAttribute Description id Specifies a unique identifier host-ref Identifies the host running the resource The admin-service Element The admin-service element specifies the location of the admin server component. Attributes: Attributes Description id Specifies a unique identifier host-ref Identifies the host running the admin server Specifies the hostname of the smtp server used by the adminserver's MailSenderService (this can be empty) smtp-server-host smtp-server-port Specifies the port of smtp server (this can be empty) The storage-service Element The storage-service element specifies the location of the storage service. Attributes: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the storage service admin Specifies the user name of the storage service's admin user adminpassword Specifies the password of the storage service's admin user Specifies the user name of the storage service's ordinary user (normally the user used when contacting the storage service) user userpassword Specifies the password of the storage service's ordinary user The log-transformer-set Element 69 Install Profile DTDThe log-transformer-set element specifies the components that make up the log-transformer service. Note: Currently only one log-transformer is supported. Attributes: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the log-transformer The data-source-set Element The data-source-set element specifies data sources for the system. Note: Currently only the crawler data source is supported. Although, multi-node crawlers are supported by the system, each crawler in this list will be considered a separate data source. Attributes for crawler : Attribute Description id Specifies a unique identifier host-ref Identifies the host running the crawler Note: The crawler element is normally optional. If ESP is installed without a license for the crawler, the crawler element can not be used. The content-distributor-set Element The content-distributor-set specifies a list of content distributors for the system. Properties for content-distributor : Property Description Set this property to true to make the given content distributor the master; otherwise set it to false. Note that there must be a specified master content distributor but not more than one at the time. master Attributes for content-distributor : Attribute Description id Specifies a unique identifier host-ref Identifies the host running the content distributor 70 FAST Enterprise Search PlatformThe search-engine-set Element The search-engine-set element specifies a list of search engines. Using the search and index properties each search engine can be configured to perform indexing, searching or both. Properties for search-engine : Property Description Set this property to true to make the given search engine perform indexing; otherwise set it to false index Set this property to true to make the given search engine perform search; otherwise set it to false search Attributes for search-engine : Attribute Description id Specifies a unique identifier host-ref Identifies the host running the search engine Note: These attributes are required when the search-engine element is used in context of the search-engine-set . Refer to the search-engine-column element for usage of the id-ref attribute. The document-processor-set Element The document-processor-set element specifies a list of document processors to be installed. Attributes for document-processor :Attribute Description id Specifies a unique identifier host-ref Identifies the host running the document processor The query-result-processor-set Element The query-result-processor-set element specifies a list of query result processors to be installed. Properties for query-result-processor : 71 Install Profile DTDThe default language of queries (i.e., "en", "de", "es", "it", "fr", "pt", "no", "nl" or "ko") default-language language A comma-separated list of languages, specifying spell-checking languages to support Note: All query result processors in a cluster must have the same settings for these properties. Attributes for query-result-processor : Attribute Description id Specifies a unique identifier host-ref Identifies the host running the query result processor These attributes are required when the query-result-processor element is used in context of the query-result-processor-set . Refer to search-engine-cluster element for usage of the id-ref attribute. The webanalyzer Element The webanalyzer element specifies a list of webanalyzer nodes to be installed. Attributes of webanalyzer nodes: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the webanalyzer node Specifies whether this node should run in server mode ("true" or "false"). This must be "true" for one and only one webanalyzer node. It is assumed to be "false" if this attribute is not specified server Specifies the number (between 1 and 16) of concurrent processes that should process links on each link-processor node. This attribute can only be specified on the server node max-targets link-processing Specifies whether the node should run link processing ("true" or "false") lookup-db Specifies whether the node should run a lookup database ("true" or "false") The subsystem-dispatcher-set Element The subsystem-dispatcher-set element contains a list of subsystem dispatchers. Currently, only zero or one subsystem dispatcher is supported. 72 FAST Enterprise Search PlatformAttributes for subsystem-dispatcher : Attribute Description id Specifies a unique identifier host-ref Identifies the host running the subsystem dispatcher The indexing-dispatcher-set Element The indexer-dispatcher-set element specifies a list of indexing dispatcher components to be installed. Attributes for indexing-dispatcher : Attribute Description id Specifies a unique identifier host-ref Identifies the host running the indexing dispatcher The name-service Element The name-service element specifies a list of name servers that compose the name service. Attributes for name-server: Attribute Description id Specifies a unique identifier host-ref Identifies the host running the name server The license-service Element The license-service element specifies a list of license servers that compose the license service. Note: Currently, only a single-node license service is supported by the installer. In the special case where the license file refers to a license server external to the ESP installation, the license-server element can not be used. Attributes for license-server : 73 Install Profile DTDAttribute Description id Specifies a unique identifier host-ref Identifies the host running the license server The search-engine-cluster-set Element The search-engine-cluster-set element specifies the list of search engine clusters (clusters) that are to be installed. Each cluster consists of a number of search engine columns and has associated with it one or more query result processors and indexing dispatchers. Properties for search-engine-cluster : Property Description The type of index profile to use for the cluster, i.e., "standard", "lemmas", "geo" or "custom". index-profile-type The full path to a custom index profile (note that this property is only used if index-profile-type is "custom") index-profile-filename The full path to a custom rank model (or models) used by the index profile (note that this property is only used if index-profile-type is "custom") rank-model-filename Specifies whether index-copying is enabled (index-copying can be disabled if the indexer and search nodes in each column share a common filesystem for the index data) copy-index Attributes for search-engine-cluster :Attribute Description id Specifies a unique identifier The search-engine-column Element The search-engine-column element contains one search-engine element for each search engine in the column. Attributes for search-engine-column : Attribute Description id Specifies a unique identifier Attributes for search-engine : 74 FAST Enterprise Search PlatformAttribute Description id-ref Specifies the unique id of the search engine, as specified in the search engine set In the context of a search engine column, the id-ref attribute is required, while the id and host-ref attributes cannot be used. The query-result-processors Element The query-result-processors element contains one query-result-processor element for each query result processor in a cluster. Attributes for query-result-processor : Attribute Description Specifies the unique id of the query result processor as specified in the query result processor set id-ref In the context of the query-result-processors element, the id-ref attribute is required, while the id and host-ref attributes cannot be used. The indexing-dispatchers Element The indexing-dispatchers element contains one indexing-dispatcher element for each indexing dispatcher in a cluster. Attributes for indexing-dispatcher : Attribute Description Specifies the unique id of the indexing dispatcher, as specified in the indexing dispatcher set id-ref In the context of the indexing-dispatchers element, the id-ref attribute is required, while the id and host-ref attributes cannot be used. The alert-engine-subsystem Element This element is not currently supported. 75 Install Profile DTD