mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-11-28 08:49:44 +02:00
Add initial docu for scenario: "Build and Publish ABAP Add-ons" (#2204)
* Add initial docu * Small fixes * Fixes * Markdown linting fixes
This commit is contained in:
Daniel Mieg
GitHub
parent
b8d3a7d1a9
commit
5003ac09ae
180
documentation/docs/scenarios/abapEnvironmentAddons.md
Normal file
180
documentation/docs/scenarios/abapEnvironmentAddons.md
Normal file
@ -0,0 +1,180 @@
|
||||
# Build and Publish Add-on Products on SAP Cloud Platform ABAP Environment
|
||||
|
||||
## Introduction
|
||||
|
||||
!!! caution "Not yet released"
|
||||
This scenario is not yet available. It is still work in progress and will be released soon.
|
||||
|
||||
This scenario describes how an add-on for the SAP Cloud Platform ABAP Environment is built. It is intended for SAP partners who want to provide a Software as a Service (SaaS) solution on the SAP Cloud Platform using the ABAP Environment. Therefore, a partner contract is required. This page aims to provide an overview of the build process of the add-on.
|
||||
|
||||
The development on SAP Cloud Platform ABAP Environment systems is done within “Software Components” (also called: “repositories”). The add-ons being built in this scenario are made up by one or multiple Software Components combined to an add-on product. The “ABAP Environment Pipeline” can be used to build and publish the add-on product. Please read on for more details about the Add-on Product and the build process.
|
||||
|
||||
Of course, this tackles only one part of the product lifecycle. Once the scenario is realeased, there will be a guid with more information about the end-to-end process from development to delivery and support of a SaaS solution.
|
||||
|
||||
## The Add-on Product
|
||||
|
||||
The installation and maintenance of ABAP software is done / controlled via software product versions. A software product version is a „bundle" of Software Component versions made available at the same time for implementing a well-defined scope of functionality. It is the technical / delivery view on a software portfolio.
|
||||
A software product version is defined by a name and a version string. The name of a software product is a string with a maximum of 30 characters and consists of the namespace and a freely chooseble part - /NAMESPC/PRODUCT1. The version string consists of three numbers separated by a dot - 1.2.0. The numbers in the version string have a hierarchic relationship:
|
||||
|
||||
- The first number denotes the release. Release deliveries contain the complete scope of functionality. It is possible to change the Software Component version bundle in a new release.
|
||||
- The second number denotes the Support Package Stack level. A Support Package stack consists of Support Package deliveries of the contained Software Component versions. It is not possible to change the Software Component version bundle in such a delivery.
|
||||
- The third number denotes the Patch level. A Patch delivery contains Patch deliveries of the contained Software Component versions.
|
||||
|
||||
!!! note "Development on SAP Cloud Platform ABAP Environment"
|
||||
As you may know, the development in the SAP Cloud Platform ABAP Environment is done within [Software Components](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/58480f43e0b64de782196922bc5f1ca0.html). A Software Component is self-contained, and a reduced set of [objects and features of the ABAP programming language](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/c99ba0d28a1a4747b8f47eda06c6b4f1.html) can be used.
|
||||
The Software Component and development objects must be created in a namespace, so that clashes between software of different vendors and SAP are avoided. Therefore, a namespace must be reserved before the development can start. SAP note 105132 describes the namespace reservation process. The namespace must be reserved for the same customer number under which the “SAP CP ABAP ENVIRONMENT” tenants are licensed.
|
||||
|
||||
A Software Component version is a technically distinguishable unit of software and is installed and patched as a whole. It consists of ABAP development packages and contained objects. Software Component versions are delivered via delivery packages. But Software Component versions are not individual shipment entities. They can only be delivered to customers as part of a software product version (see above).
|
||||
A Software Component version is defined by a name and a version string. The name of a Software Component is string with a maximum of characters and consists of the namespace and a freely chooseble part - /NAMESPC/COMPONENT1. The version consists of three numbers separated by a dot - 1.2.0. The numbers in the version string have a hierarchic relationship:
|
||||
|
||||
- The first number denotes the release. Release deliveries contains the whole Software Component and deliver new and enhancements of existing functionalities. They are delivered with delivery packages of type “Installation Package”.
|
||||
- The second number denotes the Support Package level. Support Package deliveries contain a larger collection of corrections and may contains smaller functional enhancements. They are delivered with delivery packages of type “Component Support Package”.
|
||||
- The third number denotes the Patch level. Patch deliveries shall only contain small corrections. They are delivered with delivery packages of type “Correction Package”. The needed type of delivery does not need to be chosen manually; it is automatically determined by the delivery production tools.
|
||||
|
||||
As explained above, the shipment of a software takes place via software product versions. The delivered content of a software product version is defined in a target vector, which is used by the deployment tools. The target vector is derived from the addon.yml (more on that below) and contains the following information:
|
||||
|
||||
- Product name
|
||||
- Product release
|
||||
- Product Support Package stack and Patch level
|
||||
- A list of contained Software Component versions with
|
||||
- Software Component name
|
||||
- Software Component release
|
||||
- Delivery Package, which delivers the versions
|
||||
|
||||
## Building the Add-on Product
|
||||
|
||||
The build process of a software product is orchestrated by a Jenkins Pipeline, the “ABAP Environment Pipeline” provided in this project. To run this pipeline, it only needs to be configured – which will be explained in the sections “Prerequisites” and “Configuration”.
|
||||
|
||||
|
||||
|
||||
The pipeline consists of different steps responsible for a single task. The steps themselves are grouped thematically into different stages. For example, early in the pipeline, the ABAP Environment system needs to be created and the communication needs to be set up. This is done in the “Prepare System” stage. You can read more about the different stages in the ABAP Environment Pipeline [documentation](https://sap.github.io/jenkins-library/pipelines/abapEnvironment/introduction/).
|
||||
|
||||
There are two central systems involved in the build process.
|
||||
First, the ABAP Environment system. It is created during the pipeline and deleted in the end. All actions related to the ABAP source code are executed on this system, e.g. running checks with the ABAP Test Cockpit (ATC) or the physical build of the Software Components. There are two communication scenarios containing the different APIs of the ABAP Environment System: [Test Integration](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html) and [Software Assembly Integration](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html).
|
||||
Second, the Add-on Assembly Kit as a Service. This service is responsible for registering and publishing the software product. It is accessible via APIs with an S-User.
|
||||
All required API calls to both systems are built into the different pipeline steps and stages.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
There are several parts that are required to run the pipeline for building an ABAP Environment Add-on.
|
||||
|
||||
#### Jenkins Server
|
||||
|
||||
The pipeline responsible for building ABAP add-ons has been created specifically for [Jenkins](https://www.jenkins.io). Therefore, a Jenkins Server is required. The [piper project](https://sap.github.io/jenkins-library/guidedtour/) provides a Jenkins image, which already includes the necessary configurations. Of course, it is also possible to [configure an existing server](https://sap.github.io/jenkins-library/infrastructure/customjenkins/).
|
||||
|
||||
#### Git Repository
|
||||
|
||||
The pipeline configuration is done in a git repository (for example on GitHub). This repository needs to be accessed by the Jenkins Server. If the repository is password protected, the user and password (or access token) should be stored in the Jenkins Credentials Store (Manage Jenkins -> Manage Credentials).
|
||||
|
||||
#### Delivery Tools
|
||||
|
||||
The communication with the delivery tools (aka Add-on Assembly Kit as a Service - AAKaaS) in the SAP backend needs a technical S-User. The creation and activation of such a user is described in SAP note 2174416. Make sure that this S-User is assigned to the customer number under which the “SAP CP ABAP ENVIRONMENT” tenants are licensed and for which the development namespace was reserved. The user and password need to be stored in the Jenkins Credentials Store.
|
||||
|
||||
#### Cloud Foundry Access
|
||||
|
||||
ABAP Environment systems are created in the SAP Cloud Platform Cockpit. For this pipeline, the creation and deletion of the systems are automated via the Cloud Foundry Command Line Interface: [cf CLI](https://docs.cloudfoundry.org/cf-cli/). For this to work, two things need to be configured:
|
||||
|
||||
- Cloud Foundry needs to be enabled on subaccount level. This can be done on the Subaccount Overview page. The subaccount is then mapped to a “Cloud Foundry Organization”, for which you must provide a suitable name during the creation. Have a look at the [documentation](https://help.sap.com/viewer/a96b1df8525f41f79484717368e30626/Cloud/en-US/dc18bac42270468d84b6c030a668e003.html) for more details.
|
||||
- A (technical) user is required to access the SAP Cloud Platform via the cf CLI. The user needs to be a [member of the global account](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/4a0491330a164f5a873fa630c7f45f06.html) and has to have the [Space Developer](https://help.sap.com/viewer/a96b1df8525f41f79484717368e30626/Cloud/en-US/967fc4e2b1314cf7afc7d7043b53e566.html) role. The user and password need to be stored in the Jenkins Credentials Store.
|
||||
|
||||
Later, during the pipeline configuration, you will specify the Service Plan, which will be used for the creation of an ABAP Environment system. Please make sure, that there are enough entitlements for this [Service Plan in the Subaccount](https://help.sap.com/viewer/a96b1df8525f41f79484717368e30626/Cloud/en-US/c40cb18aeaa343389036fdcdd03c41d0.html).
|
||||
|
||||
#### Register Add-on Product
|
||||
|
||||
The add-on product needs to be registered. More details will follow soon.
|
||||
|
||||
### Configuration
|
||||
|
||||
In the following subsections, the pipeline configuration for this scenario is explained. To get a general overview on the ABAP Environment Pipeline configuration, have a look [here](https://sap.github.io/jenkins-library/pipelines/abapEnvironment/configuration/). In addition to the following sections explaining the configuration, there will be an example repository including all required files.
|
||||
|
||||
#### Jenkinsfile
|
||||
|
||||
This file is the entry point of the pipeline. It should look like this:
|
||||
|
||||
```
|
||||
@Library('piper-lib-os') _
|
||||
|
||||
abapEnvironmentPipeline script: this
|
||||
```
|
||||
|
||||
The first line defines that the shared library, named “piper-lib-os” in the Jenkins Configuration, will be used. This is a reference to the [/SAP/Jenkins-library](https://github.com/SAP/jenkins-library/) of Project Piper. If desired, a specific release of this library can be requested: e.g. release 1.93.0 with `@Library('piper-lib-os@v1.93.0') _`. As the library is an Open Source project, it is possible that incompatible changes are introduced. If you want to avoid this, it is recommended to use such a specific release. If no release is specified, the newest version of the Jenkins-library will be used (pulled from the master branch).
|
||||
|
||||
The second line `abapEnvironmentPipeline script: this` defines that the predefined “ABAP Environment Pipeline” will be executed.
|
||||
|
||||
#### Config.yml
|
||||
|
||||
A configuration file `.pipeline/config.yml` is used to provide all required values to run the pipeline. This includes - for example - different endpoints or credential IDs of user and password values stored in the Jenkins Credentials Store. If a complex configuration is necessary, a separate configuration file is required, which will also be referenced in the config.yml file.
|
||||
|
||||
#### Addon.yml
|
||||
|
||||
The build process is controlled by a control file called addon.yml. This file must be created manually and must be stored in the GIT repository of the developed software. It must contain information about the to-be-delivered software product version (see above / link to above) and the contained Software Component versions (see above). Below, you see an example:
|
||||
|
||||
```YAML
|
||||
---
|
||||
addonProduct: /NAMESPC/PRODUCT1
|
||||
addonVersion: 1.2.0 q
|
||||
repositories:
|
||||
- name: /NAMESPC/COMPONENT1
|
||||
branch: release-v.1.2.0
|
||||
version: 1.2.0
|
||||
- name: /NAMESPC/COMPONENT2
|
||||
branch: release-v.2.0.0
|
||||
version: 2.0.0
|
||||
```
|
||||
|
||||
Explanation of the keys:
|
||||
|
||||
- `addonProduct`: this is the technical name of the add-on product
|
||||
- `addonVersion`: This is the technical version of the add-on product `<product version>.<support package stack level>.<patch level>`
|
||||
|
||||
The section “repositories” contains one or multiple Software Component versions:
|
||||
|
||||
- `name`: the technical name of the Software Component
|
||||
- `branch`: this is the release branch from the git repository
|
||||
- `version`: this is the technical Software Component version `<Software Component version>.<support package level>.<patch level>`
|
||||
|
||||
##### Rules:
|
||||
|
||||
For the development and the provisioning of product-/Software Component versions, it is necessary to ensure, that there is no gaps within the version and level counters. Therefore, only a continuous increase in version numbers is allowed. The following examples show valid and invalid cases, respectively:
|
||||
|
||||
Valid increase:
|
||||
|
||||
- 1.0.0 to 2.0.0
|
||||
- 1.1.2 to 2.0.0
|
||||
- 2.0.0 to 2.0.1
|
||||
- 2.1.0 to 2.2.0
|
||||
- 2.1.1 to 2.1.2
|
||||
|
||||
Invalid increase:
|
||||
|
||||
- 1.0.0 to 3.0.0 (version 2.0.0 is missing; therefore, a product/component version is missing)
|
||||
- 1.1.2 to 2.1.0 (version 2.0.0 is missing; therefore, a product/component version is missing)
|
||||
- 2.0.0 to 2.0.2 (version 2.0.1 is missing; therefore, a patch level is missing)
|
||||
- 2.1.0 to 2.3.0 (version 2.2.0 is missing; therefore, a support package level is missing)
|
||||
- 2.1.1 to 2.1.3 (version 2.1.2 is missing; therefore, a patch level is missing)
|
||||
|
||||
#### Jenkins Job
|
||||
|
||||
Once, the configuration in the git repository is completed, the pipeline on the Jenkins Server can be created. On your Jenkins Server click on “New Item” to create a new pipeline. Provide a name and select the type “Pipeline”. On the creation screen for the pipeline, scroll to the section Pipeline and select “Pipeline script from SCM”. Provide the URL (and credentials - if required) of the repository in which you configured the pipeline. Make sure the “Script Path” points to your Jenkinsfile - if you created the Jenkinsfile according to the documentation above, the default value should be correct.
|
||||
|
||||
### Example
|
||||
|
||||
Soon, an example will be posted in this [GitHub repository](https://github.com/SAP-samples/abap-platform-ci-cd-samples).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you encounter an issue with the pipeline itself, please open an issue in [GitHub](https://github.com/SAP/jenkins-library/issues).
|
||||
If the pipelines receives the error from a backend system, please open a [support incident](https://launchpad.support.sap.com/#/notes/1296527) on the respective component:
|
||||
|
||||
| Stage | Steps | Support Component |
|
||||
|--------------------------|-------|-------------------|
|
||||
| Initial Checks | [abapAddonAssemblyKitCheckPV](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckPV/), [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs/)| BC-UPG-OCS |
|
||||
| Prepare System | [cloudFoundryCreateService](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateService/), [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/)| BC-CP-ABA |
|
||||
| Clone Repositories | [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/)| BC-CP-ABA-SC |
|
||||
| ATC | [abapEnvironmentRunATCCheck](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/)| BC-DWB-TOO-ATF |
|
||||
| Build | [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/)| BC-CP-ABA |
|
||||
| | [abapAddonAssemblyKitReleasePackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReleasePackages/)| BC-UPG-ADDON |
|
||||
| | [abapAddonAssemblyKitReserveNextPackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReserveNextPackages/), [abapEnvironmentAssemblePackages](https://sap.github.io/jenkins-library/steps/abapEnvironmentAssemblePackages/), [abapAddonAssemblyKitRegisterPackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitRegisterPackages/), [abapAddonAssemblyKitCreateTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCreateTargetVector/), [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)| BC-UPG-OCS |
|
||||
| Integration Tests | [cloudFoundryCreateService](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateService/)| BC-CP-ABA |
|
||||
| Publish | [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)| BC-UPG-OCS |
|
||||
| Post | [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)| BC-CP-ABA |
|
||||
@ -47,6 +47,7 @@ nav:
|
||||
- 'Integrate SAP Cloud Platform Transport Management Into Your CI/CD Pipeline': scenarios/TMS_Extension.md
|
||||
- 'Build and Deploy SAP Fiori Applications on SAP HANA Extended Application Services, Advanced Model': scenarios/xsa-deploy/Readme.md
|
||||
- 'Build an SAP Fiori Application and Attach It to a Transport Request on an ABAP System': scenarios/upload-to-transportrequest/Readme.md
|
||||
- 'Build and Publish Add-on Products on SAP Cloud Platform ABAP Environment': scenarios/abapEnvironmentAddons.md
|
||||
- Extensibility: extensibility.md
|
||||
- 'Library steps':
|
||||
- abapAddonAssemblyKitCheckCVs: steps/abapAddonAssemblyKitCheckCVs.md
|
||||
|
||||
Loading…
Reference in New Issue
Block a user