In-scope Hosts/Servers
Jenkins Host: Where the Jenkins controller (providing build/deploy services as part of ALM) is run
Application Lifecycle Management Tools: One or more hosts running Work Item Management, and Git services
Developer's Workstation: Where the Windows DataStage Designer client is typically run
Information Server Development Environment: Your development instance of Information Server, which may be deployed in any topology, and on any number of hosts.
Other Information Server Environment(s): Downstream Information Server environments, including testing and (optionally) Production. These environments can be MettleCI deployment targets without requiring the deployment of any MettleCI components.
MettleCI Host: A MettleCI-dedicated Windows server hosting an IBM DataStage Client tier which is used by your Build system's agent, in conjunction with the MettleCI Command Line Interface, to automate build and deployment activities.
Connections
The following high-level MettleCI architecture shows the key software components to be installed, and their communications between hosts.
The above diagram is one possible configuration, and is presented as an example only.
The MettleCI Workbench application running on your DataStage Engine tier needs to perform a dynamic lookup of Work items when displaying the Git Commit page.
The MettleCI Workbench application running on your DataStage Engine tier needs to commit to your Git platform.
The Jenkins Host the Git repository need to communicate in order to configure Git commits to automatically trigger Jenkins pipelines. Jenkins then needs access to your Git repository to source the artefacts for build and deployment. The Jenkins pipeline definitions ('Jenkinsfiles') are themselves stored and managed in a Git repository.
The Developer Workstation provides data engineers with access to the Azure user interface via a supported web browser.
Your Azure Pipelines perform their duties via an agent installed on the MettleCI-dedicated DataStage Client.
The Developer Workstation provides a DataStage client tier with access to the development environment's DataStage Engine and Services tiers.
The Developer Workstation provides data engineers with access to the following components via a supported web browser:
OPTIONAL The MettleCI Scheduler (Azkaban) user interface
OPTIONAL The MettleCI Wallboard
The MettleCI Host requires regular access to the development environment's DataStage Engine and Services tiers, identical to that of Developer Workstations.
The MettleCI Host requires regular access to the downstream test environments' DataStage Engine and Services tiers, to affect automated deployment.
# | Summary | Description | Technical Notes |
|---|---|---|---|
1 | MettleCI Workbench Service (Engine Tier) ↔︎ Your Work item Management system | The MettleCI workbench is configured to perform a dynamic lookup of work items as part of the Git Commit process. Currently supported work item management systems are listed here. <where?> | The Workbench service on your DataStage Engine tier needs to be able to use your Work Item Management system’s query API, over whatever protocols/ports it requires. |
2 | MettleCI Workbench Service (Engine Tier) ↔︎ Your Git Repository | The MettleCI Workbench application running on your DataStage Engine tier needs to performs a commit to your Git platform | |
3 | Jenkins Host ↔︎ Your Git repository | ||
4 | Jenkins Host ↔︎ Developer Workstation DataStage designer client | Web access to Jenkins by developers. Similar web access should exist to the work item management and git repository | |
5 | Jenkins Host ↔︎ MettleCi Host DataStage designer client | Jenkins controller issues commands to the Jenkins Agent to perform MettleCI related tasks such as code movement, and DataStage deployment (project manipulation, job compilation) | |
6 | Developer Workstation ↔︎ IS/DS Service/Engine tiers | Normal developer activity such as editing jobs, test compilations, etc | |
7 | Mettle CI Host ↔︎ DataStage Development Environment engine and service tiers | The MettleCI Host requires regular access to the development environment's DataStage Engine tier for initiating compilations, project creation, job compilation and <?> and access to the Services Tier for authentication | |
8 | Developer Workstation DataStage designer client ↔︎ MettleCI Host | The (optional) plugins effect checkin, test case specification generation, and <?> via the Mettle CI host, further the developer can access the (optional) Azkaban scheduler and wallboard components via a supported web browser | |
9 | Mettle CI Host ↔︎ DataStage downstream (test, prod, etc) engine and service tiers | The MettleCI Host requires regular access to the downstream test environments' DataStage Engine and Services tiers, to effect automated deployment (and possibly execute unit tests) |