Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Locator supports the deployment of multiple Locator servers, configured to work together to index documents from the various data sources within the customer environment.  In a multi-server scenario, the primary Locator server will be used to establish connections, "crawl" and discover documents to be indexed from each connection, and perform the conversion and indexing, while the secondary servers are used strictly to assist in the conversion process.  This document describes the process of deploying a secondary Locator server to enable the additional server to fetch and convert documents.

 

When Installing a New Secondary Locator Server

...

Prerequisites

Installing a Locator Fetch Server in a multi-server environment

  1. In the Locator Installer choose Custom Install 
    Image Added
  2. On the Server Address page, replace localhost with the primary server hostname for the Licensing service address field
  3. For the Zookeeper address, replace localhost with the primary server IPV4 address and keep the port :9983
  4. If using PostgreSQL,

...

Code Block
languagepowershell
themeRDark
netsh advfirewall firewall add rule name="PostgreSQL (TCP-In)" protocol=TCP localport=5432 action=allow dir=IN

Add a new rule to the Windows firewall allowing all traffic inbound on TCP port 60010 for Locator licensing.  Run the following from an elevated command prompt.  This command will work on Windows Server 2008 R2 or later:

Code Block
languagepowershell
themeRDark
netsh advfirewall firewall add rule name="Locator Licensing (TCP-In)" protocol=TCP localport=60010 action=allow dir=IN

Add a new rule to the Windows firewall allowing all traffic inbound on TCP port 9983 for Zookeeper.  Run the following from an elevated command prompt.  This command will work on Windows Server 2008 R2 or later:

Code Block
languagepowershell
themeRDark
netsh advfirewall firewall add rule name="Locator Zookeeper (TPC-In)" protocol=TCP localport=9983 action=allow dir=IN

...

Add a new rule to the Windows firewall allowing all traffic inbound on TCP port 8983 for Solr.  Run the following from an elevated command prompt.  This command will work on Windows Server 2008 R2 or later:

Code Block
languagepowershell
themeRDark
netsh advfirewall firewall add rule name="Locator Solr (TPC-In)" protocol=TCP localport=8983 action=allow dir=IN remoteip=xxx.xxx.xxx.xxx,yyy.yyy.yyy.yyy

Replace xxx.xxx.xxx.xxx and yyy.yyy.yyy.yyy with the IP(s) of the servers involved with the multi server setup. This applies both to servers in a multi server SOLR ViaWorksCloud setup, as well as setups where additional fetch servers are set up.

...

  1. on the Database Information page, leave the drop down as PostgreSQL and the database name as Locator.
  2. If using Microsoft SQL, on the Database Information page, change the drop down as Microsoft SQL Server and fill in the database server hostname, database name and database user account credentials. Click Verify Connection
  3. Choose the following components: IMPORTANT: Admin dashboard needs to be installed as well (update image below)
    Image Added

  4. Finish the installer and wait for the installation to complete.


Configuring a Locator Fetch Server in a multi-server environment

Before you start: If you plan to use the server as both a search and fetch server, you need to skip the step disabling the Via.Index.Service and make sure the server is configured as a search server. See Installing/Configuring a Secondary Search Server.

  1. Make sure you have installed and configured the primary Locator Server, see Installing/configuring a Primary Server in a multi-server environment
  2. Once installed, stop all Locator services in the specified order.  This can be accomplished either manually, via the Windows Services UI, or from a PowerShell session.

    Windows Services UI Method

    From the Windows Services app, stop each Locator Service in the following order:


        • All Fetch Services, in any order (e.g.

...

        • ayfie FileServer Fetch Service,

...

        • ayfie Exchange Fetch Service, etc.)
        • Locator 

...

        • IndexBuilder Service (if existing)
        • Locator 

...

        • Index Service (if existing)
        • Locator Licensing

...

        • Service (if existing)
        • Locator Database

...

        • Service


    PowerShell Method

    Paste the following code into an elevated PowerShell session to stop all Locator services:

    Code Block
    languagepowershell
    themeRDark
    # Create an array of Locator service names in the order they should be stopped. Get the fetch services first.
    $vwServices=

...

  1.  Get-

...

  1. Service | Where { $_.DisplayName -like "*ViaWorks*Fetch*"

...

  1.  -or $_.DisplayName -like "*Locator*Fetch*" -or $_.DisplayName -like "*ayfie*Fetch*"

...

  1. }
    
    # These services must be stopped in this order after fetch services are stopped.
    $vwServiceNames =

...

  1.  @(
    "ViaWorksIndexBuilder",
    "Via.Index.Service

...

  1. ",
    "Via.Licensing.Service",

...

  1. 
    "

...

  1. ViaWorksDatabaseService"
    )
    
    # Add to the array of services for each of the additional services that are NOT fetch services
    

...

  1. foreach ($n in $vwServiceNames) {
    

...

  1.     $vwServices +=

...

  1.  (Get-

...

  1. Service -Name $n)
    }
    
    # Stop each Locator service
    $vwServices|

...

  1.  ForEach-

...

  1. Object {
        Stop-

...

  1. Service $_.

...

  1. Name -Verbose
    }

...

listen_addresses='*'

Start all Locator services in the reverse order that they were stopped in step #3.  Perform this manually from the Services UI or by pasting the following code into the same elevated PowerShell session to start all of the Locator services:

Code Block
languagepowershell
themeRDark
[array]::Reverse($vwServices)
$vwServices | Start-Service -Verbose

...

Add a new rule to the Windows firewall allowing all traffic inbound on TCP port 8983 for Solr.  Run the following from an elevated command prompt.  This command will work on Windows Server 2008 R2 or later:

