Skip to main content

Challenge

Configuring and managing a deployment pipeline

8 Tasks

15 mins

Visible to all users
Beginner DevOps English

Scenario

You are the Release Manager for the following applications:

  • HRApps
  • ITApproval
  • PegaGP
Note: This challenge focuses on the PegaGP application

The PegaGP application has the following environments on Pega Cloud® Services:

  • Development
  • Staging
  • Production

As the Release Manager, you are responsible for managing the application deployment pipelines with the help of the Deployment Manager. You have an Orchestrator instance from where you manage these pipelines. The Development, Staging, and Production environments are available for the life cycle of your application release.

The PegaGP Development team has requested the creation of a new Quality Assurance (QA) environment with a separate pipeline of its own. This Quality Assurance (QA) environment is used to validate the development changes.

Simon is new to your team and is assigned to manage the pipelines and deployments for the PegaGP Release pipeline to the Quality Assurance environment only.

As a PegaGP Release Manager, you must address the following tasks:

  1. Provide Simon, the new team member, access to the Deployment Manager with the AppAdmin role.
  2. Add the PegaGP application to the list of allowed applications.
  3. Assist and guide Simon to independently create a pipeline, enable deployments for the new Quality Assurance environment, and manage deployments.
  4. The Release pipeline for the PegaGP application is used to release enhancements on the PegaGP application to Production. A new Beta build is requested, which the stakeholders reject in the staging environment. Ensure that the deployment is rejected and the environment rolls back to a previously approved version.

As Simon, the new team member, you must address the following task:

  • Access Deployment Manager studio with the new credentials and change your password on first login.

Follow the instructions to create a deployment pipeline and conduct the required approvals.

The following table provides the credentials you need to complete the challenge:

Role

User name

Password

Release Administrator

DMReleaseAdmin

rules123!

You must initiate your own Pega instance to complete this Challenge.

Initialization may take up to 5 minutes so please be patient.

Detailed Tasks

1 Add a new user for PegaGP application

Simon, the new team member is responsible for managing pipelines on the PegaGP application.

As the Release Manager, you must provide Simon access to the Deployment Manager with the AppAdmin role.

  1. Log in to Deployment Manager as the PGPRelease Admin with User name DMReleaseAdmin and Password rules123!
  2. In the navigation pane of Deployment Manager, click Users > People to access the People page.
  3. On the People page, click Add user to add a new user.
  4. In the Add user dialog box, enter the following details:
    1. In the User field, enter Simon@pega.com.
    2. In the Role list, select AppAdmin to provide Simon with access to manage pipelines and users for specified applications.
    3. In the Applications field, enter PegaGP.
       
      Image depicts the user Simon's profile on the Deployment Manager.
    4. Click Add to give Simon access to Deployment Manager.
    5. Copy the password.
      User's credential to access Deployment Manager Studio
    6. Close the Add user dialog box.
  5. In the lower-left corner of Deployment manager, click the user icon, and then select Log off.
  6. Log in to Deployment Manager with User name Simon@pega.com and the randomly generated password to receive a prompt to change your password.
  7. In the Current Password field, enter the randomly generated password.
  8. In the New Password and Confirm Password fields, enter rules123!

2 Add a new deployment pipeline

The Development team has requested a new environment dedicated to QA for a new feature development work in the PegeGP application. The feature is a minor enhancement on version 8 of the PegaGP application.

Simon, as a member of the Release Management team, is responsible for setting up a new pipeline enabled with the new QA environment only.

