How to manage the Managed Cloud Solr server

  • You can request the Solr server as an alternative search indexing service when you request a new set provisioning within the scope of the Sitecore Managed Cloud service. How to request a new Managed Cloud set with Solr is described here.

  • When the Managed Cloud team deploys a Solr implementation for a customer, access is enabled for a single user account (see How To Access Solr Server Admin UI below for details) and zkcli access is denied to the public. An API key is also provided that one can use to modify the Solr configuration. See How To Upload a ConfigSet and Create a Collection below for details.
  • After provisioning, Sitecore provides the URL of the Solr server and user credentials.
    For example, the Solr URL could be: https://<server_name>-azure.searchstax.com/solr/

    To access the Solr Admin UI, open the URL and enter the user name and password.

    The following is an example of a Solr Admin UI:

  • By default, there is only an admin user on a provisioned Solr server. A customer can create a new user using a REST API request.
    Note: Sitecore provides the admin user name, password, and API key after provisioning is done.

    To create a new user, use the following POST request:

    URI:

    https://app.searchstax.com/api/rest/v2/account/SitecoreLive/deployment/<server_name>/solr/auth/add-user/
    Headers:
    Authorization: APIkey <API_key>

    Body in json format:

    {
      "username": "<user_name>",
      "password": "<user_password>",
      "role": "<role>"
    }

    To delete a user, use the following POST request:

    URI:

    https://app.searchstax.com/api/rest/v2/account/SitecoreLive/deployment/<server_name>/solr/auth/delete-user/

    Header:

    Authorization: APIkey <API_key>

    Body in json format:

    {
      "username": "<user_name>"
    }

    Where:

    • server_name: Solr server short name, provided by Sitecore.
    • API_key: Solr server API key, provided by Sitecore.
    • user_name: new user name, should start with letter, no spaces allowed.
    • user_password: new user password.
    • role: accepts the following values: Read, Write, Admin.
  • The provisioned SolrCloud server already contains a valid Sitecore configset. Customers can create new search collections and define new fields through two main methods.

    Option 1
    The best practice for working with Solr configurations is through the documented API. This is a public repo with examples of how to use this API: https://github.com/searchstax/searchstax-client-powershell/tree/master/restapi. The usual pattern for making an update to the Solr configuration, such as adding a new search field, is to download the current configuration through the API, make changes locally, and then upload the change through the API. See accountdeploymentzookeeperconfigdownload.ps1 and accountdeploymentzookeeperconfigcreate.ps1 from the GitHub for example of this pattern.

    Option 2
    Customers can also upload a new configset using the Zookeeper tool (zkcli) and create new collections based on the new configset. See detailed instructions of how to upload a configset and create collections described in this article (refer to the Upload the configuration to Zookeeper section and Create a collection section). Note that by default, the Zookeeper endpoint will not allow access; to add an IP that can access Zookeeper and use this approach, please enter a support ticket with the Sitecore Managed Cloud team.
  • You can view server files by clicking Cloud, Tree in the menu on the left. Here, you can browse all the configsets and collections data:

    Also, you can find all the collections by clicking Collections in the menu on the left:

Applies to:

Managed Cloud 1+

April 02, 2019
August 04, 2020