16.2 Setting Up a High Availability Lucene Configuration

16.2.1 Changing from a Local Lucene Index Server

To change from a local Lucene Index Server running on the Novell Vibe server, you must install the Lucene Index Server on two or more remote servers, then reconfigure Vibe for a high availability Lucene configuration.

NOTE:Although it is possible to use the Lucene Index Server on the Vibe server as one of the “remote” Lucene nodes, this is not a recommended configuration. Consider it only if you are restricted to two servers for your Vibe site.

  1. Set up two or more Lucene nodes:

    1. Install the Lucene Index Server on each node, as described in Section 14.1, Installing the Lucene Software.

    2. (Optional) Copy accumulated index data from the initial Lucene Index Server to each additional Lucene node.

      The default location for the index files varies by platform:

      Linux:

      /var/opt/novell/teaming/lucene

      Windows:

      c:\Novell\Teaming\lucene

    3. Start the Lucene Index Server on each Lucene node, as described in Section 14.3, Managing a Remote Lucene Index Server.

  2. Stop Vibe.

    If you have installed the Vibe software on multiple servers, as described in Section 15.0, Running Vibe on Multiple Servers, stop Vibe on all servers, or follow the instructions in Section 16.2.4, Changing Your Lucene Configuration without Vibe Site Down Time.

  3. Run the Vibe installation program to configure the Vibe server for multiple Lucene nodes:

    1. On the Installation Settings page, select Reconfigure Settings, then click Next.

    2. On the Choose Installation Type page, select Advanced, then click Next.

    3. Click Next to proceed through the installation pages where no changes are needed.

    4. On the Lucene Configuration page, fill in the following fields:

      Lucene configuration type: Select high availability.

      Number of high availability search nodes: Specify the number of Lucene nodes where you have installed and started the Lucene Index Server.

      Lucene Configuration page
    5. Click Next.

    6. On the Configure High Availability Search Nodes page, specify the configuration information for each Lucene node from the Advanced Vibe Installation Summary Sheet that you filled out in Section 16.1, Planning a High Availability Lucene Configuration, then click Next.

      Lucene High Availability Search Nodes page
    7. Click Next until you reach the Ready to Install page, then click Install.

    8. On the Installation Complete page, click Finish.

    9. Start Vibe.

    10. (Conditional) If you have multiple Vibe servers, repeat Step 3 on each Vibe server.

  4. Configure the Vibe site for the additional Lucene nodes:

    1. Log in to the Vibe site as the Vibe administrator.

    2. Click the Settings icon Lucene High Availability Search Nodes page in the upper right corner of the page, then click the Administration Console icon Lucene High Availability Search Nodes page.

    3. Under Search Index, click Nodes.

      Lucene Nodes page

      By default, the first Lucene node in the list has Read and Write access, meaning that Vibe updates it as new content is added to the Vibe site. By default, subsequent nodes in the list have Write Only access, meaning that the Vibe software can update content on the server, but users cannot access it. This setting is useful when you need to perform maintenance on a Lucene node, but it is not the setting you want when you set up a new Lucene node.

    4. In the User Mode Access box, select Read and Write for all Lucene nodes, click Apply, then click Close.

      The new setting is put into effect immediately, so that users immediately have access to the additional Lucene nodes.

  5. Skip to Section 16.3, Testing Your Lucene High Availability Configuration.

16.2.2 Changing from a Single Remote Lucene Index Server