Code Block
languagepowershell
themeRDark
netsh advfirewall firewall add rule name="Locator Solr (TPC-In)" protocol=TCP localport=8983 action=allow dir=IN remoteip=xxx.xxx.xxx.xxx,yyy.yyy.yyy.yyy

Replace xxx.xxx.xxx.xxx and yyy.yyy.yyy.yyy with the IP(s) of the servers involved with the multi server setup. This applies both to servers in a multi server SOLR ViaWorksCloud setup, as well as setups where additional fetch servers are set up.

...

Install Locator using the Custom install path

  1. On the Server Address page, replace localhost with the primary server hostname for the Licensing service address field
  2. For the Zookeeper address, replace localhost with the primary server IPV4 address and keep the port :9983
  3. If using PostgreSQL, on the Database Information page, leave the drop down as PostgreSQL and the database name as Locator .
  4. Finish the installer and wait for the installation to complete.

...

      • All Fetch Services, in any order (e.g. ayfie FileServer Fetch Service, ayfie Exchange Fetch Service, etc.)
      • Locator Index Service
      • Locator IndexBuilder Service
      • Locator Licensing Service
      • Locator Database Service

...

  1. NOTE: IndexBuilder, Index.Service and Licencing.Service might not be installed (if following instructions on this page) and will produce errors that can be ignored. A change in the script that checks if the service exists would be great.

  2. From Locator 2.11 and above: The ayfie Authority Service is available from Locator 2.11. This component should not have been selected during Custom Install. If installed on the Fetch Server anyway, stop and disable the ayfie Authority service. Perform this manually from the Services UI by executing the command in an elevated PowerShell session:

    Code Block
    languagepowershell
    themeRDark

...

  1. $authorityService= Get-Service | Where {

...

  1. $_.DisplayName -like "

...

  1. ayfie

...

  1.  Authority Service"}
    $authorityService| ForEach-Object {

...

  1. Stop-Service $_.Name -Verbose

...

  1. }
    $authorityService| Set-Service -StartupType Disabled -Verbose


  2. Postgres only: If you used Custom Install Path in the Locator Installer these values should have already been set. Please verify in %ProgramFiles%\ayfie\Locator\Config\DataAccess.config. If the values are localhost, do the following from an elevated command prompt, first make a backup copy and then edit the file %ProgramFiles%\ayfie\Locator\Config\DataAccess.config

    1. Change the value of the “ViaDatabaseServer” key to reflect the IPv4 address of the Primary Locator server as opposed to the default value of 127.0.0.1.

      Code Block
      languagexml
      <add key="ViaDatabaseServer" value="<IPv4_addr>" />


    2. Add this line before the </appSettings> line:

      Code Block
      languagexml
      <add key="LicensingServiceServer" value="<IPv4_addr>" />


      Where 
      <IPv4_addr> is the IPv4 address of the Primary Locator server.

...


  1. Disable all non-fetch Locator

...

  1. services by executing the command in an elevated PowerShell session:

    Code Block
    languagepowershell
    themeRDark

...

  1. # These services must be stopped in this order after fetch services are stopped.
    $vwServiceNames = @(
    "ViaWorksIndexBuilder",
    "Via.Index.Service",
    "Via.Licensing.Service",
    "ViaWorksDatabaseService"
    )
    $vwServiceNames | Set-Service -StartupType Disabled -Verbose


  2. Start all of the Locator fetch services by executing the command in an elevated PowerShell session:

    Code Block
    languagepowershell
    themeRDark
    Get-Service | Where { $_.

...

  1. DisplayName -like "*ViaWorks*Fetch*" -or $_.DisplayName -like "*Locator*Fetch*" -or $_.DisplayName -like "*ayfie*

...

  1. Fetch*"} | ForEach-Object {
    Start-Service -Name $_.Name -Verbose
    Start-

...

If using Microsoft SQL, on the Database Information page, change the drop down as Microsoft SQL Server and fill in the database server hostname, database name and database user account credentials. Click Verify Connection

...

  1. Sleep -Seconds 10
    }


  2. After completing these steps, the secondary server will be able to function as a fetch and conversion node once it has been configured in the scheduler.

...

  1.  
  2. Open Locator Management Console and install the required connectors


Verify Configuration and Assign

Secondary

Fetch Server

  1. On the Primary Locator server:
    1. (Optional for PostgreSQL installations) From an elevated command prompt, run %ProgramFiles%\ayfie\Locator\PostgreSQL\bin\pgAdmin3.exe
    2. Select the Locator database
    3. Select the SQL button and paste the following text into the window:

      Code Block
      languagesql
      SELECT * FROM config.via_works_server;


    4. Run the query
    5. Verify there is a second row showing the secondary Locator server (see the
    ADDITIONAL_COMPUTERNAME and ADDITIONAL_COMPUTER_FQHN columns). <--- IS THIS TRUE?
    1. computer_name and dns_name columns).
    2. Close pgAdmin
  2. Start the Locator Management Console and on the "Scheduling" page under Connections, assign the secondary server to each of the connections in each of the connectors from which the secondary server will be used to fetch documents.
 
    1. The secondary server should have the “Perform Discovery” option disabled and the “Perform Fetch” option enabled.
    2. Remember to click "Save" after assigning the server to each connection. 
    3. Note that the secondary server’s schedule must be set and is independent of the primary server’s scheduleSee Scheduling (Connections).


See also

Child pages (Children Display)
pageInstalling the ayfie Locator Server