Configure Remote Search in Docker

• The serverindex.xml file on the Remote Search server when deployed to on-premises environments may have a host name that is not accurate in a container environment with respect to the actual host name of the server hosting the Remote Search server.
• Since Docker dynamically allocates the host names for the containers, the /etc/hosts file doesn’t have static entries for the HCL Digital Experience 9.5 container-based server nor the Remote Search server.
• The WebSphere Application Server ND Administration console will not have correct host names for the HCL Digital Experience container.

hcl-dx-core-image-v95_CF181_xxxxxxxx-xxxx.tar.gz

hcl-dx-dxrs-image-v95_CF181_xxxxxxxx-xxxx.tar.gz

./ConfigEngine.sh configure-portal-for-remote-search -DWasPassword={Was Password}

-Dremote.search.host.name  default="remotesearch"
-Dremote.search.host.port  default="9043"
-Dremote.search.cert.alias  default="remotesearchalias"
-Dremote.search.iiop.url  default="iiop://remotesearch:2809"
-Dremote.search.index.directory  default="/opt/HCL/AppServer/profiles/prs_profile/SearchCollections"

1. Retrieve the remote SSL key from the remote search server.
2. Export the LPTA key to a file for the Portal server.
3. Suppress the automatic creation of the Default Search Server on Portal restart, if it doesn't already exist.
4. Set all the Resource Environment Providers for the JCR for WCM Authoring search.

./ConfigEngine.sh configure-remote-search-server-for-remote-search -DWasPassword={Was Password}

-Dremote.search.host.name  default="remotesearch"
-Dportal.host.name default="portaldocker"
-Dportal.port.number default="10042"
-Dportal.cert.alias default="portaldockeralias"

1. Retrieve remote SSL key from the Portal Server.
2. Import the LTPA key exported from the Portal Server in the previous step.
3. Edit the serverindex.xml file to have the correct Remote Search server host name.

/opt/HCL/AppServer/profiles/prs_profile/config/cells/{cell name}/nodes/{node name}

{persisted volume for remote search profile}/prs_profile/config/cells/{cell name}/nodes/{node name}

host=”{some hostname}”

host=”dockerhost” (apply the string “dockerhost”)

1. Create a single sign-on (SSO) domain between HCL Digital Experience 9.5 container and the Remote Search service container by following the non-container on-premises procedure for Creating a single sign-on domain between HCL Portal and the Remote Search service. This entails exchanging SSL certificates and LTPA domain tokens.
   Note: When retrieving the SSL certificates from the host server, use dockerhost (as the host) and the appropriate port for the SSL access. In the examples, the Remote Search server is on dockerhost:9443 and the DX host is on dockerhost:10042. You must also complete Setting the search user ID and Removing search collections before creating a new search service.
2. Create a new search service and use the following values for a Remote Search services configuration to a Docker container deployment. See the section on Creating a new search service for more information.

   Table 1. Docker container Remote Search services configuration

   Item	Value
   IIOP_URL	iiop://dockerhost:2809
   PSE TYPE	Select ejb from the pull down.
   EJB	ejb/com/ibm/hrl/portlets/WsPse/WebScannerLiteEJBHome
   DefaultCollectionsDirectory	Leave empty.
   Search service implementation	Select Portal Search Service Type from the pull down.
   CONFIG_FOLDER_PATH	Did not set (differs from non-container instructions).

   Note: Once completed and saved, the HCL Digital Experience 9.5 container deployment has a new search service called Remote PSE service EJB, with a green check mark confirming that the service was correctly set up and is able to communicate with the Remote Search container.
3. Based on the previously created Remote Search service, create a Portal Search Collection and a JCR Search Collection using the following parameters.
   1. Use the following parameters to create a Portal search collection.

      Table 2. Portal Search Collection configuration

      Parameter	Value
      Search collection name	Portal Search Collection
      Search collection location	/opt/HCL/AppServer/profiles/prs_profile/SearchCollections/PortalSearchCollection

   2. Portal Search Content Source Configuration. Use the following URL for Collect documents linked from this URL:

      https://dockerhost:10042/wps/seedlist/myserver?Source=com.ibm.lotus.search.plugins.seedlist.retriever.portal.PortalRetrieverFactory&Action=GetDocuments&Range=100&locale=en-US

      Note: The host and port are the Docker host and port to which 10042 is mapped. In this case, 10042 is the HttpQueueInboundDefaultSecure port on the HCL Digital Experience server. Note that you can also put this URL in a browser (on the Docker host) and confirm that the response is an ATOM feed.

      On the Security panel, use dockerhost as the host name, along with the username wpsadmin and the associated password for wpsadmin.

   3. Use the following parameters to create a JCR search collection.

      Table 3. JCR Search Collection configuration

      Parameter	Value
      Search collection name	JCRCollection1
      Search collection location	/opt/HCL/AppServer/profiles/prs_profile/SearchCollections/JCRCollection1

   4. JCR Content Source Configuration. Use the following URL for Collect documents linked from this URL:

      https://dockerhost:10042/wps/seedlist/myserver?Action=GetDocuments&Format=ATOM&Locale=en_US&Range=100&Source=com.ibm.lotus.search.plugins.seedlist.retriever.jcr.JCRRetrieverFactory&Start=0&SeedlistId=1@OOTB_CRAWLER1

      Note: The host and port are the Docker host and port to which 10042 is mapped. In this case, 10042 is the HttpQueueInboundDefaultSecure port on the HCL Digital Experience server. Note that you can also put this URL in a browser (on the Docker host) and confirm that the response is an ATOM feed.

      On the Security panel, use dockerhost as the host name, along with the username wpsadmin and the associated password for wpsadmin.

4. Configure WCM Authoring Portlet search function.
   Note: Even though the documents are gathered by the Remote Search function from the JCR, additional configuration is needed in order for the HCL Web Content Manager (WCM) Authoring Portlet search to use document search. Set the following values for this configuration.
   1. Set the Custom properties for the WebSphere Application Server Resource Environment Provider, JCR ConfigService, using the following values:

      Table 4. JCR ConfigService custom properties

      Property	Value
      jcr.textsearch.enabled	true
      jcr.textsearch.indexdirectory	/opt/HCL/AppServer/profiles/prs_profile/SearchCollections
      jcr.textsearch.PSE.type	ejb
      jcr.textsearch.EJB.IIOP.URL	iiop://dockerhost:2809
      jcr.textsearch.EJB.EJBName	ejb/com/ibm/hrl/portlets/WsPse/WebScannerLiteEJBHome

      Note: On the jcr.textsearch.indexdirectory, the sub-directory JCRCollection1 is NOT included in the path.