Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Installing or upgrading Deployment Manager 5.x

Updated on February 4, 2021

You must import the Deployment Manager components if you are using it on-premises. Because Pega Cloud services manages the orchestration server in any Pega Cloud subscription, Pega Cloud services manages the installation and upgrades of Deployment Manager orchestration servers.

Before you begin:
Note: For Pega Cloud Services users, please see the Quick-start guide for Deployment Manager on Pega Cloud Services
Deployment Manager 5.x has the following dependencies (see the capability matrix below for more information):
  • Orchestrator is supported only on Pega Platform 8.5.2 or later.
  • Orchestrator environment must have HTTPS enabled.
  • Candidate environments must have Pega Platform 8.1 or later.
    • Candidate environments between Pega Platform 8.1 and 8.5.1 require Pega Deployment Manager Foundation 4.8.4.
    • Candidate environments on Pega Platform 8.5.2 and higher require Pega Deployment Manager Foundation 5.1.
To install Deployment Manager on-premises, do 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 downloaded file.
  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:
  4. On the candidate environment, import the file.
    1. If you are configuring a candidate environment on Pega Platform version 8.1 through 8.5.1, import instead,
  5. It is mandatory that the orchestrator environment should be restarted post-RAP imports.
  6. Do one of the following actions, as applicable:
    • If you are not upgrading, continue the setup procedures.
    • If you are upgrading from version 3.x, you must first launch the Deployment Manager studio in 4.x and allow the automatic migration steps to complete, before completing the 4.x upgrade procedure.
    • If you are upgrading from version 4.x:
      • Update the DMReleaseAdmin access group to use SuperAdmin as the default access group.
      • Migrate pipelines and roles to use the new data model. See Migrating data to Deployment Manager 5.x for more information.
    See Securely authenticating in Deployment Manager for more information on setting up a secure communication with services.
    Note: On the 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.

    Platform and Deployment Manager components

    Platform and Deployment Manager components

    Pega Platform8.1 to 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+)

  • 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.

  • 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 Dev, QA, Staging, and Production environments.

  • Securely authenticating in Deployment Manager

    Deployment Manager 5.1 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.x

    Use the migration assistant feature to safely migrate data, including roles, operator records, and pipelines to the version 5.x model.

  • Previous topic Understanding default authentication profiles and operator IDs
  • Next topic Quick-start guide for Deployment Manager on Pega Cloud Services

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us