Managing app deployments using Pipelines and Deployments
Summarize
Summary of Managing App Deployments using Pipelines and Deployments
This guide provides an overview of managing application deployments in ServiceNow using the Pipelines and Deployments framework within App Engine Studio. It details the process from submission to deployment, ensuring confidence in deploying applications.
Show less
Key Features
- Deployment Requests: Created when an application is submitted, enabling tracking and review. Reviewers can deploy to test environments, reject, or publish the application.
- Integration with Change Management: If integrated, you can create a change request to deploy the app in a specified change window.
- Testing Applications: Admins must approve deployment requests to trigger testing in non-production instances, ensuring application viability.
- Automated Jobs: During deployment, two jobs run: the Application Deployment Test Suite and Scoped App Definitions instance scan, aiding in diagnosing issues.
- Deployment Results: Results of automated tests and instance scans can be reviewed to troubleshoot before publishing.
Key Outcomes
Once an application passes testing, it can be deployed to the production environment, making it available to all employees. The Pipelines and Deployments framework enhances your ability to manage and streamline application deployments across multiple instances, facilitating efficient app development and deployment processes.
Review the applications developers build using App Engine Studio (AES) so you can deploy with confidence.
Deployment requests
After a developer submits an application in App Engine Studio, a deployment request is created. A deployment request is a record to track the review of submitted applications.
A reviewer can deploy the app to your test environment, reject it, or publish it, all using the App Engine Management Center. If you integrate an existing Change Management program with AEMC, and your app is ready to deploy to production, you can create a change request and deploy the app within a specified change window.
- View details of the deployment request and the application being deployed.
- Select Approve & Create Change Request when the app is ready for deployment. This action begins the Change Management processes you configure using Guided Setup.Note:If you don't have an existing Change Management program integrated with Pipelines and Deployments, select Approve & Deploy App to move the deployment to the next stage.
- View and edit details of the deployment on the Scheduled Deployments tab.
- View details of the change request on the Change Request tab. Depending on the role you have, you may be able to change some details of the request.
- Watch the Activity stream for test results, change request progress, and other deployment details.
For more information on reviewing a deployment request, see Deployment Request form in the Pipelines and Deployments app.
Testing an application
Before you publish a submitted application, test it in a non-production instance. To begin testing, an admin must open the deployment request and select Approve. The pipeline record is read and determines the next state for the request.
The goal of testing the application is to ensure the viability of the production instance. When the app has transitioned to the Testing state, ServiceNow Automated Test Framework tests run if you have enabled the appropriate properties.
If the application doesn't pass testing, then you reject the deployment request.
Deploying to a test environment
- Application Deployment Test Suite
- Scoped App Definitions instance scan
These tests can be useful to the administrator for diagnosing issues before an app is deployed. For more information about what goes on during an application deployment, see Pipelines and Deployments workflow version 24.1.2.
| Job | Description |
|---|---|
| Application Deployment Test Suite | A set of Automated Test Framework (ATF) tests. The suite consists of a single test
called Log. When the test is run, scan results are logged to the
Test Results [sys_atf_test_result] table. Note: The following two system properties must be
enabled to run the Application Deployment Test Suite:
|
| Scoped App Definitions instance scan | Instance scans aid in diagnosing health issues on a non-production instance, and are useful for addressing best practices. For more information, see Instance Scan. The instance scan checks all tables in the app that extend Task [task]. |
The admin can view the results of the scans for troubleshooting purposes by selecting the Deployment Environment Results tab in the deployment request.
- ATF Results
- Test suite name
- Test URL
- Success and failure counts
- Overall error count
- Instance Scan Results
- Scan suite name
- Scan URL
- Finding count for the scan
- Results (JSON) includes unformatted JSON code of the ATF and instance scan results, as well as any errors identified during the scans. This JSON can also be found in the Notes related list.
Publishing an application
If an application passes testing, open the deployment request and deploy the application to your production environment. It is then available to all employees in your organization. For more information, see Managing deployments using pipelines in AEMC.
Guides for more information
| Learn more about Pipelines and Deployments | Additional ServiceNow resources |
|---|---|
| The Pipelines and Deployments app is used to deploy the apps you are creating using App Engine Studio between instances in a pre-defined order. Unlike previous versions, Pipelines and Deployments allows you to deploy your apps to an unlimited number of instances for app creation, testing, staging, and production. |
|