To change from a single remote Lucene Index Server to a high availability configuration, you must install the Lucene Index Server on one or more additional remote servers, then reconfigure Novell Vibe for additional Lucene nodes.

  1. Bring down your Vibe site:

    1. Stop Vibe.

      If you have installed the Vibe software on multiple servers, as described in Section 15.0, Running Vibe on Multiple Servers, stop Vibe on all servers, or follow the instructions in Section 16.2.4, Changing Your Lucene Configuration without Vibe Site Down Time.

    2. Make sure that the existing remote Lucene Index Server also stops.

  2. Set up one or more additional Lucene nodes:

    1. Install the Lucene Index Server on each additional remote server, as described in Section 14.1, Installing the Lucene Software.

    2. (Optional) Copy accumulated index data from the initial remote Lucene node to each additional Lucene node.

      The default location for the index files varies by platform:

      Linux:

      /var/opt/novell/teaming/lucene

      Windows:

      c:\Novell\Teaming\lucene

    3. Start the Lucene Index Server on each Lucene node, as described in Section 14.3, Managing a Remote Lucene Index Server, but do not bring up your Vibe site.

  3. Run the Vibe installation program to configure the Vibe server for multiple Lucene nodes:

    1. On the Installation Settings page, select Reconfigure Settings, then click Next.

    2. On the Choose Installation Type page, select Advanced, then click Next.

    3. Click Next to proceed through the installation pages where no changes are needed.

    4. On the Lucene Configuration page, fill in the following fields:

      Lucene configuration type: Change server to high availability.

      Number of high availability search nodes: Specify the number of Lucene nodes where you have installed the Lucene Index Server.

      Lucene Configuration page
    5. Click Next.

    6. On the Configure High Availability Search Nodes page, specify the configuration information for each Lucene node from the Advanced Vibe Installation Summary Sheet that you filled out in Section 16.1, Planning a High Availability Lucene Configuration, then click Next.

      Lucene High Availability Search Nodes page
    7. Click Next until you reach the Ready to Install page, then click Install.

    8. On the Installation Complete page, click Finish.

    9. Start Vibe.

    10. (Conditional) If you have multiple Vibe servers, repeat Step 3 on each Vibe server.

  4. Configure the Vibe site for the additional Lucene nodes:

    1. Log in to the Vibe site as the Vibe administrator.

    2. Click the Settings icon Lucene High Availability Search Nodes page in the upper right corner of the page, then click the Administration Console icon Lucene High Availability Search Nodes page.

    3. Under Search Index, click Nodes.

      Lucene Nodes page

      By default, the first Lucene node in the list has Read and Write access, meaning that Vibe updates it as new content is added to the Vibe site. By default, subsequent nodes in the list have Write Only access, meaning that the Vibe software can update content on the server, but users cannot access it. This setting is useful when you need to perform maintenance on a Lucene node, but it is not the setting you want when you set up a new Lucene node.

    4. In the User Mode Access box, select Read and Write for all Lucene nodes.

    5. Click Apply, then click Close.

      The new setting is put into effect immediately, so that users immediately have access to the additional Lucene nodes.

  5. Skip to Section 16.3, Testing Your Lucene High Availability Configuration.

16.2.3 Expanding an Existing High Availability Lucene Configuration

After you have set up an initial high availability Lucene configuration, you can add additional Lucene nodes at any time.

  1. Bring down your Vibe site:

    1. Stop Vibe.

      If you have installed the Vibe software on multiple servers, as described in Section 15.0, Running Vibe on Multiple Servers, stop Vibe on all servers, or follow the instructions in Section 16.2.4, Changing Your Lucene Configuration without Vibe Site Down Time.

    2. Stop all Lucene nodes, as described in Section 14.3, Managing a Remote Lucene Index Server.

  2. Set up one or more additional Lucene nodes:

    1. Install the Lucene Index Server on each additional remote server, as described in Section 14.1, Installing the Lucene Software.

    2. (Optional) Copy accumulated index data from an existing Lucene node to each additional Lucene node.

      The default location for the index files varies by platform:

      Linux:

      /var/opt/novell/teaming/lucene

      Windows:

      c:\Novell\Teaming\lucene

    3. Start the Lucene Index Server on each Lucene node, as described in Section 14.3, Managing a Remote Lucene Index Server, but do not bring up your Vibe site.

  3. Run the Vibe installation program to configure the Vibe server for the additional Lucene nodes:

    1. On the Installation Settings page, select Reconfigure Settings, then click Next.

    2. On the Choose Installation Type page, select Advanced, then click Next.

    3. Click Next to proceed through the installation pages where no changes are needed.

    4. On the Lucene Configuration page, increase the number of nodes in the Number of high availability search nodes field, then click Next.

      Lucene Configuration page
    5. On the Configure High Availability Search Nodes page, specify the configuration information for each additional Lucene node, then click Next.

      Lucene High Availability Search Nodes page
    6. Click Next until you reach the Ready to Install page, then click Install.

    7. On the Installation Complete page, click Finish.

    8. Start Vibe.

    9. (Conditional) If you have multiple Vibe servers, repeat Step 3 on each Vibe server.

  4. Configure the Vibe site for the additional Lucene nodes:

    1. Log in to the Vibe site as the Vibe administrator.

    2. Click the Settings icon Lucene High Availability Search Nodes page in the upper right corner of the page, then click the Administration Console icon Lucene High Availability Search Nodes page.

    3. Under Search Index, click Nodes.

      Lucene Nodes page

      By default, the first Lucene node in the list has Read and Write access, meaning that Vibe updates it as new content is added to the Vibe site. By default, subsequent nodes in the list have Write Only access, meaning that the Vibe software can update content on the server, but users cannot access it. This setting is useful when you need to perform maintenance on a Lucene node, but it is not the setting you want when you set up a new Lucene node.

    4. In the User Mode Access box, select Read and Write for all Lucene nodes.

    5. Click Apply, then click Close.

      The new setting is put into effect immediately, so that users immediately have access to the additional Lucene nodes.

  5. Skip to Section 16.3, Testing Your Lucene High Availability Configuration.

