You are here

Configuring Solr sharding using the Admin Console

Shard instances are registered dynamically with an Alfresco Content Services 5.2.7 repository or cluster. Use this information to know more about the Index Server Sharding page.

Prerequisites for viewing the Index Server Sharding page:
  • Check that you have a valid Alfresco Content Services 5.2.7 license.
  • Support for shard groups requires a clustered license. Make sure that you enable clustering on your license. For more information, see Repository server clustering and Uploading a new license.
  1. Open the Admin Console. For more information, see Launching the Admin Console.
  2. In Repository Services, click Index Server Sharding.

    You see the Index Server Sharding page. It displays information about dynamic shard index registration, shard groups, and shard instances.

  3. Under Dynamic Shard Instance Registration, set the shard instance properties.

    Shard registration property Example setting What is it?
    Dynamic Shard Instance Registration Enabled Yes Select this property to enable dynamic shard instance registration. If disabled, manual shard registration is used.
    Purge at Startup No This property purges all persisted dynamic shard instance information at startup.
    Instance Timeout (seconds) 100 This specifies the number of seconds a shard instance can go without making a tracking call for transactions to the repository before it stops being used for queries.
    Note: When tracking large change sets or rebuilding your indexes, increase the shard timeout. For example, change the value of this property to 3200 or 7200 seconds.
    Max Instance Transaction Lag 1000 This specifies the maximum number of transactions a instance can lag behind the lead instance of the shard before it stops being used for queries.
  4. Click Refresh to refresh this page.
  5. Click Purge to remove all registered shard instance information and start from clean.
  6. Click Clean to remove inactive registered shard instance information.
  7. Click Manage to create and manage shard instances.

    You see the Index Server Shard Management window. Use this window to create individual shards or shard groups.

    1. Use Existing Index Servers to view a list of existing index servers and to create new index servers.

      1. To add a new index server, specify the server address in New Index Server and click Add.

        You can view the newly created index server under Existing Index Servers.

      2. You can view a list of the core names already in use under Existing Core Names.
    2. Under Existing Index Servers, click Add to Target Index Servers next to the server you want to add to the list of target index servers.

      Target Index Servers displays a list of index servers where you want to make the new shards.

      The selected index server appears in the list under Target Index Servers.

    3. To create a shard group, set the following properties under New Shard Group:

      Shard group property Example setting What is it?
      Template rerank This specifies the template used for the shard group.
      Store workspace://SpacesStore This specifies the stores that are queryable for all shards.
      Core   This specifies the name of the Solr core.
      Properties solr.suggester.enabled This specifies the properties to set on the Solr instances. These are the same properties that are set in the solrcore.properties file.
      Shards 1 This specifies the total number of shards.
      Instances 1 This specifies the total number of instances.

    4. Click Create Shards Group to create new shards based on the ordered list of target index servers.
    5. To create a single shard instance, set the following properties under New Shard Instance:

      Shard property Example setting What is it?
      Index Server URL localhost:8080/solr4 This specifies the URL to a single index server.
      Nodes 1 This specifies the total number of Solr nodes that have been created.
      Target Index Server 1 This specifies, out of all the solr nodes above, the number given to the target index server node for this new shard.
      Shards   This specifies the specific shards to create, on the node given above. You can also specify a comma-separated list of shards.

      See Installing and configuring Solr shards to view examples of creating shards when calling the REST URLs directly.

    6. Click Create Shards to create the new shard based on the specified instance properties.
    7. Use Report to get detailed information on shard creation and execution.
    8. Click Close to close the Index Server Shard Management window.
  8. Under Shard Groups, you can view information about all the shards in the group.

    Shard registration property Example setting What is it?
    Template rerank This specifies the template used for the Solr core.
    Low Instance Shards   This specifies a list of shards that have less than the maximum number of instances.
    Missing Shards 100 This specifies a comma-separated list of shards with no instances.
    Max Repository Transaction ID 14,637 This specifies the maximum number of transaction IDs in the repository.
    Max Live Instances 1 This specifies the maximum number of instances available for any shard that can be used to answer a query.
    Remaining Transactions 2 This specifies the maximum number of transactions remaining for all the lead instances of all the active shards.
    Number of Shards 4 This specifies the total number of shards.
    Min Active Instances 1 This specifies the minimum number of instances available for any shard that can be used to answer a query.
    Max Changeset ID 104 This specifies the highest change set id in the repository.
    Mode MASTER This specifies whether the instances are SLAVE, MASTER, or MIXED.
    Note: The SLAVE and MIXED instances are not supported for a sharded installation.
    Stores workspace://SpacesStore This specifies the stores that are queryable for all instances.
    Has Content Enabled This property is enabled if content is included for all instances.
    Shard Method MOD_ACL_ID This specifies the method used to define shards.

  9. Use the instance property table to view detailed entity information for all the shards. This is the same information that is displayed in the JMX console, for example, Base URL, Host, Last Indexed Changeset Date, and more.

    For more information, see Indexing information available in a JMX client.

    1. Click Summary to go to the http://localhost:8080/solr4/admin/cores?action=SUMMARY page on Solr for the specific core.

      For more information, see Unindexed Solr Transactions.

    2. Click SOLR to go to the Solr Admin screen for the specific core.

      For more information, see Connecting to the SSL-protected Solr web application.

  10. The Shard Group Report section displays information about the shard groups and instances. A tabular view of this information is displayed in the shard table in Step 9. This information is read-only.

  11. Click Save to apply the changes you have made to the index server shards.

    If you do not want to save the changes, click Cancel.

Note: We recommend that you do not use the Solr Admin Console > Core Admin > Unload functionality to unload indexes (either whole indexes or shards that are part of an index). Unloading an index or a shard in this way will delete it and make it unavailable for query.

If you unload or delete a shard from the Solr Admin Console, make sure you restart the Solr server and restore your indexes so that Alfresco Content Services can work properly.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.