SmartSearch is a micronaut application, when integrated with OpenSearch, offers a powerful, flexible, and feature-rich search experience that can be tailored to specific business and user needs. Using OpenSearch as the underlying engine, SmartSearch can handle large volumes of data, perform real-time indexing, and support complex querying to enhance search relevancy. Features such as autocomplete, fuzzy matching, synonym recognition, and intelligent ranking make it easier for users to locate precise information, even if search terms are partially matched or misspelled.

This section describes how to create a SmartSearch service instance in your cloud native environment using the operational scripts and the configuration provided in the Common cloud native toolkit (Common CNTK).

Before you create a SmartSearch instance, you must validate cloud native environment. See "Planning UIM Installation" for details on prerequisites.

In this section, while creating a basic instance, the project name is considered as sr and instance name is considered as quick.

The SmartSearch service relies on access to certain environment variables to run seamlessly. Ensure the following variables are set in your environment:

• Path to your common cloud native toolkit
• Traefik namespace (Optional)

To set the environment variables:

1. Set the COMMON_CNTK variable to the path of directory where common cloud native toolkit is extracted as follows:

   $ export COMMON_CNTK=$WORKSPACEDIR/common-cntk

2. In case Traefik is used as ingress, set the TRAEFIK_NS variable for Traefik namespace as follows:

   $ export TRAEFIK_NS=Treafik Namespace

3. Set the variable for Traefik Helm chart version. For the corresponding version, see UIM Compatibility Matrix. The following is a sample for Traefik chart version 15.1.0.

   $ export TRAEFIK_CHART_VERSION=15.1.0 

4. Set SPEC_PATH variable to the location where application and database yamls are copied. See "Assembling the Specifications" to copy specification files if not already copied.

   $ export SPEC_PATH=$WORKSPACEDIR/spec_dir

After you set the environment variables, register the namespace if Traefik is used as Ingress Controller.

To register the namespace, run the following command:

$COMMON_CNTK/scripts/register-namespace.sh -p sr -t targets
# For example, $COMMON_CNTK/scripts/register-namespace.sh -p sr -t traefik
# Where the targets are separated by a comma without extra spaces

To create secrets:

1. Run the following command to generate the openSearchCredentials secret and enter the basic auth credentials of OpenSearch as prompted:

   $COMMON_CNTK/scripts/manage-app-credentials.sh -p sr -i quick -a smartsearch -f $SPEC_PATH/samples/applications.yaml create openSearchCredentials  
    
    #Enter the values appropriately against  prompts:
    opensearch username: admin   #opensearch basic oauth credentials
    opensearch password: xxxxx   

2. Verify if the secrets are created as follows:

   sr-quick-open-search-credentials

In $SPEC_PATH/sr/quick/applications.yml, the SmartSearch image and tag are configured to specify the container image used for the SmartSearch service. The image tag can be updated as new version of the image are released, allowing easy upgrades and ensuring the application runs the latest features and security patches. To apply a new image version, simply change the tag in applications.yml to the desired version, facilitating version control and deployment management.

To configure the applications.yaml file:

1. Download the Oracle Communications Unified Inventory Management SmartSearch image from Oracle Software Delivery Cloud.
2. Load the image from tar file and push the image to container repository. Refer "About Container Image Management" in UIM Cloud Native Deploy Guide.

   podman load -I <smart-search-latest.tar>
   podman tag smart-search:latest <conatiner repository>/smart-search:latest
   podman push <conatiner repository>/smart-search:latest
   

3. Update the corresponding values under the smartsearch section in $SPEC_PATH/<PROJECT>/<INSTANCE>/applications.yaml.
4. Edit the applications.yaml file and enter the name and tag of the SmartSearch image from your repository as follows:

   smartSearch:
     image:
       name: <conatiner repository>/smart-search
       tag: 0.3.11

5. You can provide an image pull secret as follows to pull images from your private repository:

   # The image pull access credentials for Private repository, as a Kubernetes secret.
   # uncomment and set if required.
    
   #  imagePullSecret:
   #    imagePullSecrets:
   #      - name: regcred

6. Set pullPolicy for SmartSearch images in applications.yaml as follows:

   smartSearch:
     #Provide imagePullPolicy i.e Always, IfNotPresent, Never
     imagePullPolicy: IfNotPresent

7. Update loadbalancerport in applications.yaml as follows:

   # For Generic and Traefik Ingress Controllers:
   # If ssl is enabled this would be loadbalancer's ssl port.
   # IF ssl is disabled this would be loadblancer's non ssl port.
   # For examle ssl and non-ssl ports for external loadbalancer would be 443 and 80 respectively.
   # If loadbalancer is not created, provide nodePort of Nginx/Traefik or any other Generic Ingress Controller
    
   loadBalancerPort: 30505

8. For Generic ingress controller update as follows:
   • Update applications.yaml as follows to provide the following annotations to enable stickiness through cookies:

     # Valid values are TRAEFIK, GENERIC
     ingressController: "GENERIC"

   • Annotations for NGINX is as follows:

     ingress:
       className: nginx  ##provide ingressClassName value, default value for nginx ingressController is nginx.
       # This annotation is required for nginx ingress controller.
       annotations:
         nginx.ingress.kubernetes.io/affinity: "cookie"
         nginx.ingress.kubernetes.io/affinity-mode: "persistent"
         nginx.ingress.kubernetes.io/session-cookie-name: "nginxingresscookie"
         nginx.ingress.kubernetes.io/proxy-body-size: "50m"
         
     smartSearch:
        #uncomment and provide applications specific annotations if required, these will get added to list of annotations specified in common section.
        ingress:
          annotations:
            nginx.ingress.kubernetes.io/rewrite-target: /$2

9. Set the authentication.enabled flag to true to enable authentication as follows:

   # The enabled flag is to enable or disable authentication
   authentication:
     enabled: true

To create an SmartSearch service instance in your environment using the scripts that are provided with the toolkit:

1. Run the following command to create an SmartSearch service instance:

   $COMMON_CNTK/scripts/create-applications.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a smartsearch

   The create-applications script uses the Helm chart located in $COMMON_CNTK/charts/smartsearch-app to create and deploy a SmartSearch service.

2. (Optional) If the scripts fail, run the following command to review the error message in the log:

   kubectl logs -n sr sr-quick-smartsearch

3. Clear the failed pod by running the following command:

   helm uninstall sr-quick-smartsearch-n sr

4. Fix the issues if any and run the script again to deploy the SmartSearch service.

Upgrading SmartSearch is required when there are updates made to applications.yaml or other configuration files.

To upgrade the SmartSearch instance:

1. Run the following command to upgrade the SmartSearch service:

   $COMMON_CNTK/scripts/upgrade-applications.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a smartsearch
   

2. After script is run, validate the SmartSearch service by running the application-status script.

To restart the SmartSearch instance:

1. Run the following command to restart the SmartSearch service:

   $COMMON_CNTK/scripts/restart-applications.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a smartsearch

2. After running the script, validate the SmartSearch service by running the application-status script.

To delete the SmartSearch instance, run the following command to delete the SmartSearch service instance:

$COMMON_CNTK/scripts/delete-applications.sh -p <project-name> -i <instance-name> $SPEC_PATH/sr/quick/applications.yaml -a smartsearch

You can configure SmartSearch using the following alternate options.

#Value can be changed as "-" to match wild-card pattern of ssl certificates.
#Example hostnames for "-" quick-sr-topology.uim.org
subDomainNameSeparator: "-"