Links may not function; however, this content may be relevant to outdated versions of the product.
Adding a pipeline on-premises
When you add a pipeline on premises, you define all the stages and tasks that you want to do on each system. For example, if you are using branches, you can start a build when a branch is merged. If you are using a QA system, you can run test tasks to validate application data.
To add a pipeline on premises, complete the following steps:
In the Designer Studio footer, click Deployment Manager.
Click Add pipeline.
Specify the details of the application for which you are creating the pipeline.
In the Development environment field, enter the URL of the development system. This is the system on which the product rule that defines the application package that moves through the repository is located.
In the Application field, press the Down arrow key and select the name of the application.
In the Version field, press the Down arrow key and select the application version.
In the Access group field, press the Down arrow key and select the access group for which pipeline tasks are run.
This access group must be present on all the candidate systems and have at least the sysadmin4 role.
In the Pipeline name field, enter a unique name for the pipeline.
In the Product rule field, enter the name of the product rule that defines the contents of the application.
In the Version field, enter the product rule version.
To configure dependent applications, click Dependencies.
In the Application name field, press the Down arrow key and select the application name.
In the Application version field, press the Down arrow key and select the application version.
In the Repository name field, press the Down arrow key and select the repository that contains the production-ready artifact of the dependent application.
If you want the latest artifact of the dependent application to be automatically populated, ensure that the repository that contains the production-ready artifact of the dependent application is configured to support file updates.
In the Artifact name field, press the Down arrow key and select the artifact.
For more information about dependent applications, see Product rules: Listing product dependencies for Pega-supplied applications.
In the Environment details section, in the Stages section, specify the URL of each candidate system and the authentication profile that each system uses to communicate with the orchestration system.
In the Environments field for the system, press the Down arrow key and select the URL of the system.
If you are using your own authentication profiles, in the Authentication field for the system, press the Down arrow key and select the authentication profile that you want to communicate from the orchestration server to the system.
By default, the fields are populated with the DMAppAdmin authentication profile.
In the Artifact management section, specify the development and production repositories through which the product rule that contains application contents moves through the pipeline.
In the Development repository field, press the Down arrow key and select the development repository.
In the Production repository field, press the Down arrow key and select the production repository.
In the External orchestration server section, if you are using a Jenkins step in a pipeline, specify the Jenkins details.
In the URL field, enter the URL of the Jenkins server.
In the Authentication profile field, press the Down arrow key and select the authentication profile on the orchestration server that specifies the Jenkins credentials to use for Jenkins jobs.
If you are using branches in your application, in the Merge policy section, specify merge options. Do one of the following actions:
- To merge branches into the highest existing ruleset in the application, click Highest existing ruleset.
- To merge branches into a new ruleset, click New ruleset.
In the Password field, enter the password that locks the rulesets on the development system.
Result: The system adds tasks, which you cannot delete, to the pipeline that are required to successfully run a workflow, for example, Deploy and Generate Artifact. The system also adds other tasks to enforce best practices such as Check guardrail compliance and Verify security checklist.
To specify that a branch must meet a compliance score before it can be merged:
In the Merge criteria pane, click Add task.
From the Task list, select Check guardrail compliance.
In the Weighted compliance score field, enter the minimum required compliance score.
For more information about compliance scores, see Compliance score logic
To specify that a branch must be reviewed before it can be merged:
In the Merge criteria pane, click Add task.
From the Task list, select Check review status.
For more information about branch reviews, see Branch reviews.
To start a deployment automatically when a branch is merged, click the Trigger deployment on merge check box. Do not select this check box if you want to manually start deployments.
For more information, see Manually starting a deployment.
Clear a check box for a deployment life cycle stage to skip it.
In the Continuous Deployment section, specify the tasks to be performed during each stage of the pipeline. See the following topics for more information:
- Running Pega unit tests by adding the Run Pega unit tests task
If you use Pega unit tests to validate application data, add the Pega unit testing task on the pipeline stage where you want to run it. For example, you can run Pega unit tests on a QA system.
- Running Jenkins steps by adding the Run Jenkins step task
If you are using Jenkins to perform tasks in your pipeline, you can add the Run Jenkins step to the stage on which you want it to run. If you have configured the Jenkins OrchestratorURL and PipelineID parameters, when this task fails, the pipeline stops running. For more information about configuring these parameters, see .
- Continuing or stopping a deployment by adding the Perform manual step task
Use manual steps so that users must take an action before a pipeline deployment can continue. Users can either accept the task to continue the deployment or reject the task to stop it.
- Specifying that an application meet a compliance score by adding the Check guardrail compliance score task
You can use the Check guardrail compliance score task so that an application must meet a compliance score for the deployment to continue. The default value is 97, which you can modify.
- Ensuring that the Application Security Checklist is completed by adding the Verify security checklist task
For your pipeline to comply with security best practices, you can add a task to ensure that all the steps in the Application Security Checklist are performed. For customers on Pega Platform 8.4 and above, a new Security Checklist API is available to provide an automated security configuration assessment. Both candidate and orchestrator environments should be on or above Deployment Manager 4.8 to utilize this functionality.
- Modifying the Approve for production task
The Approve for production task is added to the stage before production. Use this task if you want a user to approve application changes before those changes are send to production.
Previous topic Adding a pipeline on Pega Cloud Services Next topic Adding the Pega unit testing task