Document toolboxDocument toolbox

The MettleCI Workbench Configuration Files Explained

Owned by John McKeever
Last updated: Aug 10, 2023 by Larry Pieniazek (Unlicensed)
3 min read

Note that you should rarely, if ever, need to manually edit these configuration files as their contents are managed using the MettleCI Workbench user interface.

File config.yml

This is the primary MettleCI Workbench configuration file.

Section gitAuthentication

Specifies values required to connect to Git systems.

gitAuthentication: sshKey: "/opt/dm/mci/workbench.key" sshPassphrase: "MyPassPhrase" httpsEnabled: true commitSigningEnabled: true httpsProvider: "SunJSSE" secretsStore: type: "PKCS12" path: "/opt/dm/mci/.secrets/git-credentials.p12" password: ${file:UTF-8:/opt/dm/mci/.secrets/git-credentials-keystore-password}

Note that in earlier versions of MettleCI Workbench which did not support Git commit signing, the secretsStore section above used the name httpsCredentialsStore which will continue to be accepted as an alias. This supports users upgrading their MettleCI Workbench installations without needing to alter their config.yml file.

Section datastage

Tells MettleCI workbench about your DataStage installation.

datastage: installDir: "/opt/IBM/InformationServer/Server/DSEngine" domain: "demo115-svcs.dm-demo-datastage.datamigrators.io:59445" server: "demo115-engn.dm-demo-datastage.datamigrators.io" username: "isadmin" password: "{iisenc}W3ZIJYGenK408WMCS36N69SIFaSI9o1ikzRO4SJgjBU="

Section server

Specifies properties of the Workbench service running on your DataStage Engine tier.

server: applicationConnectors: - type: https port: 8443 keyStoreType: PKCS12 keyStorePath: /opt/dm/mci/mettleci-trust.p12 keyStorePassword: changeit trustStoreType: PKCS12 trustStorePath: /opt/dm/mci/mettleci-trust.p12 trustStorePassword: changeit

Section logging

The MettleCI Workbench service can log diagnostic information. This section specifies what information to log, and how the MettleCI service should log it.

Other entries in config.yml

Various other entries are present which, in general, should be left unmodified unless you are asked to alter them by your Data Migrators support team.

File datastage-users.yaml

This MettleCI Workbench configuration file stores use-specific information.

File issuesmanagement-settings.yaml

This stores connection details for your registered Work Item Management systems. Each registered work item management system with have a separate entry, starting with the default ‘GENERIC’ system (which performs no remote work item lookup) with yaml key id: 0.

File project-settings.yaml

This stores details of each of the DataStage Projects registered with MettleCI Workbench. The general structure is as follows:

The id is a unique integer starting at 0. The issueManagementId is a reference to the id of the issue management system defined in issuesmanagement-settings.yaml and which this project should use to perform work item lookuop.

Bamboo Example

Azure Example

GitHub Example

GitLab Example

© 2015-2024 Data Migrators Pty Ltd.