HCL Compass Helm chart reference

Information about using the HCL Compass Helm chart.

The following reference details the HCL Compass Helm chart and the configuration options that are available for deploying HCL Compass version 2.0.2 on Kubernetes.

It is recommended that you do not modify the default values.yaml configuration file for your deployment. Create a copy to use as your customized values file, for example, my-values.yaml. Creating a copy to customize will allow you to maintain your customized values for future deployments and upgrades.

Table 1. HCL Compass Helm Chart
Parameter Description Default value
global.hclImagePullSecre Your own secret with your credentials to the HCL docker repository.

Required when deploying a solution in your own cluster.

 ""
global.hclImageRegistry HCL Compass docker image registry. hclproducts-sofy-docker.jfrog.io
hclFlexnetURL Your HCL FlexNet license server URL for your HCL entitlements. ""
hclFlexnetID Your HCL FlexNet license ID for your HCL entitlements.

""
replicaCount Number of replicas to deploy an instance of the HCL Compass RESTful service. 1
image.repository HCL Compass docker image repository path. services/hcl-compass/hcl-compass
image.tag HCL Compass image tag. 2.0.2
image.pullPolicy HCL Compass image pull policy. Accepted values are:
  • IfNotPresent
  • Always
 IfNotPresent
hostname HCL Compass Docker container hostname. hcl-compass
service.enabled.oracle This parameter enables or disables the HCL Compass Oracle database service. Accepted values are:
  • True: enables the HCL Compass Oracle database service.
  • False: disables the HCL Compass Oracle database service.
 true
compassOracleDb.repository HCL Compass Oracle database Docker image repository path.

This parameter is needed if service.enabled.oracle=true.

 services/hcl-compass/hcl-compass-db
compassOracleDb.tag HCL Compass Oracle database image tag.

This parameter is needed if service.enabled.oracle=true.

 18.4.1-xe
compassOracleDb.pullPolicy HCL Compass Oracle database image pull policy.

This parameter is needed if service.enabled.oracle=true.

Accepted values are:
  • IfNotPresent
  • Always
 IfNotPresent
db.connectionSet Register array of database set connections with the following format:

("connection-1" "connection-2"..."connection-n")

Each connection must be set with the following format:

(”-v db_vendor -d db_name -s db_server -u user -ppassword -dbset dbset_name -ip db_server_ip”)

If the database hostname can be resolved from Docker and it matches what you put into the *-s* parameter, then the *-ip db_server_ip* is not required.

If search.withCompass=true, then you also need to include the -searchPort search-port.

 ("-v Oracle -d xe -s oracle_host -u DEFMaster -p c0mpass -dbset DefectTracking -ip hcl-compass-oracle" "-v Oracle -d xe -s oracle_host -u SafeMaster -p c0mpass -dbset EssentialSAFe -ip hcl-compass-oracle")
service.enabled.search This parameter enables or disables the HCL Compass search service. Accepted values are:
  • true: enables the HCL Compass search service.
  • false: disables the HCL Compass search service.
 true
search.withCompass This parameter enables or disables the search configuration into the HCL Compass RESTful pod's container. Accepted values are:
  • true: enables the HCL Compass search configuration in the HCL Compass RESTful pods.
  • false: disables the HCL Compass search configuration in the HCL Compass RESTful pods.

This parameter is required if you plan to configure search in the same pod service and service.enabled.search=true.

 false
search.configSet Set array of Search configuration data with the following format for the Search Application_1 configuration:

