Working with Build Pipelines
Last updated
Last updated
The Build section in ReleaseOwl enables developers to create MTAR artifacts and validate changes thoroughly for early feedback.
An artifact is a folder or a zip file containing files needed during the deployment of software to an environment.
A pipeline is the sequence of activities executed one at a time in the form of a workflow configured in your Continuous Integration and Delivery (CI/CD) platform. A Build Pipeline is used to generate artifacts from the source code. Build Pipelines can be created and run with ReleaseOwl. It fetches the source from the GIT Repository and packages the application as an MTA artifact.
An MTA is logically a single application consisting of multiple related and interdependent parts, called modules. These modules are:
Developed using different technologies.
Designed to run on different target runtime environments.
Managed with a single, consistent lifecycle.
The MTA archive builder is a standalone command-line tool that builds a deployment-ready MTAR (.mtar) file from the artifacts of an MTA project according to the project’s MTA development descriptor (mta.yaml file).
The build process and the resulting MTA archive depend on the target platform.
The supported platforms currently by ReleaseOwl are:
SAP BTP
SAP HANA Extended Application Services (XSA), Advanced Model Environment
Create new project of type SAP BTP (MTAR) or SAP HANA XSA (MTAR)
Register BTP Credentials and BTP Environment with ReleaseOwl before starting to work with Build Pipelines.
Access the Credential Manager
In the administration view, navigate to the Credential Manager.
Click on Register Credential.
Fill in the Credential Details
Credential Name: Enter a name of your choice.
Credential Type: Choose SAP Cloud Environment.
Authentication Type: Select either Basic or Authentication.
Username: Enter your SAP BTP Username.
Credentials: Use your SAP BTP password.
Navigate to SAP Cloud Environment
Go to Environments and click on SAP Cloud Environment.
Select Register SAP Cloud Environment.
Fill in the Required Details
Name: Enter a reference name of your choice.
Region: Select the appropriate region.
API Endpoint: Automatically populates based on the selected region.
Credential Name: Select the registered credential from the drop-down menu.
Org: The organization will auto-populate in the drop-down menu.
Space: The space will also auto-populate in the drop-down menu.
Environment: Choose the desired environment (e.g., dev, QA, etc.).
Save the Details
Once all fields are filled, click on the Save button.
Steps to Create a New Project
Create a New Project
Go to Projects and click on Create New Project.
Fill in the required details:
Name: Enter a project name of your choice.
Prefix Type: Auto-populates from the project prefix.
Project Type: Select SAP BTP Project.
Click on the Save button.
Access Project Settings
Locate the newly created project.
Click on the three-dot menu (•••) and select Project Settings.
Configure the Environment
Add Environment to the Project
In Project Settings, go to the Environments section.
Click on the Add button.
From the drop-down menu, select the environment for the BTP project.
Check the Source option.
Assign Permissions to Users
Assign User Permissions
Go to the Users section.
Click on the Lock button to assign permissions to users.
Deployment (Optional)
Enable Deployment
If deployment is required, select the Deploy checkbox.
Change Management
Add a User Story
Go to the Change Management section.
Click on User Story and fill in the necessary details.
Click on the Save button.
Create a Build Pipeline
Navigate to the Build Pipelines section and click on Create Build Pipeline.
Enter the Build Pipeline Name and assign Labels for filtering.
Repository Configuration
Enter the Repository URL (e.g., Bitbucket or other platforms).
Select the SCM Credentials from the drop-down menu.
Choose the branch (e.g., QA, Master, or Dev).
Builder Section
Build Type: Automatically populated.
Build Tool Version: Select the required version.
Max # of Builds to Keep: Set to 30 to store the latest versions and avoid storage issues in Jenkins.
Scheduler
Choose from Manual, Schedule, or Webhook options.
Notification Emails
Enter email addresses to receive notifications.
Static Code Analysis
Enable tools like SonarQube for code quality checks.
Malware Scanning
The purpose of a malware scan is to scan business documents for any potential threats. To perform a malware scan, you need to register the necessary credentials and configure it in your build pipeline.
Step 1: Register the Necessary Credentials
Navigate to the Administration View
Open the Administration section of the application.
Click Register Credential to create a new credential entry.
Enter the Required Details
Credential Name: Provide a meaningful name, such as "Malware Scanner."
Credential Type: Select Malware from the dropdown options.
Obtain Credentials:
Log in to your SAP BTP Cockpit.
Navigate to Services and open the Service Marketplace.
Search for "Malware" and click Create to create an instance.
Once created, go to Instances and Subscriptions to view the malware scan service.
Click View Credentials to copy the URL, username, and password.
Save the Credentials
Paste the copied details into the Credential Manager.
Click Save to register the credentials successfully.
Step 2: Configure the Malware Scan in the Build Pipeline
Check the Malware Scan Stage
Ensure the Malware Scan option is available in the Tool Integration stage.
Check the Malware box to enable the scan.
Select the Registered Credential from the dropdown menu.
Specify the timeout duration for the malware scan.
Click Save to finalize the configuration.
Step 3: Execute the Malware Scan
Run the Build Pipeline
Click on the Build Now button in the Build Pipeline to start the process.
View the Malware Scan Results
Once the pipeline runs, click the arrow button next to the malware scan stage to view the results.
Review the malware scan results, including:
Status: Indicates if the scan was successful or failed.
Timestamp: Shows when the scan was performed.
Duration: Displays how long the scan took to complete.
Review the Malware Report
Access the Build Log section for a detailed malware scan report.
If malware is detected, the log will indicate that the malware status is "true."
CVE Scan for Vulnerabilities
Overview
CVE scans identify any vulnerable versions of libraries used in your CAP application by checking known vulnerabilities.
Steps to Enable CVE Scan
Enable the SAP CVE Scan Option
Go to the Tool Integration section.
Enable the option for SAP CVE Scan.
Click Save to apply the changes.
Configure CVE Settings
In the Project Settings, go to the CVE section.
Enter the necessary details:
CVE ID: Enter the CVE ID (e.g., CVE-2023-50422) associated with the vulnerability.
Library Name: Specify the name of the affected library.
Versions: Provide the version(s) of the library that are vulnerable.
Click Save to ensure the scan is correctly set up.
Save and Run the Build Pipeline
Click on the Save button to create the build pipeline.
Click on the Build button to run the pipeline.
View the Results
Once the pipeline runs, click the arrow button next to it to view the results.
Pipeline Status
The results display the status of various stages such as Build and Prepare.
Key details include:
Status: Indicates whether the result was successful or failed.
Timestamp: Shows the date and time the stage was performed.
Duration: Displays the time taken to complete the stage.
