Learn how to deploy your code to Production using Cloud Manager pipelines in AEM as a Cloud Service.
Deploying code seamlessly to Stage and then through to Production is done via a Production pipeline. The Production pipeline execution is broken into two logical phases.
Only the Full Stack Code pipeline type supports code scanning, function testing, UI testing, and experience audit.
Once you have configured your production Pipeline including repository, environment, and testing environment, you are ready to deploy your code.
Log into Cloud Manager at my.cloudmanager.adobe.com and select the appropriate organization.
Click on the program for which you want to deploy code.
Click Deploy from the call-to-action on the Overview screen to start the deployment process.
The Pipeline Execution screen displays. Click Build to start the process.
The build process deploys your code through three phases.
You can review the steps from various deployment processes by viewing logs, or reviewing results, for the testing criteria.
The Stage Deployment phase. involves these steps.
The Stage testing phase involves these steps.
Product Functional Testing - Cloud Manager pipeline executes tests that run against the stage environment.
Custom Functional Testing - This step in the pipeline is always executed and cannot be skipped. If no test JAR is produced by the build, the test passes by default.
Custom UI Testing - This step is an optional feature that automatically run UI tests created for custom applications.
Experience Audit - This step in the pipeline is always executed and cannot be skipped. As a production pipeline is executed, an experience audit step is included after custom functional testing that will run the checks.
The process for deploying to production topologies differs slightly in order to minimize impact visitors to an AEM site.
Production deployments generally follow the same steps as previously described, but in a rolling manner.
This process continues until the deployment has reached all publishers and dispatchers in the topology.
The following steps will timeout if left waiting for user feedback:
Step | Timeout |
---|---|
Code Quality Testing | 14 days |
Security Testing | 14 days |
Performance Testing | 14 days |
Application for Approval | 14 days |
Schedule Production Deployment | 14 days |
CSE Support | 14 days |
All Cloud Service deployments follow a rolling process to ensure zero downtime. Please refer to the document How Rolling Deployments Work to learn more.
The Dispatcher cache is wiped out on each deployment. It is subsequently warmed up before the new publish nodes accept traffic.
Re-execution of the production deployment step is supported for executions where the production deploy step has completed. The type of completion is not important – the deployment could be cancelled, or unsuccessful. That said, the primary use case is expected to be cases where the production deployment step failed for transient reasons. Re-execution creates a new execution using the same pipeline. This new execution consists of three steps:
The build step may be slightly differently labeled in the UI to reflect that it is copying artifacts, not re-building.
Limitations:
To identify if an execution is a re-execute execution, the trigger field can be examined. Its value will be RE_EXECUTE.
To trigger a re-execution, a PUT request needs to be made to the HAL Link <(https://ns.adobe.com/adobecloud/rel/pipeline/reExecute)> on the production deploy step state. If this link is present, the execution can be restarted from that step. If it is absent, the execution cannot be restarted from that step. In the initial release, this link will only ever be present on the production deploy step but future releases may support starting the pipeline from other steps. Example:
{
"_links": {
"https://ns.adobe.com/adobecloud/rel/pipeline/logs": {
"href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530/logs",
"templated": false
},
"https://ns.adobe.com/adobecloud/rel/pipeline/reExecute": {
"href": "/api/program/4/pipeline/1/execution?stepId=2983530",
"templated": false
},
"https://ns.adobe.com/adobecloud/rel/pipeline/metrics": {
"href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530/metrics",
"templated": false
},
"self": {
"href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530",
"templated": false
}
},
"id": "6187842",
"stepId": "2983530",
"phaseId": "1575676",
"action": "deploy",
"environment": "weretail-global-b75-prod",
"environmentType": "prod",
"environmentId": "59254",
"startedAt": "2022-01-20T14:47:41.247+0000",
"finishedAt": "2022-01-20T15:06:19.885+0000",
"updatedAt": "2022-01-20T15:06:20.803+0000",
"details": {
},
"status": "FINISHED"
The syntax of the HAL link’s href value above is not intended to be used as a point of reference. The actual value should always be read from the HAL link and not generated.
Submitting a PUT request to this endpoint will result in a 201 response if successful and the response body will be the representation of the new execution. This is similar to starting a regular execution through the API.