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.
Import the Deployment Manager applications
On the orchestration environment
- Import the PegaDevOpsFoundation RAP.
- Import the PegaDeploymentManager RAP.
- Restart the orchestrator after imports are completed.
On each candidate environment
- Import the PegaDevOpsFoundation RAP.
- PegaDevOpsFoundation 4.8.x for Pega Platform 8.1 - 8.4
- PegaDevOpsFoundation 5.x for Pega Platform 8.5.2 or higher.
See Installing or upgrading Deployment Manager 5.x for a more detailed installation guide.
Configure the orchestration environment
- Log in to the orchestration environment as an administrator.
- Enable the DMReleaseAdmin operator and set the password.
- Open the DMAppAdmin authentication profile and set the password.
- Log in as DMReleaseAdmin.
- Navigate to
- Ensure that the orchestrator URL is correct and click save.
- Click Generate client secret.
- Download the client secret.
- Click Update authentication profiles.
- Upload the JKS keystore on DMKeyStore rule. For information on keystore and truststore setup, see Securely authenticating in Deployment Manager.
See Setting up the orchestrator for more information on configuring the orchestrator.
For a list of frequently asked OAuth questions, see OAuth configuration.
Configure the candidate environments
- Log in to each candidate environment as an administrator.
- Enable the DMAppAdmin operator and set the password.
- Open the DMReleaseAdmin_oAuth2 authentication profile and set the client secret, access token endpoint, and revoke token endpoint downloaded from the orchestrator.
- Upload the JKS keystore on DMKeystore. For information on keystore and truststore setup, see Securely authenticating in Deployment Manager.
- Update the alias and password for the keystore on DeploymentManagerClientJWTProfile.
- If the candidate system is between Pega Platform 8.1 and Pega Platform 8.5.1,
the candidate must have 4.8.4 Pega DevOps Foundation. If candidates are managed
by an orchestrator on version 5 or later, you must create the PegaDevopsShared
configuration and set the value to True. If not set, the candidate will fall
back to using the older 4.x APIs for interactions with Deployment Manager and
the pipelines will not be functional if using a 5.x orchestrator. Having the
configuration created and set to true will ensure the candidates would leverage
the 5.x API service.
- Owning ruleset: PegaDevopsShared
- Purpose: deploymentmanager/orchestrator/managed_by_5x/enabled
- Value: True
See Setting up candidate environments for more information on configuring the candidate environments.
Configure the development environment
- Log in to the dt1 environment as an administrator.
- Update the OrchestratorURL Dynamic System Setting to the URL of the DevOps environment. The URL should end in /prweb.
- Open the application record with which you want to manage with a Deployment Manager pipeline, and set PegaDevOpsFoundation version 5 as a built-on application
For more information on configuring candidate environments, see Setting up candidate environments.
For frequently asked questions about OAuth authentication, see
Configure the application
- The application that is being promoted by a Deployment Manager pipeline should be built-on the latest version of the PegaDevOpsFoundation application.
For more information on configuring candidate environments, see Configuring an application.
Create your first pipelines
- Log in to the orchestration environment as DMReleaseAdmin.
- Click New in the top-right corner and choose Deployment pipeline.
- On the first screen, enter the following information as it applies to your
- Application name and version
- Access group
- Product name and version that defines your entire application.
- Pipeline name
- Click Next to progress to the Environment details screen
and enter the following information:
- Environment URL and Authentication profile for each environment you want included in the pipeline.
- Development repository
- Production repository (can be the same as development)
- Click Next to progress to the Model pipeline screen and press Create to create the pipeline.
See Creating pipelines for more information on creating pipelines.
Test and Execute the pipeline
- In the top right corner of the rule form, in the action menu, diagnose the pipeline to ensure your set up is valid.
- Click Start deployment to move your newly updated
application through the pipeline.
Note: This active deployment promotes changes from development to higher environments, as defined in the pipeline.
You are now ready to learn more about customizing Deployment Manager pipelines.
Previous topic Quick-start guide for Deployment Manager on Pega Cloud Services Next topic Setting up repositories