16.2.4 Changing Your Lucene Configuration without Vibe Site Down Time

Vibe site down time can be avoided only if you have installed the Vibe software on multiple servers, as described in Section 15.0, Running Vibe on Multiple Servers.

To change to a high availability Lucene configuration in a multiple Vibe server configuration:

  1. Set up two or more Lucene nodes:

    1. Install the Lucene Index Server on each node, as described in Section 14.1, Installing the Lucene Software

    2. Start the Lucene Index Server on each Lucene node, as described in Section 14.3, Managing a Remote Lucene Index Server.

  2. Stop Vibe on one server.

    The other Vibe servers remain in service for users and continue to communicate with the original Lucene Index Server.

  3. Run the Vibe installation program on the Vibe server that you stopped to configure it for multiple Lucene Index Servers:

    1. On the Installation Settings page, select Reconfigure Settings, then click Next.

    2. On the Choose Installation Type page, select Advanced, then click Next.

    3. Click Next to proceed through the installation pages where no changes are needed.

    4. On the Lucene Configuration page, fill in the following fields.

      Lucene configuration type: Select high availability.

      Number of high availability search nodes: Specify the number of Lucene nodes where you have installed the Lucene Index Server.

      Lucene Configuration page
    5. Click Next.

    6. On the Configure High Availability Search Nodes page, specify the configuration information for each Lucene node from the Advanced Vibe Installation Summary Sheet that you filled out in Section 16.1, Planning a High Availability Lucene Configuration, then click Next.

      Lucene High Availability Search Nodes page
    7. Click Next until you reach the Ready to Install page, then click Install.

    8. On the Installation Complete page, click Finish.

  4. Start the reconfigured Vibe server.

  5. Access the reconfigured Vibe server and prevent access to the additional Lucene nodes:

    IMPORTANT:All Vibe servers must be reconfigured before any of them access the additional Lucene nodes.

    1. Log in to the reconfigured Vibe server as the Vibe administrator, using the server hostname rather than your Vibe site URL.

    2. Click the Settings icon Lucene High Availability Search Nodes page in the upper right corner of the page, then click the Administration Console icon Lucene High Availability Search Nodes page.

    3. Under Search Index, click Nodes.

      Lucene Nodes page

      By default, the first Lucene node in the list has Read and Write access, meaning that Vibe updates it as new content is added to the Vibe site. By default, subsequent nodes in the list have Write Only access, meaning that the Vibe software can update content on the server, but users cannot access it. When you set up a high availability Lucene configuration without Vibe site down time, you need to prevent write access during the reconfiguration process.

    4. In the User Mode Access box, change Write Only to No Access for the additional Lucene nodes.

    5. Click Apply, then click Close.

      The new setting is put into effect immediately, so that the reconfigured Vibe server does not communicate with the additional Lucene nodes.

  6. Reconfigure the rest of the Vibe servers:

    1. Stop each Vibe server.

    2. Repeat Step 3 to configure each Vibe server for the additional Lucene nodes.

    3. Start each reconfigured Vibe server.

  7. Access the reconfigured Vibe site and allow write access to the additional Lucene nodes:

    1. Log in to the reconfigured Vibe as the Vibe administrator.

    2. Click the Settings icon Lucene Nodes page in the upper right corner of the page, then click the Administration Console icon Lucene Nodes page.

    3. Under Search Index, click Nodes.

      Lucene Nodes page
    4. In the User Mode Access box, change No Access to Write Only for the additional Lucene nodes.

    5. Click Apply, then click Close.

      The new setting is put into effect immediately, so that the reconfigured Vibe servers can now communicate with the additional Lucene nodes, although user access is still disallowed.

  8. Reindex the Vibe site, so that the additional Lucene nodes are updated with the same index data that the original Lucene Index Server has:

    1. On the Administration page, under Search Index, click Index.

      Manage the Search Index page
    2. On the Manage Search Index tab, select Re-Index Everything, so that the entire Vibe site is reindexed.

    3. Select the additional Lucene nodes, but do not select any previously existing nodes.

    4. Click OK to start the indexing.

      Depending on the size of your Vibe site, reindexing can be a time-consuming process. However, because one or more previously existing Lucene Index Servers are still servicing the Vibe site, users are not affected by the reindexing process.

    5. When the reindexing is completed, click Close.

  9. Make the additional Lucene nodes available to Vibe users:

    1. On the Administration page, under Search Index, click Nodes.

      Lucene Nodes page
    2. In the User Mode Access box, change Write Access to Read and Write for the additional Lucene nodes.

    3. Click Apply, then click Close.

      The new setting is put into effect immediately, so that Vibe users have additional Lucene Index Servers available as they use the Vibe site.