Skip to main content

Working with a deployment

A deployment is an instance of a pipeline. After you create a pipeline and run the diagnostics, you can start a deployment to deploy the application across configured environments.

The following actions are available when a deployment is active:

  • Pause or Resume: The Pause or Resume action halts a deployment after execution of the current task. This action provides you with additional time in case you must perform validations for the next task or environment.
  • Abort: The Abort action is available when a deployment is in progress. Abort a deployment if the deployment fails or is approaching failure.
  • Rollback: The Rollback action restores the application to a restore point created before deployment of the artifact. This option is visible only on a deployment in an error state.

Starting a deployment

To start a deployment, perform either of the following actions:

  • On the Application pipelines screen, next to the target pipeline, click Start new deployment.
    1. Enter the description in the Description box.
    2. To start the deployment, click Submit.
  • On the Application pipelines screen, click a deployment pipeline.
    1. On the pipeline dashboard, click Start deployment.
    2. In the Description text box, enter a description.
    3. To start the deployment, click Submit.

Pausing or resuming a deployment

When you pause a deployment, the deployment stops after completing the current task.

Note: A user must have Pause deployment privilege to perform the Pause or Resume actions on a deployment.

You can pause or resume deployments directly on the pipeline landing page of the pipeline.

To pause and resume a deployment navigate directly to a pipeline, perform the following steps:

  1. If the pipeline is not open, in the navigation pane of Deployment Manager, click Pipelines, and then click the name of the pipeline.
  2. Select the stage where the deployment is active, and then click the More icon.
  3. Click Pause.
  4. Provide the reason to pause the pipeline, and then click Submit.
  5. Wait for the deployment to move to the Paused state.
  6. To resume a deployment, navigate to the stage where the deployment is paused, and then click the More icon.
  7. To continue the deployment, click Resume.

Stopping a deployment

If your role has the appropriate permissions, you can a deployment to prevent it from moving through the pipeline.

  1. If the pipeline is not open, in the navigation pane of Deployment Manager, click Pipelines and then click the name of the pipeline.
  2. Select the stage where the deployment is active.
  3. Click the More icon, and then click Abort.

Acting on deployment errors

If a deployment has errors, the pipeline stops processing on it. You can perform actions such as rolling back the deployment or skipping the step on which the error occurred.

Do the following steps:
  1. If the pipeline is not open, in the navigation pane of Deployment Manager, click Pipelines and then click the name of the pipeline.
  2. Click the More icon, and then do one of the following actions:
    • To resume running the pipeline from the task, click Retry.
    • To roll back to an earlier deployment, click Rollback.
      • Pega Platform 8.4 supports application-level rollback. To leverage this functionality, candidate and orchestrator environments must be on Deployment Manager 4.8 or above. For older versions of Deployment Manager (4.7.x and below) or users on Pega Platform 8.3 or below, rollback defaults to the system-level.

        For more information on rollback, see Rolling back a deployment.

    • To stop running the deployment, click Abort.
    • To skip the failed task and resume deployment from next available task, click Skip. You must have the Skip on Failure privilege associated with your role to use this feature.

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.

Note: For Pega versions 8.3 and earlier the rollback execution impacts the entire system and is not scoped to the application. Be careful about using restore when there are multiple independent applications on the system.

For Pega versions 8.4 and later with PegaDevOpsFoundation 4.8 and later, this will be an application-level rollback with no impact on other applications. Refer to the Application-level rollback document for more information.

To perform a rollback, see Managing a deployment that has errors.

Rolling back a successful deployment

If there is a situation where a successful deployment must be rolled back, perform the following steps:

  1. Insert a manual step as the final task in the stage where rollback is required.
  2. Assign the manual step to a user who will make the decision to approve/reject the deployment.
  3. To rollback, reject the deployment via email or directly in Deployment Manager.

This Topic is available in the following Module:
If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice