You've already forked sap-jenkins-library
mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-07-13 01:30:24 +02:00
Add stage docu (#2460)
* Add stage docu * Add table to configuration.md * Add comment to clone repo stage * Fix indentation errors * Docu: commitID * fix links
This commit is contained in:
Daniel Mieg
GitHub
@ -3,7 +3,20 @@
|
||||
In general, the ABAP Environment pipeline supports different scenarios. The idea is that only configured stages are executed and the user is able to choose the appropriate stages.
|
||||
In this section, you can learn how to create a configuration in a (GitHub) repository to run an ABAP Environment Pipeline used for testing. This specific example will create a pipeline, which executes ATC checks after creating a new ABAP Environment system. In the end, the system will be deprovisioned.
|
||||
|
||||
You can have a look at different pipeline configurations in our [SAP-samples repository](https://github.com/SAP-samples/abap-platform-ci-cd-samples).
|
||||
You can have a look at different pipeline configurations in our [SAP-samples repository](https://github.com/SAP-samples/abap-platform-ci-cd-samples) or learn more about the configuration in the respective stage or step documentation.
|
||||
|
||||
| Stage | Steps |
|
||||
|--------------------------|-------|
|
||||
| Init | - |
|
||||
| [Initial Checks](stages/initialChecks.md) | [abapAddonAssemblyKitCheckPV](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckPV/), [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs/)|
|
||||
| [Prepare System](stages/prepareSystem.md) | [abapEnvironmentCreateSystem](https://sap.github.io/jenkins-library/steps/abapEnvironmentCreateSystem/), [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/)|
|
||||
| [Clone Repositories](stages/cloneRepositories.md) | [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/)|
|
||||
| [ATC](stages/ATC.md) | [abapEnvironmentRunATCCheck](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/)|
|
||||
| [Build](stages/build.md) | [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/), [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/), [abapAddonAssemblyKitReleasePackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReleasePackages/), [abapAddonAssemblyKitCreateTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCreateTargetVector/), [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
|
||||
| [Integration Tests](stages/integrationTest.md) | [cloudFoundryCreateService](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateService/)|
|
||||
| [Confirm](stages/confirm.md) | - |
|
||||
| [Publish](stages/publish.md) | [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
|
||||
| [Post](stages/post.md) | [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)|
|
||||
|
||||
## 1. Prerequisites
|
||||
|
||||
|
||||
@ -24,60 +24,14 @@ The following stages and steps are part of the pipeline:
|
||||
| Stage | Steps |
|
||||
|--------------------------|-------|
|
||||
| Init | - |
|
||||
| Initial Checks | [abapAddonAssemblyKitCheckPV](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckPV/), [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs/)|
|
||||
| Prepare System | [abapEnvironmentCreateSystem](https://sap.github.io/jenkins-library/steps/abapEnvironmentCreateSystem/), [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/)|
|
||||
| Clone Repositories | [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/)|
|
||||
| ATC | [abapEnvironmentRunATCCheck](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/)|
|
||||
| Build | [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/), [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/), [abapAddonAssemblyKitReleasePackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReleasePackages/), [abapAddonAssemblyKitCreateTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCreateTargetVector/), [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
|
||||
| Integration Tests | [cloudFoundryCreateService](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateService/)|
|
||||
| Confirm | - |
|
||||
| Publish | [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
|
||||
| Post | [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)|
|
||||
| [Initial Checks](stages/initialChecks.md) | [abapAddonAssemblyKitCheckPV](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckPV/), [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs/)|
|
||||
| [Prepare System](stages/prepareSystem.md) | [abapEnvironmentCreateSystem](https://sap.github.io/jenkins-library/steps/abapEnvironmentCreateSystem/), [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/)|
|
||||
| [Clone Repositories](stages/cloneRepositories.md) | [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/)|
|
||||
| [ATC](stages/ATC.md) | [abapEnvironmentRunATCCheck](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/)|
|
||||
| [Build](stages/build.md) | [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/), [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/), [abapAddonAssemblyKitReleasePackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReleasePackages/), [abapAddonAssemblyKitCreateTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCreateTargetVector/), [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
|
||||
| [Integration Tests](stages/integrationTest.md) | [cloudFoundryCreateService](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateService/)|
|
||||
| [Confirm](stages/confirm.md) | - |
|
||||
| [Publish](stages/publish.md) | [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
|
||||
| [Post](stages/post.md) | [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)|
|
||||
|
||||
Below you can find more details about the different stages. [Here](configuration.md) you can find more information about how to configure your pipeline.
|
||||
|
||||
### Init
|
||||
|
||||
In this stage, the pipeline is initialized. Nothing to see here.
|
||||
|
||||
### Initial Checks
|
||||
|
||||
This stage is executed, if the "Build" stage is configured. It contains checks to verify the validity of the provided Add-on Descriptor.
|
||||
|
||||
### Prepare System
|
||||
|
||||
In this stage, the ABAP Environment system is created. This is done with the abapEnvironmentCreateSystem step. After the system creation, the Communication Arrangement [SAP_COM_0510](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html) (SAP Cloud Platform ABAP Environment - Software Component Test Integration) is created using the step cloudFoundryCreateServiceKey. With the creation of the Communication Arrangement, a User and Password is created on the ABAP Environment system for the APIs that are used in the following stages.
|
||||
|
||||
### Clone Repositories
|
||||
|
||||
As a default we assume that the ABAP Environment system is already configured and all software components are cloned and the latest change of the respective software components should be pulled with the abapEnvironmentPullGitRepo step.
|
||||
In this stage, the software components / Git repositories are then pulled to the ABAP Environment system using the step abapEnvironmentPullGitRepo.
|
||||
The step can receive a list of software components / repositories and pulls them successively.
|
||||
If the software components have not been cloned on the ABAP Environment system yet or you want to e.g. checkout a different Branch you can make use of the `strategy` stage parameter and perform other steps and step orders.
|
||||
Please refer to the Configuration section for the abapEnvironment Pipeline or the respective documentations for the [abapEnvironmentCheckoutBranch](https://sap.github.io/jenkins-library/steps/abapEnvironmentCheckoutBranch/), [abapEnvironmentCloneGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentCloneGitRepo/) and [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/) steps.
|
||||
|
||||
Either way, if you chose a dedicated strategy or the default Pull variant you can optionally provide a dedicated configuration file, e.g. `repositories.yml`, containing the repositories to be cloned and the branches to be switched to. This file can be used consistently for all strategies.
|
||||
|
||||
### ATC
|
||||
|
||||
In this stage, ATC checks can be executed using abapEnvironmentRunATCCheck. The step can receive software components or packages (configured in YML file - as described in [configuration](configuration.md)). The results are returned in the checkstyle format. With the use of a pipeline extension, quality gates can be configured (see [step documentation](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/) or the "Extensions" section in the [configuration](configuration.md)).
|
||||
|
||||
### Build
|
||||
|
||||
This stage is responsible for building an ABAP Add-on for the SAP Cloud Platform ABAP Environment. The build process of the add-on is done on a Steampunk system (using [SAP_COM_0582](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/26b8df5435c649aa8ea7b3688ad5bb0a.html)) with the help of the ABAP Add-on Assembly Kit as a Service (AAKaaS). After executing this stage successfully, the add-on is ready to be tested.
|
||||
|
||||
### Integration Tests
|
||||
|
||||
This stage is intended to be used for testing the add-on built in the "Build" stage. Nevertheless, it can be configured seperately. In this stage, another ABAP Environment system is created including the add-on (if configured correctly).
|
||||
|
||||
### Confirm
|
||||
|
||||
This stage is executed if the stage "Publish" is configured. In this stage a manual confirmation is prompted to confirm the publishing of the add-on.
|
||||
|
||||
### Publish
|
||||
|
||||
In this stage the add-on built with this pipeline is published. After that, it is ready to be delivered to productive systems.
|
||||
|
||||
### Post
|
||||
|
||||
At the end of every pipeline (successful or unsuccessful), the system is deprovisioned using the step cloudFoundryDeleteService.
|
||||
Please navigate to a stage or step to learn more details. [Here](configuration.md) you can find a step-by-step example on how to configure your pipeline.
|
||||
|
||||
64
documentation/docs/pipelines/abapEnvironment/stages/ATC.md
Normal file
64
documentation/docs/pipelines/abapEnvironment/stages/ATC.md
Normal file
@ -0,0 +1,64 @@
|
||||
# ATC
|
||||
|
||||
In this stage, ATC checks can be executed using abapEnvironmentRunATCCheck. The step can receive software components or packages. The results are returned in the checkstyle format. With the use of a pipeline extension, quality gates can be configured (see [step documentation](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/) or the "Extensions" section in the [configuration](../configuration.md)).
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [abapEnvironmentRunATCCheck](../../../steps/abapEnvironmentRunATCCheck.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
There are no specifc stage parameters.
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
|
||||
cfOrg: 'myOrg'
|
||||
cfSpace: 'mySpace'
|
||||
cfCredentialsId: 'cfAuthentification'
|
||||
cfServiceInstance: 'abap_system'
|
||||
cfServiceKeyName: 'JENKINS_SAP_COM_0510'
|
||||
stages:
|
||||
ATC:
|
||||
atcConfig: 'atcConfig.yml'
|
||||
```
|
||||
|
||||
### atcConfig.yml
|
||||
|
||||
```yaml
|
||||
atcobjects:
|
||||
softwarecomponent:
|
||||
- name: "/DMO/SWC"
|
||||
```
|
||||
|
||||
### ATC.groovy
|
||||
|
||||
```groovy
|
||||
void call(Map params) {
|
||||
//access stage name
|
||||
echo "Start - Extension for stage: ${params.stageName}"
|
||||
|
||||
//access config
|
||||
echo "Current stage config: ${params.config}"
|
||||
|
||||
//execute original stage as defined in the template
|
||||
params.originalStage()
|
||||
|
||||
recordIssues tools: [checkStyle(pattern: '**/ATCResults.xml')], qualityGates: [[threshold: 1, type: 'TOTAL', unstable: true]]
|
||||
|
||||
echo "End - Extension for stage: ${params.stageName}"
|
||||
}
|
||||
return this
|
||||
```
|
||||
|
||||
Please note, this file belongs in the extensions folder: `.pipeline/extensions/ATC.groovy`
|
||||
64
documentation/docs/pipelines/abapEnvironment/stages/build.md
Normal file
64
documentation/docs/pipelines/abapEnvironment/stages/build.md
Normal file
@ -0,0 +1,64 @@
|
||||
# Build
|
||||
|
||||
This stage is responsible for building an ABAP Add-on for the SAP Cloud Platform ABAP Environment. The build process of the add-on is done on a Steampunk system (using [SAP_COM_0582](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/26b8df5435c649aa8ea7b3688ad5bb0a.html)) with the help of the ABAP Add-on Assembly Kit as a Service (AAKaaS). After executing this stage successfully, the add-on is ready to be tested. For more details, please refer to the [scenario description](../../../scenarios/abapEnvironmentAddons.md)).
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [cloudFoundryCreateServiceKey](../../../steps/cloudFoundryCreateServiceKey.md)
|
||||
- [abapAddonAssemblyKitReserveNextPackages](../../../steps/abapAddonAssemblyKitReserveNextPackages.md)
|
||||
- [abapEnvironmentAssemblePackages](../../../steps/abapEnvironmentAssemblePackages.md)
|
||||
- [abapAddonAssemblyKitRegisterPackages](../../../steps/abapAddonAssemblyKitRegisterPackages.md)
|
||||
- [abapAddonAssemblyKitReleasePackages](../../../steps/abapAddonAssemblyKitReleasePackages.md)
|
||||
- [abapAddonAssemblyKitCreateTargetVector](../../../steps/abapAddonAssemblyKitCreateTargetVector.md)
|
||||
- [abapAddonAssemblyKitPublishTargetVector](../../../steps/abapAddonAssemblyKitPublishTargetVector.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
There are no specifc stage parameters.
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
abapAddonAssemblyKitCredentialsId: 'TechUserAAKaaS'
|
||||
addonDescriptorFileName: 'addon.yml'
|
||||
cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
|
||||
cfOrg: 'myOrgBld'
|
||||
cfSpace: 'mySpaceBld'
|
||||
cfCredentialsId: 'cfAuthentification'
|
||||
cfServiceInstance: 'bld_system'
|
||||
cfServiceKeyName: 'JENKINS_SAP_COM_0510'
|
||||
stages:
|
||||
Build:
|
||||
cfServiceKeyName: 'JENKINS_SAP_COM_0582'
|
||||
cfServiceKeyConfig: 'sap_com_0582.json'
|
||||
```
|
||||
|
||||
### addon.yml
|
||||
|
||||
```yaml
|
||||
---
|
||||
addonProduct: /DMO/PRODUCT1
|
||||
addonVersion: 1.0.0
|
||||
repositories:
|
||||
- name: /DMO/SWC
|
||||
branch: v1.0.0
|
||||
version: 1.0.0
|
||||
```
|
||||
|
||||
### sap_com_0582.json
|
||||
|
||||
```json
|
||||
{
|
||||
"scenario_id": "SAP_COM_0582",
|
||||
"type": "basic"
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,54 @@
|
||||
# Clone Repositories
|
||||
|
||||
This stage creates pulls/clones the specified software components (repositories) to the ABAP Environment system.
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps can be executed in this stage:
|
||||
|
||||
- [abapEnvironmentPullGitRepo](../../../steps/abapEnvironmentPullGitRepo.md)
|
||||
- [abapEnvironmentCloneGitRepo](../../../steps/abapEnvironmentCloneGitRepo.md)
|
||||
- [abapEnvironmentCheckoutBranch](../../../steps/abapEnvironmentCheckoutBranch.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
The parameter `strategy` influences, which steps will be executed. Possible values are:
|
||||
|
||||
| Value | Explanation |
|
||||
| --- | --- |
|
||||
| Clone | The step `abapEnvironmentCloneGitRepo` will be executed. This is recommended, if a new system was created in the `Prepare System` stage. |
|
||||
| Pull | The step `abapEnvironmentPullGitRepo` will be executed. This is recommended, if a static system is used. The software component should be cloned beforehand. |
|
||||
| CheckoutPull | The step `abapEnvironmentCheckoutBranch`, followed by `abapEnvironmentPullGitRepo`, will be executed. The software component should be cloned beforehand. This can be used if the branch may change between pipeline executions. |
|
||||
| AddonBuild | This is recommended, if the stage has to handle both newly create systems and static systems. |
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
It is recommended to use a yml configuration to define the software components. This yml file works for all strategies. If you are building an ABAP add-on, the addon descriptor `addon.yml` can be reused.
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
|
||||
cfOrg: 'myOrg'
|
||||
cfSpace: 'mySpace'
|
||||
cfCredentialsId: 'cfAuthentification'
|
||||
cfServiceInstance: 'abap_system'
|
||||
cfServiceKeyName: 'JENKINS_SAP_COM_0510'
|
||||
stages:
|
||||
Clone Repositories:
|
||||
repositories: 'repositories.yml'
|
||||
strategy: 'Clone'
|
||||
```
|
||||
|
||||
### repositories.yml
|
||||
|
||||
```yaml
|
||||
repositories:
|
||||
- name: '/DMO/SWC'
|
||||
branch: 'master'
|
||||
```
|
||||
@ -0,0 +1,15 @@
|
||||
# Confirm
|
||||
|
||||
This stage asks for a manual confirmation before releasing the add-on product in the `Publish` stage.
|
||||
|
||||
## Steps
|
||||
|
||||
No steps are executed in this stage.
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
There are no specifc stage parameters.
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for the `Publish` stage.
|
||||
@ -0,0 +1,22 @@
|
||||
# Initial Checks
|
||||
|
||||
This stage runs preliminary checks for the `Build` stage.
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [abapAddonAssemblyKitCheckPV](../../../steps/abapAddonAssemblyKitCheckPV.md)
|
||||
- [abapAddonAssemblyKitCheckCVs](../../../steps/abapAddonAssemblyKitCheckCVs.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
There are no specifc stage parameters.
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for the `Build` stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
Have a look at the [Build stage](build.md).
|
||||
@ -0,0 +1,61 @@
|
||||
# Integration Tests
|
||||
|
||||
This stage creates an ABAP Environment (Steampunk) system and installs the add-on product, that was built in the `Build` stage.
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [abapEnvironmentCreateSystem](../../../steps/abapEnvironmentCreateSystem.md)
|
||||
- [cloudFoundryDeleteService](../../../steps/cloudFoundryDeleteService.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
The parameter `confirmDeletion` influences, if a manual confirmation is required between the creation and deletion of the system.
|
||||
|
||||
| Value | Explanation |
|
||||
| --- | --- |
|
||||
| true | Before the system is deleted, a manual confirmation is requried. This is the default. |
|
||||
| false | The system is deleted without manual confirmation. This is currently not recommended. |
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
addonDescriptorFileName: 'addon.yml'
|
||||
cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
|
||||
cfCredentialsId: 'cfAuthentification'
|
||||
stages:
|
||||
Integration Tests:
|
||||
cfOrg: 'myOrgAti'
|
||||
cfSpace: 'mySpaceAti'
|
||||
cfServiceInstance: 'ati_system'
|
||||
cfService: 'abap'
|
||||
cfServicePlan: 'saas_oem'
|
||||
abapSystemAdminEmail: 'user@example.com'
|
||||
abapSystemDescription: 'Add-on Installation Test System'
|
||||
abapSystemIsDevelopmentAllowed: false
|
||||
abapSystemID: 'ATI'
|
||||
abapSystemSizeOfPersistence: 4
|
||||
abapSystemSizeOfRuntime: 1
|
||||
includeAddon: true
|
||||
confirmDeletion: true
|
||||
```
|
||||
|
||||
### addon.yml
|
||||
|
||||
```yaml
|
||||
---
|
||||
addonProduct: /DMO/PRODUCT1
|
||||
addonVersion: 1.0.0
|
||||
repositories:
|
||||
- name: /DMO/SWC
|
||||
branch: v1.0.0
|
||||
version: 1.0.0
|
||||
```
|
||||
43
documentation/docs/pipelines/abapEnvironment/stages/post.md
Normal file
43
documentation/docs/pipelines/abapEnvironment/stages/post.md
Normal file
@ -0,0 +1,43 @@
|
||||
# Post
|
||||
|
||||
This stage deletes the ABAP Environment system created in the `Prepare System` stage.
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [cloudFoundryDeleteService](../../../steps/cloudFoundryDeleteService.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
The parameter `confirmDeletion` influences, if a manual confirmation is required between the creation and deletion of the system.
|
||||
|
||||
| Value | Explanation |
|
||||
| --- | --- |
|
||||
| true | Before the system is deleted, a manual confirmation is requried if the pipeline status is not "SUCCESS". |
|
||||
| false | The system is deleted without manual confirmation. This is the default. |
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
|
||||
cfOrg: 'myOrg'
|
||||
cfSpace: 'mySpace'
|
||||
cfCredentialsId: 'cfAuthentification'
|
||||
cfServiceInstance: 'abap_system'
|
||||
stages:
|
||||
Post:
|
||||
confirmDeletion: true
|
||||
cfDeleteServiceKeys: true
|
||||
```
|
||||
|
||||
## Extension
|
||||
|
||||
This stage can be extended by creating the file `.pipeline/extensions/Post.groovy`. See [extensibility](../../../extensibility.md)
|
||||
@ -0,0 +1,52 @@
|
||||
# Prepare System
|
||||
|
||||
In this stage, the ABAP Environment system is created. This is done with the `abapEnvironmentCreateSystem` step. After the system creation, the Communication Arrangement [SAP_COM_0510](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html) (SAP Cloud Platform ABAP Environment - Software Component Test Integration) is created using the step `cloudFoundryCreateServiceKey`. With the creation of the Communication Arrangement, a User and Password is created on the ABAP Environment system for the APIs that are used in the following stages.
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [abapEnvironmentCreateSystem](../../../steps/abapEnvironmentCreateSystem.md)
|
||||
- [cloudFoundryCreateServiceKey](../../../steps/cloudFoundryCreateServiceKey.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
There are no specifc stage parameters.
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
|
||||
cfOrg: 'myOrg'
|
||||
cfSpace: 'mySpace'
|
||||
cfCredentialsId: 'cfAuthentification'
|
||||
cfServiceInstance: 'abap_system'
|
||||
cfServiceKeyName: 'JENKINS_SAP_COM_0510'
|
||||
stages:
|
||||
Prepare System:
|
||||
cfService: 'abap'
|
||||
cfServicePlan: 'standard'
|
||||
abapSystemAdminEmail: 'user@example.com'
|
||||
abapSystemDescription: 'ABAP Environment Q System'
|
||||
abapSystemIsDevelopmentAllowed: false
|
||||
abapSystemID: 'H02'
|
||||
abapSystemSizeOfPersistence: 4
|
||||
abapSystemSizeOfRuntime: 1
|
||||
cfServiceKeyConfig: 'serviceKey.json'
|
||||
```
|
||||
|
||||
### serviceKey.json
|
||||
|
||||
```json
|
||||
{
|
||||
"scenario_id": "SAP_COM_0510",
|
||||
"type": "basic"
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,42 @@
|
||||
# Publish
|
||||
|
||||
This stage publishes an add-on for the ABAP Environment (please refer to the [scenario description](../../../scenarios/abapEnvironmentAddons.md)).
|
||||
|
||||
## Steps
|
||||
|
||||
The following steps are executed in this stage:
|
||||
|
||||
- [abapAddonAssemblyKitPublishTargetVector](../../../steps/abapAddonAssemblyKitPublishTargetVector.md)
|
||||
|
||||
## Stage Parameters
|
||||
|
||||
There are no specifc stage parameters.
|
||||
|
||||
## Stage Activation
|
||||
|
||||
This stage will be active, if the stage configuration in the `config.yml` contains entries for this stage.
|
||||
|
||||
## Configuration Example
|
||||
|
||||
### config.yml
|
||||
|
||||
```yaml
|
||||
general:
|
||||
abapAddonAssemblyKitCredentialsId: 'TechUserAAKaaS'
|
||||
addonDescriptorFileName: 'addon.yml'
|
||||
stages:
|
||||
Publish:
|
||||
targetVectorScope: 'P'
|
||||
```
|
||||
|
||||
### addon.yml
|
||||
|
||||
```yaml
|
||||
---
|
||||
addonProduct: /DMO/PRODUCT1
|
||||
addonVersion: 1.0.0
|
||||
repositories:
|
||||
- name: /DMO/SWC
|
||||
branch: v1.0.0
|
||||
version: 1.0.0
|
||||
```
|
||||
Reference in New Issue
Block a user