Using HCL Compass RESTful service and search features in separate Kubernetes services
This quick start guide shows you how to use Kubernetes to setup and run an HCL Compass with RESTful and search features in separate Kubernetes services.
Before you begin
Procedure
-
Create a new .yaml file named named
compass_with_search_in_separate_pod.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 of the new entity files.
- Enable the Search application 1 service and set the search port number.
######################## 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 false if the HCL Compass search feature is in separate pod. ## 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. ########################################################### ## Enabled Search feature configuration. search: withCompass: false entityFile: enabled: false configMapName: entity-file ########### Enabled the search app1 service ############## ## searchapp1.service: Set true to enable the search application 1 service. ## searchapp1.replicaCount: Number of replica search Pods. ## searchapp1.hostname Search container hostname ## searchapp1.configSet: Set the configuration parameters that are needed for the Search configuration. ## searchapp1.port: Search container port number ## searchapp1.db.connectionSet: The connectionSet values must be the same as the values that are set for the database connection-1 that is set in the hcl-compass.db.connectionSet. ########################################################### ## Enabled the search app1 service searchapp1: service: true replicaCount: 1 hostname: search-def configSet: ("-username <Username> -password <User password> -dbset <dbset_name> -userdb <User database> -searchPort <Search_port_number>") port: 8983 db: connectionSet: ("-v <db_vendor> -d <db_name> -s <db_server> -u <user> -p <password> -dbset <dbset_name>") ########### Disabled the search app2 service ############# ## searchapp2.service: Set false to disable the internal oracle 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
-
Follow step 2 inUsing HCL Compass RESTful service in
Kubernetes without search features to install or upgrade the help chart by adding
-f compass_with_search_in_separate_pod.yaml
to the helm_install or helm_upgrade command.. -
If you plan to install SSL certificates, you can also add
-f ssl.yaml
to the helm_install or helm_upgrade command.