Updating the HCL Compass Helm chart to create new database connections
You can update the HCL Compass Helm Chart default values that are set in the hcl-compass/values.yaml file to be based on your environment. For example, you can enable or disable a database or search functionality by setting new values during the helm install or helm upgrade.
Before you begin
- In the Compass Maintenance Tool,
ensure that the database host name can be resolved from Docker and that it matches what
you put in the -s parameter for
hcl-compass.db.connectionSet
. - In Compass Designer, ensure that the address of the user database can also be resolved from the Docker container in the hcl-compass pod.
About this task
service.enabled.oracle
to false
and set your external database settings. This guide shows you how to update the Helm Chart to
create new database connections and update database connections.Procedure
Update a database connection.
- Set the database connection in the db.connectionSet. For
example:
db.connectionSet=<("connection-1" "connection-2" ..... "connection-n")>
You can set as many connections as you need in theDB_CONNECTION_SET
. Each connection must be set with the following format:-v <db_vendor> -d <db_name> -s <db_server> -u <user> -p <password> -dbset <dbset_name> -co <connect_options>
Note: TheThe following databases are supported, and usage examples are as follows:-co <connect_options>
is optional for Oracle database and will be needed when you define the connection options specific to your environment for Oracle database.- Oracle
-
-v Oracle -s oracle_host -d orcle -u admin -p admin_pwd -dbset DefectTracking1
- SQL Server
-
-v SQL_Server -s sql_host -d sqldb1 -u admin -p pwd -dbset DefectTracking2
- DB2
-
-v DB2 -s db2_host-d msiteb -u db2 -p pwd -dbset DefectTracking3
- Disable the internal Oracle database by settings
service.enabled.oracle
to false:service.enabled.oracle=false
- If you update the database connection setting, you must also update the same database
connection setting in the Search setting under the
searchapp#.db.connectionSet
key.The following example illustrates when two database connections exist. In this case, one is for DefectTracking and the other is for EssentialSAFe schemas, both are using the --set flag:--set db.connectionSet: ("-v Oracle -d xe -s oracle_host -u DefMaster -p c0mpass -dbset DefectTracking" "-v Oracle -d xe -s oracle_host -u SafeMaster -p c0mpass -dbset EssentialSAFe") --set service.enabled.oracle=false
## Database settings db: connectionSet: ("-v Oracle -d xe -s oracle_host -u DefMaster -p c0mpass -dbset DefectTracking" "-v Oracle -d xe -s oracle_host -u SafeMaster -p c0mpass -dbset EssentialSAFe") ## Disable the internal oracle database service service: enabled: oracle: false