Note: If you are not already logged in to the Deployment Manager, log in as Simon.
  1. In the Deployment Manager, in the upper right, click NewDeployment pipeline to create a new deployment pipeline. ​​​​​​
     
    Image depicts the New button to create a new pipeline on the Deployment Manager.
  2. On the Application Details tab, enter the following information:
    1. In the Application packaging environment field, enter the URL instance from your browser (for example, https://tumqbidx.pegacea.net/prweb).
    2. In the Authentication profile list, enter or select DMAppAdmin.
      Application packaging environment in new deployment pipeline
    3. In the Application details section, specify the application details for the PegaGP application.
      1. In the Application field, enter PegaGP.
      2. In the Version field, enter 8.
      3. In the Access group field, enter PegaGP:Administrators.
      4. In the Product rule field, enter PegaGP.
      5. In the Version field, enter 08.05.01.
      6. In the Pipeline name field, enter PegaGPRelease2QA.
        Deployment pipeline - enter application details
  1. Click Next to proceed to the Environment Details page.
  2. In the Environments section, to the right of the Staging and Production stages, click the Delete icon.
  3. Enter the following details for the Quality Assurance stage:
    • Environment URL: https://tumqbidx.pegacea.net/prweb
    • Authentication ProfileDMAppAdmin
  4. In the Artifact management section, enter or select the following details:
    • Development repository: NEXREP 
    • Production repository: DMFilesystem
  5. Click Next to proceed to the Model Pipeline page.
  6. Review the details in the Model Pipeline and confirm that the Development and Quality Assurance stages are displayed.
  7. Click Create to create the pipeline and display the Run Diagnostics prompt.

3 Run diagnostics on the newly created pipeline

Simon has unknowingly added an incorrect repository in the Artifact management section in the Development repository. Because he is creating a new pipeline, the system prompts him to run diagnostics. Simon needs to uncover and correct the issue.

  1. On the status page of the deployment pipeline, click Run Diagnostics
  2. Review errors that are displayed in the Verifying repository connections section that occurred.
    Note: The error occurs because the repository rule to store the Deployment Manager artifact, DMFilesystem, is configured incorrectly as NEXREP.
  3. In the header of the diagnostic results, click the Back arrow.
  4. In the upper right, click Actions > Edit pipeline to edit the deployment pipeline.
  5. Click the Artifact management tab. 
  6. In the Development repository field, enter DMFilesystem
  7. Click Save to correct the configuration.
  8. On the status page of the deployment pipeline, click Run Diagnostics.
  9. In the Verifying repository connections section, review the results to ensure that the connectivity of the Development repository is healthy. 

4 Trigger a deployment

Simon triggers a test deployment to ensure the latest version of PegaGP application is deployed on the Quality Assurance environment.

Note: To complete this task, log in to the Deployment Manager as Simon.
    1. In the navigation pane of Deployment Manager, click Pipelines to open the Application Pipelines dashboard.
    2. On the PegaGPRelease2QA deployment pipeline, click Start new deployment.
    3. In the Description text box, enter Testing version 1 of the deployment pipeline to Quality Assurance.
    4. Click Submit to start the pipeline. 

    5 Pause and resume a deployment

    Simon wants to pause a deployment to review the configuration on the Quality Assurance environment.

    1. In the navigation pane of Deployment Manager, click Pipelines to open the Application Pipelines dashboard.
    2. On the Application Pipelines dashboard, click PegaGPRelease2QA deployment pipeline to access the pipeline dashboard.
      Note:  You see the option to Pause a deployment when a deployment is active. If the deployment is inactive, consider creating a deployment on the PegaGPRelease2QA pipeline.
    3. On the PegaGPRelease2QA deployment pipeline dashboard, click More > Pause to pause the deployment. The deployment completes the current task and then pauses.
       
      Image depicts the More button which the user must click to select Pause to pause the deployment.
    4. In the Description text box, enter Check QA repository rule.
    5. Click Submit.
    6. On the deployment timeline of the pipeline, click View Report to navigate to the Deployment Report and confirm that the deployment status is paused. 
    7. In the upper left, click the Back arrow, on the screen, to return to the Pipeline dashboard.
    8. On the Development stage, click the More icon on the stage. 
    9. Click Resume to resume the deployment process.
       
      Image depicts the More button which the user must click to select Resume to resume the deployment.
    10. In the Description text box, enter Validated
    11. Confirm that the status moves from Paused to In-Progress and is promoted to Quality Assurance.

    6 Configure approvals on a deployment

    The deployment process requires additional approval from the Release Manager before completing the deployment as successful. Simon will perform this change in the Quality Assurance stage after all the automated quality checks are performed. 

    1. In the navigation pane of Deployment Manager, click Pipelines to open the Application Pipelines dashboard.
    2. On the Application Pipelines dashboard, click the PegaGPRelease2QA deployment pipeline to access the pipeline dashboard
    3. On the pipeline dashboard, in the upper right, click Actions > Edit pipeline to edit the pipeline.
      Tip: In order to edit the pipeline, the user must ensure that there are no active deployments. Wait for the current deployment to complete or abort the in-progress deployment.
    4. On the Pipeline model tab, in the Quality Assurance stage, click TASK > Perform manual step to add a new task to the Quality Assurance stage.
      Image depicts the Pipeline model tab where the user must click +Task to select the Perform manual step option from the dropdown.
    5. Click Select to add the task to the Stage. 
    6. In the Task details pane, in the Label field, enter QA Approval.
    7. In the Assign to field, enter Simon@DevOps
    8. Click Save to save the pipeline.
      Note: You skip the diagnostics because no changes to the environment configurations occurred.
    9. In the upper left, click the Back arrow to return to the Pipeline dashboard.
    10. Click Start Deployment to begin a deployment to check the changes. 
      1. In the Description text box enter, Approval added at QA stage.
      2. Click Submit to start the deployment and let the deployment progress until it moves to the Action Required state.
      3. Click More > Approve to approve the task.
      4. In the Description text box enter, Approved QA results.
      5. Click Submit.

    7 Add a stage on the pipeline

    The stakeholders of the PegaGP application decide to enable the path to Staging. 

    Simon needs to configure the PegaGPRelease2QA deployment pipeline with a stage for Staging and configure a manual transition or multispeed deployment as the action to promote the application to Staging.

    Note: To complete this task, log in to the Deployment Manager as Simon.
    1. In the navigation pane of Deployment Manager, click Pipelines to open the Application Pipelines dashboard.
    2. On the Application Pipelines dashboard, click the PegaGPRelease2QA deployment pipeline to access the pipeline dashboard.
    3. On the Pipeline dashboard, in the upper right, click Actions > Edit pipeline to edit the pipeline. 
    4. On the Pipeline model tab, in the Quality Assurance stage, click STAGE to add a new stage.
    5. In the text box of the stage enter Staging
    6. On the right, in the Stage details pane, enter the following details:
      1. In the Environment URL field, enter https://tumqbidx.pegacea.net/prweb.
      2. In the Authentication profile field, enter or select DMAppAdmin.
      3. In the Environment Template list, select Staging.
    7. Click the Quality Assurance stage to enable controlled and on-demand promotion of validated artifacts to the Staging environment.
    8. In the Stage details pane, in the When all tasks on the stage complete section, select Wait for a user action to provide an option of controlled promotion.
    9. Click Save to save your changes.
    10. Test your changes by starting at least three deployments.
    11. In the lower left, click the User icon, and then select Log off to exit Deployment Manager.
    Note: While the deployment pipeline can be enabled with the Production deployment, it is not in the scope of this challenge.

    8 Roll back a deployment

    The PegaGP Release Manager starts a new deployment, which waits for a stakeholder's approval at the Staging environment. The stakeholder decides to reject the deployment into Production and requests the Release Manager to rollback the environment to the pre-deployment state.

    1. Log in to Deployment Manager as the Release Manager with User name DMReleaseAdmin and Password rules123!
    2. On the Application Pipelines dashboard, in the PegaGP section, click Start new deployment to initiate the request.

      Image depicts the deployment pipeline that is available for the user on the Deployment Manager portal.

    3. In the Description field, enter Beta build request #1.
    4. Click Submit to observe the deployment status for the PegaGP_Release_85 pipeline.

      image depicts the progress of the Pega_GP_85 pipeline
       
    5. On the deployment status, click PegaGP_Release_85 to open the pipeline and observe the deployment progress through the Development phase to the Quality Assurance stage.
      Note: In the Staging environment, the deployment has completed the first three tasks successfully (that is, Deploy application, Check guardrail compliance, and Verify security checklist). The fourth task in the stage, Approve for production, is pending approval from the PegaGP Release Manager.

      image depicts the Staging environment where you can see that the deployment has completed the first three tasks successfully. The fourth task, Approval for production, is pending approval from the PegaGP Release Manager.

    6. On the pipeline dashboard, on the Staging stage, click the More icon, and then select Reject to open the Reject dialog box.
      Reject a approval task in Deployment Manager
    7. In the Reject dialog box, in the Rejection note field, enter Reject and roll back the deployment.
    8. Click Submit to close the Reject dialog box. 
      Note: When the deployment is rejected, the deployment can now be rolled back to the application restore point created by Deployment Manager before the deployment.
    9. On the Staging stage, click the  More icon, and then select Rollback to open the Rollback dialog box.
       
      Rollback a failed deployment
    10. In the Rollback deployment dialog box, click Submit to proceed with the rollback.
      Rollback confirmation
    11. Observe the status of the Rollback on the stage.
      Rollback in progress
    12. In the lower left, click the User icon, and then select Log off to exit Deployment Manager.

    This Challenge is to practice what you learned 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?

    Want to help us improve this content?

    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