Configure Remote Search in OpenShift and Kubernetes

• As information, 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.
• Follow the guidance in this section to define collections in the core HCL DX 9.5 container environment with respect to JCR text search collections, rather than guidance published for the on-premises (non-Docker or Kubernetes) platforms for the JCR collection URL.

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.

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 the URL configuration host as defined in the table below (REMOTE SEARCH SERVICE NAME) as the host, and the appropriate port for the SSL access. You must also complete Setting the search user ID.
2. Complete Removing default search collections before creating a new search service.
3. Create a new search service and use the following values for a Remote Search services configuration to a Kubernetes container deployment. See the section on Creating a new search service for more information.

   For testing Search Services configuration, the following are used:

   Table 1. HCL DX 9.5 Kubernetes container Remote Search services configuration

   Item	Value
   IIOP_URL	iiop://[REMOTE SEARCH SERVICE NAME]: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.
4. Obtain a shell in the Digital Experience core container, by running the following command:

   kubectl/oc exec -it [DX CORE POD NAME] bash -n [NAMESPACE] -c core

5. Run the following ConfigEngine task.

   /opt/HCL/wp_profile/ConfigEngine/./ConfigEngine.sh configure-portal-for-remote-search -DWasPassword=[WAS ADMIN PASSWORD] -Dremote.search.host.name="[REMOTE SEARCH SERVICE NAME]" -Dremote.search.host.port="9043" -Dremote.search.cert.alias="remotesearchalias" -Dremote.search.iiop.url="iiop://[REMOTE SEARCH SERVICE NAME]:2809" -Dremote.search.index.directory="/opt/HCL/AppServer/profiles/prs_profile/SearchCollections

   Note: If the ConfigEngine task is successful, LTPA key will be exported to the local machine.
6. Move the exported LTPA key from the DX container to the RemoteSearch container on the local machine, using below command.

   kubectl/oc cp [DX POD NAME]:/home/dx_user/LTPAKeyExported ./LTPAKeyExported -c core -n [namespace/project]

   kubectl/oc cp LTPAKeyExported [REMOTE SEARCH POD NAME]:/home/dx_user/ -c remote-search -n [namespace/project]

7. Obtain a shell in the RemoteSearch Container, by running the following command:

   kubectl/oc exec -it [REMOTE SEARCH POD NAME] bash -n [NAMESPACE] -c remote-search

8. Run the following ConfigEngine task command:

   /opt/HCL/AppServer/profiles/prs_profile/ConfigEngine/./ConfigEngine.sh configure-remote-search-server-for-remote-search -DWasPassword=[WAS ADMIN PASSWORD] -Dportal.host.name="[DX SERVIC NAME]" -Dportal.port.number="10042" -Dportal.cert.alias="portaldockeralias" -Dremote.search.host.name="[REMOTE SEARCH POD NAME]"

9. Restart both DX and RS servers.
   • Restart DX server from a shell in the Digital Experience core container.

     /opt/HCL/wp_profile/bin/./stopServer.sh WebSphere_Portal -user [WAS ADMINISTRATOR NAME] -password [WAS ADMINISTRATOR PASSWORD]
     /opt/HCL/wp_profile/bin/./startServer.sh WebSphere_Portal

   • Restart RS serve from a shell in the RemoteSearch container.

     /opt/HCL/AppServer/profiles/prs_profile/bin/./stopServer.sh server1 -user [WAS ADMINISTRATOR NAME] -password [WAS ADMINISTRATOR PASSWORD]
     /opt/HCL/AppServer/profiles/prs_profile/bin/./startServer.sh server1

10. Based on the previously created Remote Search service, create your collections:
    • Portal Search Collection
      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

         Note: The “search collection name” can be any text string. The “search collection location” is relative to the remote search container. Furthermore, place the collection in the profile of the Remote Search server because the profile of the remote search server is persisted. To search the indexes persisted across restarts.
      2. Use the following parameters to create a Portal Search Content Source

         Table 3. Portal Search Content Source

         Parameter	Value
         Content Source Type	Portal Site
         Content Source Name	Portal Content Source
         Collect documents linked from this URL	https://[DX SERVICE NAME]:[DX SERVICE SECURE PORT]/wps/seedlist/myserver?Source=com.ibm.lotus.search.plugins.seedlist.retriever.portal.PortalRetrieverFactory&Action=GetDocuments&Range=100

         Note: The host and port are the Kubernetes service host and the port to which 10042 was mapped. In this case, 10042is the HttpQueueInboundDefaultSecure port on the HCL DX 9.5 Server. On the Security panel, use DX SERVICE NAME as the host name, along with the username wpsadmin and the associated password for wpsadmin. One can also specify Realm as CrawlerUsersRealm
      3. Use the following parameters to create a WCM Content Source.

         Table 4. WCM Content Source

         Parameter	Value
         Content Source Type	Seedlist provider
         Content Source Name	WCM Content Source
         Collect documents linked from this URL	https://[DX SERVICE NAME]:[DX SERVICE SECURE PORT /wps/seedlist/myserver?SeedlistId=&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments

    • JCR Search Collection
      1. Use the following parameters to create a Content Source JCR search collection.

         Table 5. JCR Search Collection configuration

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

      2. Use the following parameters to create a JCR Search Content Source.

         Table 6. JCR Search Content Source

         Parameter	Value
         Content Source Type	Seedlist provider
         Content Source Name	JCR Content Source
         Collect documents linked from this URL	https://[DX SERVICE NAME]:[DX SERVICE SECURE PORT /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

         The parsing of the SeedlistId positional parameter in this URL uses an index of the virtual portal being crawled. In this case 1 (in 2 places) represents the base virtual portal.

         Note: The host and port are the Kubernetes service host and the port to which 10042 was mapped. In this case, 10042 is the HttpQueueInboundDefaultSecure port on the HCL DX 9.5 server.

         On the Security panel, use DX SERVICE NAME as the host name, along with the username wpsadmin and the associated password for wpsadmin. You can also specify Realm as CrawlerUsersRealm.