Using HCL Compass RESTful service and search features in the same Kubernetes service

This quick start guide shows you how to use Kubernetes to setup and run an HCL Compass with RESTful and search features in the same Kubernetes service.

1. Create a new .yaml file named named compass_with_search.yaml. Set values for the following:
   • The Secret name that you created in Deploying HCL Compass on Google Kubernetes Engine.
   • The FlexNet License URL and License ID.
   • The database connection-1 parameters in the db.connectionSet. If you need to add more than one database connection setting, use the ("connection-1" "connection-3" ..... "connection-n") format to add connection 2 through connection N.
   • Enable the search feature configuration by setting the username and password for the user database, the user database name and search port number.
   • If you have new search entity files, you can enable the search entity and provide the configMap name for the new entity files.

   ######################## The secret name ####################
   ## global.hclImagePullSecret:            Your own secret-name with your credentials to HCL's docker repository.
   #############################################################
   global:
     hclImagePullSecret: <secret-name>
   
   ################ HCL FlexNet license setting ################
   ## hclFlexnetURL:                       Your HCL FlexNet license server URL.
   ## hclFlexnetID:                        Your HCL FlexNet license ID.
   #############################################################
   hclFlexnetURL: <license_url>
   hclFlexnetID: <license_id> 
   
   hcl-compass:
     ############# Database connection settings ###############
     ## This example shows one database connection for connection-1.
     ## For additional connection setting use must follow this format: 
     ##    ("connection-1" "connection-2" ..... "connection-n")
     ##########################################################
     db:
       connectionSet: ("-v <db_vendor> -d <db_name> -s <db_server> -u <user> -p <password> -dbset <dbset_name>")
   
     ########## Enabled Search feature configuration ##########
     ## search.withCompass:                Set true when the HCL Compass search feature is configure in HCL Compass RESTful pod's container.
     ## search.configSet:                  Set the configuration parameters that are needed for the Search configuration.
     ## search.ports.port1.containerPort:  The search port in the docker container.
     ## search.ports.port1.protocol:       The protocol type TCP.
     ## search.entityFile.enabled:         Set true if you have new Search entity data files.
     ## search.entityFile.configMapName:   The configMap file name for the Search entity data files.
     ## search.properties.update:          Enable or disable updating the default Search properties values.
     ## search.properties.valueSet:        Set updated Search properties values.
     ###########################################################
     search:
       withCompass: true
       configSet: ("-username <Username> -password <User password> -dbset <dbset_name> -userdb <User database> -searchPort <Search_port_number>")
       ports:
         port1:
           containerPort: 8983
           protocol: TCP
       entityFile:
         enabled: false
         configMapName: entity-file
       properties:
         update: false
         valueSet: (\"-IndexWorkspace [true/false] -MaxHeapSize [val] -RetryAttempts [val] -RetryAttemptsPause [val] -IncrIndexMaxHeapSize [val] -FullIndexMaxHeapSize [val] -ProcRetryAttempts [val] -ProcRetryAttemptsPause [val]\")
     ########### Disabled the search app1 service  ############
     ## searchapp1.service:                  Set false to disable the search application 1 service.
     ###########################################################
     searchapp1:
       service: false
   
     ########### Disabled the search app2 service  ############
     ## searchapp2.service:                  Set false to disable the search application 2 service.
     ###########################################################
     searchapp2:
       service: false
   
     #### Enabled search service and disabled oracle Service ###
     ## service.enabled.oracle               Set false to disable the internal oracle service and create and connection to you own database.
     ## service.enabled.search               Set true to enable search service.
     ###########################################################
     service:
       enabled:
         oracle: false
         search: true
   

2. Follow step 2 in Using HCL Compass RESTful service in Kubernetes without search features to install or upgrade the helm chart by adding -f compass_with_search.yaml to the helm_install or helm_upgrade command.
3. If you plan to install SSL certificates, you can also add -f ssl.yaml to the helm_install or helm_upgrade command.