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

...

If using PostgreSQL, add a new rule to the Windows firewall allowing all traffic inbound to the PostgreSQL TCP port.  Run the following from an elevated command prompt.  This command will work on Windows Server 2008 R2 or later.  The default PostgreSQL TCP port is 5432.  Substitute this with the correct port in the following command if the port has been changed:

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.

...

  • 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 

...

Code Block
languagepowershell
themeRDark
# Create an array of Locator service names in the order they should be stopped. Get the fetch services first.
$vwServices= Get-Service | Where { $_.DisplayName -like "*Locator *Fetch*" }

$vwServices= Get-Service | Where { $_.DisplayName -like "*ayfie*Fetch*" }

# These services must be stopped in this order after fetch services are stopped.
$vwServiceNames= @(
"Via.Index.Service",
"Locator IndexBuilder",
"Via.Licensing.Service",
    "Locator DatabaseService"
)
# Add to the array of services for each of the additional services that are NOT fetch services
foreach ($n in $vwServiceNames) {
$vwServices += (Get-Service -Name $n)
}

# Stop each Locator service
$vwServices| ForEach-Object {
Stop-Service $_.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.

...

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, on the Database Information page, leave the drop down as PostgreSQL and the database name

...

  1. 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
    Image Added

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


Configuring a Locator Fetch Server in a multi-server environment

  1. Make sure you have installed and configured the primary Locator Server, see Installing/configuring a Primary Server in a multi-server environment
  2. Postgres only: steps 2-3
    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 Index Service
        • Locator IndexBuilder Service
        • Locator Licensing Service
        • 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= Get-Service | Where { $_.DisplayName -like "*Locator *Fetch*" }
    
    $vwServices= Get-Service | Where { $_.DisplayName -like "*ayfie*Fetch*" }
    
    # These services must be stopped in this order after fetch services are stopped.
    $vwServiceNames= @(
    "Via.Index.Service",
    "Locator IndexBuilder",
    "Via.Licensing.Service",
        "Locator DatabaseService"
    )
    # Add to the array of services for each of the additional services that are NOT fetch services
    foreach ($n in $vwServiceNames) {
    $vwServices += (Get-Service -Name $n)
    }
    
    # Stop each Locator service
    $vwServices| ForEach-Object {
    Stop-Service $_.Name -Verbose
    }

...


  1. 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.

    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. .

...



  1. Disable all non-fetch Locator services except the Locator Index Service by executing the command in an elevated PowerShell session:

    Code Block
    languagepowershell
    themeRDark
    $fetchServices= Get-Service | Where {$_.DisplayName -like "*Locator*" -and $_.DisplayName -notlike "*Locator*Fetch*" -and $_.DisplayName -notlike "*Index Service*"}$fetchServices| Set-Service -StartupType Disabled -Verbose



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

    Code Block
    languagepowershell
    themeRDark
    $authorityService= Get-Service | Where {$_.DisplayName -like "ayfie Authority Service"}
    $authorityService| Set-Service -StartupType Disabled -Verbose
    $authorityService| ForEach-Object {Stop-Service $_.Name -Verbose}


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

    Code Block
    languagepowershell
    themeRDark
    Get-Service | Where {$_.DisplayName -like "*Locator*Fetch*" -or $_.DisplayName -like "*Index Service*"} | ForEach-Object {
    Start-Service -Name $_.Name -Verbose
    Start-Sleep -Seconds 10
    }

...

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

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


  1. 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
  3. If you plan to use the fetch server as a search server as well, you need to set it up as a searc server, see Installing/Configuring a Secondary Search Server


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. 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 schedule.


See also

Child pages (Children Display)
pageInstalling the ayfie Locator Server