(SEARCH_CONFIG_1" " SEARCH_CONFIG_2" .... " SEARCH_CONFIG_n")

Each Search configuration must be set with the following format:
“-username [Username] -password [User password] -dbset [dbset_name]-userdb [User database] 
-searchPort [search_port_number]”

This parameter is required if service.enabled.search=true and search.withCompass=true.

 ("-username admin -password "" -dbset DefectTracking -userdb SAMPL -searchPort 8983" "-username admin -password "" -dbset EssentialSAFe -userdb SAMPL -searchPort 8984")
search.properties.update This parameter enables or disables updating the default Search properties values. Accepted values are:
  • true: enables updating the default Search properties values.
  • false: disables updating the default Search properties values.

This parameter is required and set to true if service.enabled.search=true and search.withCompass=true and you need to update any Search properties values.

 false
search.properties.valueSet The Search Properties values with the following format:
(\"-IndexWorkspace [true/false] -MaxHeapSize [val] -RetryAttempts [val] -RetryAttemptsPause [val] -IncrIndexMaxHeapSize [val] -FullIndexMaxHeapSize [val] -ProcRetryAttempts [val] -ProcRetryAttemptsPause [val]\")
 (\"-IndexWorkspace false -MaxHeapSize 4096 -RetryAttempts 3 -RetryAttemptsPause 1000 -IncrIndexMaxHeapSize 4096 -FullIndexMaxHeapSize 4096 -ProcRetryAttempts 30 -ProcRetryAttemptsPause 2000\")
search.entityFile.enabled This parameter enables or disables adding new search data entity files to the pods for search configuration. Accepted values are:
  • true: enables adding new search data entity files to the pods.
  • false: disables adding new search data entity files to the pods.
false
search.entityFile.configMapName The configMap file name that containes the search data entity files. This parameter is required if service.enabled.search=true and search.entityFile.enabled=true. entity-file
search.port.port#.containerPort This parameter sets the search port in the Docker container. The # should be replaced with 1 to N.

It can be from port1 to port N and is set for that search port for search configuration 1 to search configuration N.

This parameter is required if service.enabled.search=true and search.withCompass=true.

 -
search.port.port#.protocol The protocol type TCP. The # should be replaced with 1 to N.

It can be from port1 to port N and is set for that search port for search configuration 1 to search configuration N.

This parameter is required if service.enabled.search=true and search.withCompass=true.

 TCP
searchapp1.service This parameter enables or disables the HCL Compass search Application1 service. Accepted values are:
  • true: enables the HCL Compass search Application1 service.
  • false: disables the HCL Compass search Application1 service.

This parameter is required if you plan to configure search in a separate pod service and if service.enabled.search=true.

 true
searchapp1.replicaCount Number of replica search pods. This parameter is required if searchapp1.service=true. 1
searchapp1.hostname Search container hostname. This parameter is required if searchapp1.service=true. search-def
searchapp1.configset Set array of Search configuration data with the following format for the Search Application_1 configuration:

(SEARCH_CONFIG_1" " SEARCH_CONFIG_2" .... " SEARCH_CONFIG_n")

Each Search configuration must be set with the following format:
“-username [Username] -password [User password] -dbset [dbset_name]-userdb [User database] 
-searchPort [search_port_number]”

This parameter is required if searchapp1.service=true.

 ("-username admin -password "" -dbset DefectTracking -userdb SAMPL -searchPort 8983" "-username admin -password "" -dbset EssentialSAFe -userdb SAMPL -searchPort 8984")
searchapp1.port Search container port number. This parameter is required if searchapp1.service=true. 8983
searchapp1.db.connectionSet The conncetionSet values must be the same as the values that are set for the database connection-1 that is set in the db.connectionSet.

This parameter is required if searchapp1.service=true.

 ("-v Oracle -d xe -s oracle_host -u DEFMaster -p c0mpass -dbset DefectTracking -ip hcl-compass-oracle" "-v Oracle -d xe -s oracle_host -u SafeMaster -p c0mpass -dbset EssentialSAFe -ip hcl-compass-oracle")
searchapp1.properties.update This parameter enables or disables updating the default Search properties values. Accepted values are:
  • true: enables updating the default Search properties values.
  • false: disables updating the default Search properties values.

This parameter is required and set to true if service.enabled.search=true and search.withCompass=true and you need to udpate any Search properties values.

 false
searchapp1.properties.valueSet The Search Properties values with the following format:
(\"-IndexWorkspace [true/false] -MaxHeapSize [val] -RetryAttempts [val] -RetryAttemptsPause [val] -IncrIndexMaxHeapSize [val] -FullIndexMaxHeapSize [val] -ProcRetryAttempts [val] -ProcRetryAttemptsPause [val]\")
 (\"-IndexWorkspace false -MaxHeapSize 4096 -RetryAttempts 3 -RetryAttemptsPause 1000 -IncrIndexMaxHeapSize 4096 -FullIndexMaxHeapSize 4096 -ProcRetryAttempts 30 -ProcRetryAttemptsPause 2000\")
Searchapp2.service This parameter enables or disables the HCL Compass search Application2 services. Accepted values are:
  • true: enables the HCL Compass search Application2 service.
  • false: disables the HCL Compass search Application2 service.

This parameter is required if you plan to configure search in a separate pod service and if service.enabled.search=true.

 false
Searchapp2.replicaCount Number of replica search pods.

This parameter is required if searchapp2.service=true.

 1
Searchapp2.hostname Search container hostname.

This parameter is required if searchapp2.service=true.

 search-EssentialSAFe
searchapp2.configset Set array of Search configuration data with the following format for the Search Application_2 configuration:

(SEARCH_CONFIG_1" " SEARCH_CONFIG_2" .... " SEARCH_CONFIG_n")

Each Search configuration must be set with the following format:
“-username [Username] -password [User password] -dbset [dbset_name]-userdb [User database] 
-searchPort [search_port_number]”

This parameter is required if searchapp2.service=true.

 ("-username admin -password "" -dbset EssentialSAFe -userdb SAMPL -searchPort 8984")
Searchapp2.port Search container port number.

This parameter is required if searchapp2.service=true.

 8984
Searchapp2.db.connectionSet The conncetionSet values must be the same as the values that are set for the database connection-1 that is set in the db.connectionSet.

This parameter is required if searchapp2.service=true.

 ("-v Oracle -d xe -s oracle_host -u SafeMaster -p c0mpass -dbset EssentialSAFe -ip hcl-compass-oracle")
searchapp2.properties.update This parameter enables or disables updating the default Search properties values. Accepted values are:
  • true: enables updating the default Search properties values.
  • false: disables updating the default Search properties values.

This parameter is required and set to true if service.enabled.search=true and search.withCompass=true and you need to udpate any Search properties values.

 false
searchapp2.properties.valueSet The Search Properties values with the following format:
(\"-IndexWorkspace [true/false] -MaxHeapSize [val] -RetryAttempts [val] -RetryAttemptsPause [val] -IncrIndexMaxHeapSize [val] -FullIndexMaxHeapSize [val] -ProcRetryAttempts [val] -ProcRetryAttemptsPause [val]\")
 (\"-IndexWorkspace false -MaxHeapSize 4096 -RetryAttempts 3 -RetryAttemptsPause 1000 -IncrIndexMaxHeapSize 4096 -FullIndexMaxHeapSize 4096 -ProcRetryAttempts 30 -ProcRetryAttemptsPause 2000\")
ssl.enabled Enables installing HCL Compass SSL certificate. Accepted values are:
  • true: enables installing SSL certificate.
  • false: disables installing SSL certificate.
 false
ssl.password Keystore password. This parameter is required if ssl.enabled=true. ""
ssl.keyAlias Keystore alias. 1
ssl.configMapName This is the configMap file name that contains the SSL certificate keystore.p12 file. This parameter is required if ssl.enabled=true. keystore-file
persistence.enabled If enabled, a persistence volume claim is enabled for HCL Compass. Accepted values are:
  • true: enables the persistence volume for the HCL Compass log file.
  • false: disables the persistence volume for the HCL Compass log file.

This parameter is required if you plan to enable or disable the persistence volume for the HCL Compass log file.

 true
persistence.existingClaim If a volume claim alread exists, this can be used for the server. This parameter is required if persistence.enabled=true. ""
persistence.storageClass If defined, the storageClassName is set. This parameter is reqiured if persistence.enabled=true. -
persistence.size.type The size of the storage requested by the persistence volume claim. This parameter is required if persistence.enabled=true. 4Gi
persistence.volume.enabled Enables persistence colume for the local Persistence Volume. Accepted values are:
  • true: enables the local persistence volume for the HCL Compass log file.
  • false: disables the local persistence volume for the HCL Compass log file.

This parameter is required if you plan to enable or disable the local persistence volume type for the HCL Compass log file and if persistence.enabled=true.

 false
persistence.volume.type Persistence Volume type. This parameter is required if persistence.enabled=true and persistence.volume.enabled=true. local
persistence.volume.size Persistence Volume size. This parameter is required if persistence.enabled=true and persistence.volume.enabled=true. 10Gi
persistence.volume.path Persistence Volume local path. This parameter is required if persistence.enabled=true and persistence.volume.enabled=true. /var/lib/data