HCL Compass Software Configuration Management (SCM) integration supports changes in the
software for HCL VersionVault Express, GitLab, and GitHub.
Before you begin
Note: Using HCL Compass on Docker
and Docker Compose is not supported when deployed in a production environment. To use HCL
Compass in a container in a production environment, deploy HCL Compass to a Kubernetes
environment. For more information, see
Deploying HCL Compass on SoFy Sandbox.
In order to
support SCM integration, you must enable SSO and provide the SSO Configuration.
- You must be familiar with and follow the instructions in Getting started with Docker.
- You must be familiar with the SCM integration package.
Procedure
-
Apply the SCM Integration Package to the Application/Records by using HCL Compass
Designer.
-
Add the following settings to the hcl-compass docker run command, as described in Getting started with Docker.
- Enable SSO
- Add the SSO_CONFIG_SET environment variable and provide SSO configuration for
each database repository during deployment of the HCL Compass
Container.
--env SSO_ENABLED=TRUE \
--env SSO_CONFIG_SET=(\"SSO_CONFIG_1\"\"SSO_CONFIG_2\" ..... \"SSO_CONFIG_n\") \
- Each SSO configuration
SSO_CONFIG_x
must be set with the following
format:-username [Username] -password [User password] -dbset [dbset_name] -ssousername [sso_user_name]
- The following example illustrates the proper configuration for a two SSO configuration. In this
case, one is for DefectTracking-SAMPL and the other is for EssentialSAFe-SAMPL repository
applications:
--env SSO_CONFIG_SET="(\" -username admin -password \"\" -dbset DefectTracking -ssousername SSO_USER\" \"-username admin -password \"\" -dbset EssentialSAFe -ssousername SSO_USER\")"
Note: The
value for [sso_user_name]
should be an internal name provided by the administrator.
This name should be unique and should not be used for any other function in HCL Compass.
-
Enter https://localhost:8190/ in a browser to see the HCL Compass application running with
SCMIntegrationConfig, SCMIntegrationEvent, and SCMIntegrationSecurity components support.