Configuring and running pipelines with Deployment Manager 4.8.x
Use Deployment Manager to create continuous integration and delivery (CI/CD) pipelines, which automate tasks so that you can quickly deploy high-quality software to production.
On the orchestration server, release managers use the Deployment Manager landing page to configure CI/CD pipelines for their Pega Platform applications. The landing page displays all the running and queued application deployments, branches that are to be merged, and reports that provide information about your DevOps environment such as key performance indicators (KPIs).
For more information about using Deployment Manager and data migration pipelines, see Exporting and importing simulation data automatically with Deployment Manager.
- Logging in to Deployment Manager
Deployment Manager provides a dedicated portal from which you can access features.
- Accessing the Dev Studio portal
If your role has the appropriate permission, you can access Dev Studio from within Deployment Manager. You can switch to Dev Studio to access features such as additional tools to troubleshoot issues. You can also open, modify, and create repositories and authentication profiles.
- Accessing API documentation
Deployment manager provides REST APIs for interacting with resources that in the Deployment Manager interface. Use these APIs to create and manage pipelines by using automated scripts or external information.
- Understanding roles and users
Define roles and users to manage which users can access Deployment Manager and which features they can access. For example, you can create a role that does not permit users to delete pipelines for a specific application.
- Understanding Deployment Manager notifications
You can enable notifications to receive updates about the events that occur in your pipeline. For example, you can choose to receive emails about whether unit tests failed or succeeded. You can receive notifications in the Deployment Manager notifications gadget, through email, or both. By default, all notifications are enabled for users who are configured in Deployment Manager.
- Configuring an application pipeline
When you add a pipeline, you specify merge criteria and configure stages and steps in the continuous delivery workflow. For example, you can specify that a branch must be peer-reviewed before it can be merged, and you can specify that Pega unit tests must be run after a branch is merged and is in the QA stage of the pipeline.
- Accessing systems in your pipeline
You can open the systems in your pipeline and log in to the Pega Platform instances on each system. For example, you can access the system on which the QA stage is installed.
- Filtering pipelines in the dashboard
You can filter the pipelines that the dashboard displays by application name, version, and pipeline deployment status. By filtering pipelines, the dashboard displays only the information that is relevant to you.
- Viewing merge requests
You can view the status of the merge requests for a pipeline to gain more visibility into the status of your pipeline. For example, you can see whether a branch was merged in a deployment and when it was merged.
- Viewing deployment reports for a specific deployment
Deployment reports provide information about a specific deployment. You can view information such as the number of tasks that you configured on a deployment that have been completed and when each task started and ended.
- Starting deployments
You can start deployments in a number of ways. For example, you can start a deployment manually if you are not using branches, by submitting a branch into the Merge Branches wizard, or by publishing application changes in App Studio to create a patch version of your application. Your user role determines if you can start a deployment.
- Pausing a deployment
When you pause a deployment, the pipeline completes the task that it is running, and stops the deployment at the next step.
- Stopping a deployment
Stop a deployment to discontinue processing.
- Performing actions on a deployment that has errors
If a deployment has errors, the pipeline stops processing on it. You can perform actions on it, such as rolling back the deployment or skipping the step on which the error occurred.
- Rolling back a deployment
A rollback can be performed on any deployment that encounters an error or fails for any reason. The rollback feature relies on restore points, which are automatically generated every time an import happens. Any change implemented after the import but before the next restore point will be lost when the rollback action is triggered.
- Performing ad hoc tasks
By using ad hoc tasks, you can independently perform package and deploy actions outside of the context of a deployment, which is useful for exporting artifacts from the production environment and importing them into a lower environment, or for packaging and deploying artifacts if a Deployment Manager pipeline is not available.
- Troubleshooting issues with your pipeline
Deployment Manager provides several features that help you troubleshoot and resolve issues with your pipeline.
- Understanding schema changes in application packages
If an application package that is to be deployed on candidate systems contains schema changes, the Pega Platform orchestration server checks the candidate system to verify that you have the required privileges to deploy the schema changes. One of the following results occurs:
- Completing or rejecting a manual step
If a manual step is configured on a stage, the deployment pauses when it reaches the step, and you can either complete it or reject it if your role has the appropriate permissions. For example, if a user was assigned a task and completed it, you can complete the task in the pipeline to continue the deployment. Deployment Manager also sends you an email when there is a manual step in the pipeline. You can complete or reject a step either within the pipeline or through email.
- Managing aged updates
You can manage aged updates in a number of ways such as importing them, skipping the import, or manually deploying applications. Managing aged updates gives you more flexibility in how you deploy application changes.
- Archiving and activating pipelines
If your role has the appropriate permissions, you can archive inactive pipelines so that they are not displayed on the Deployment Manager landing page.
- Disabling and enabling a pipeline
If your role has the appropriate permissions, you can disable a pipeline on which errors continuously cause a deployment to fail. Disabling a pipeline prevents branch merging, but you can still view, edit, and stop deployments on a disabled pipeline.
- Deleting an application pipeline
When you delete a pipeline, its associated application packages are not removed from the repositories that the pipeline is configured to use.