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
|Installation||Getting started on Pega Cloud||Getting started on-premise and client managed cloud|
Platform and Deployment Manager components
|Pega Platform||8.1 to 8.5.1||8.5.2 and later|
|Candidate 4.8.4||Supported (*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:
- Navigate to the Deployment Manager Pega Marketplace page and download the latest version of Deployment Manager.
- Extract the contents of the download.
- 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.
- On the orchestration environment, import the following files in the
Note: You will see an import error after importing this package.
- On the orchestration environment, import the following files in the order below:
- Restart the orchestrator environment.
- On the candidate environment, import the
- 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 version Supported target version Deployment Manager 5.x Deployment Manager 5.x Deployment Manager 4.x Deployment Manager 5.x Deployment Manager 3.x Deployment Manager 4.x
|Current version||Updating to 5.4 or later|
|Deployment Manager 5.x||Updating 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.8||If 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:|
|Deployment Manager 3.x||To 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.
- 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