Service tier

The IBM® UrbanCode Deploy server provides various services, such as: the user interface, component and application configuration tools, workflow engine, and security services among others.

The REST-based user interface provides the web-based front end that is used to create components and fashion workflows; request processes, and manage security and resources, among other things.

When a workflow is requested, many services are used to fulfill the request. These services are shown in the following illustration:

Figure 1. Services and process workflow

Workflow requests are initiated with the user interface, either the web-based application or the CLI (command-line interface).

Table 1. Services
Service Description
User Interface Used to create components and fashion workflows, request processes and manage security and resources, among other things. REST-based.
Workflow Engine Manages workflows: application and component processes. Calls the agent responsible for running the current plug-in step. Alerts the notification and inventory services when the workflow is finished. Called by the deployment service. REST-based.
Agent Tracks installed agents and routes plug-in commands to affected agents. Commands come from plug-in steps. Started by the workflow service. REST-based.
Work Item Operates in tandem with the approval service; provides approver alerts and enables approvers to accept or reject workflows. If a scheduled workflow remains unapproved at run time, the job fails automatically. REST-based.
Plug-in Manager

IBM UrbanCode Deploy can interact with virtually any system through its extensible plug-in system; plug-ins provide functions by breaking-down tool features into automated steps. Plug-ins can be configured at design time and run time. When a plug-in step runs, the controlling agent starts its runtime process to run the step.

When a new component version is available, the agent compares the current component version and downloads and only new or changed artifacts.

Event The event service is ubiquitous; it alerts other services as various trigger conditions occur.
Deployment Service Manages deployments. When a deployment process is requested, starts the workflow engine to run the process. Works in tandem with the security service to ensure that users have the required permissions. REST-based.
Notification Manager Notifies users about the status of deployments. Notifications are sent to approvers if the system is configured with an email server and the user has an email address. Started by the workflow manager. REST-based.
Inventory Manager When a workflow finishes, the inventory manager updates affected inventory records. IBM UrbanCode Deploy maintains an inventory of every deployed artifact in every environment, which provides complete visibility across environments. REST-type service.
Approval Engine Enables creation of approval-requiring jobs and approver roles. Works in tandem with the work item service to ensure that required approvals are made before scheduled jobs. REST-based.
Security Controls what users can do and see; maps to organizational structures by teams, roles, activities, and so on, REST-based.
Calendar Used to schedule processes to being at some future point; works in tandem with the approval and work item services. REST-based.
CodeStation Handles artifact versions; agents start it when they download component versions. REST-based.

Feedback