Skip to main content

Installing or updating Deployment Manager 5

Suggest edit Updated on December 13, 2021

Get started with Deployment Manager by using a model-driven solution with built-in best practices to deploy Pega applications. Find the applicable resources in the following table to install or update.

Complete the following steps to set up Deployment Manager for the first time:

Setting up Deployment Manager

InstallationGetting started on Pega CloudGetting started on-premise and client managed cloud
New install
  1. To request a DevOps instance, open a ticket on the Pega My Support Portal.
  2. To get started, see the Quick-start guide for Deployment Manager on Pega Cloud Services.
  1. Download the latest Deployment Managerpackage from the Pega Marketplace.
  2. To install the component, see Installing the latest version of Deployment Manager.
  3. To get started, see Quick-start guide for Deployment Manager on-premises and client-managed cloud.
Update
  1. To request a DevOps instance, open a ticket on the Pega My Support Portal.
  2. For update instructions, see Updating to the latest version of Deployment Manager.
  1. Download the latest Deployment Manager package from the Pega Marketplace.
  2. For update instructions, see Updating to the latest version of Deployment Manager.

Note: Orchestrator environments on Deployment Manager 5.x must have HTTPS enabled. For versioning-related dependencies, see the capability table below.

Platform and Deployment Manager components

Pega Platform8.1 to 8.5.18.5.2 and later
Orchestrator 5.xSupported
Candidate 5.xSupported
Orchestrator 4.8.4Supported
Candidate 4.8.4Supported (*can be managed by a 5.x orchestrator on Platform 8.5.2+)

Installing the latest version of Deployment Manager

To install Deployment Manager on-premises or client managed cloud, perform the following steps:

  1. Navigate to the Deployment Manager Pega Marketplace page and download the latest version of Deployment Manager.
  2. Extract the contents of the download.
  3. Use the Import wizard to import files into the appropriate systems. For more information about the Import wizard, see Importing rules and data by using the Import wizard.
    1. On the orchestration environment, import the following files in the order below:
      1. PegaDevOpsFoundation_5.x.zip
      2. PegaDeploymentManager_5.x.zipNote: You will see an import error after importing this package.
  4. Restart the orchestrator environment.
  5. On the candidate environment, import the PegaDevOpsFoundation_5.x.zip file.
    1. If you are configuring a candidate environment on Pega Platform version 8.1 through 8.5.1, import PegaDevOpsFoundation_8.1-04.08.x.zip instead.

Updating to the latest version of Deployment Manager

See the table below to update from your current version of Deployment Manager to the latest release.

Current versionSupported target version
Deployment Manager 5.xDeployment Manager 5.x
Deployment Manager 4.xDeployment Manager 5.x
Deployment Manager 3.xDeployment Manager 4.x

Current versionUpdating to 5.4 or later
Deployment Manager 5.xUpdating to the latest Deployment Manager release from within 5.x is seamless. Updating ensures there is no impact to the execution of your pipelines. If you are updating both the Deployment Manager server (or orchestrator) and the candidates, enable the operators used by Deployment Manager.
Deployment Manager 4.7 or 4.8If you are updating from version 4.x, your application pipelines continue to function until all pipelines are migrated to the 5.x version. To use Deployment Manager 5.4, please see the following:
  • Update the default access group to SuperAdmin for the DMReleaseAdmin operator. This allows the DMReleaseAdmin user to access the latest version of application.
  • Setup the new orchestrator version. For more information, see Securely authenticating in Deployment Manager.
  • Migrate a low-impact pipeline using the migration assistant. For more information, see Migrating data to Deployment Manager 5.
  • Test the pipeline in 5.x to finalize the migration of all pipelines and roles.
  • Migrate the remainder of pipelines and roles to use the new data model.
Deployment Manager 3.xTo update from version 3.x, you must first launch Deployment Manager 4.x and allow the automatic migration steps to complete. You can then update from 4.x to 5.x.

See Securely authenticating in Deployment Manager for more information on setting up a secure communication with services.

Note: On your first login to Deployment Manager 5.1 studio, you see authentication errors due to an unestablished communication with Deployment Manager. Continue with the setup procedures to resolve.
  • Quick-start guide for Deployment Manager on Pega Cloud Services

    Your Pega Cloud Services account comes with everything you need to start deploying your application to production. This guide summarizes all the steps necessary to deploy your new Pega Application to production. To request an update to the latest version, create a ticket on the Pega My Support Portal here.

  • Quick-start guide for Deployment Manager on-premises and client-managed cloud

    This guide summarizes all of the required steps for getting started with Deployment Manager for on premises and client cloud deployments. For customers with familiarity with Deployment Manager and the Pega Platform it can act as a checklist for quickly setting up a new Deployment Manager implementation.

  • Setting up repositories

    Deployment Manager stores application artifacts created throughout the lifecycle of a deployment within a repository. Using Deployment Manager requires the usage of a supported artifact repository.

  • Setting up the orchestrator

    The orchestrator is a standalone Pega environment that allows modeling and execution of continuous integration and continuous delivery (CI/CD) pipelines.

  • Setting up candidate environments

    Candidate environments are any Pega environment that a Deployment Manager pipeline manages. Most pipelines consist of development, QA, staging, and production environments.

  • Securely authenticating in Deployment Manager

    Deployment Manager 5 now supports an OAuth 2.0 token-based authentication process for a more secure operator experience within the orchestrator and candidate environments. This authentication and authorization model provides many benefits, including the ability to audit user operations within Deployment Manager, as all actions are now connected to an operator ID instead of a generic authentication profile, such as DMReleaseAdmin.

  • Configuring an application

    There are a few requirements and recommendations for structuring an application that is being managed using Deployment Manager. See this brief overview to get started with configuration.

  • Migrating data to Deployment Manager 5

    Use the migration assistant feature to safely migrate data, including roles, operator records, and pipelines to the version 5.x model. Only users with the Super Admin role can perform pipeline, operator and roles migration.

  • Installing the latest version of Deployment Manager
  • Updating to the latest version of Deployment Manager

    See the following table

  • Previous topic Understanding default authentication profiles and operator IDs
  • Next topic Quick-start guide for Deployment Manager on Pega Cloud Services
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

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

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us