jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity

Update configuration.md (#3322)

Browse Source
This commit is contained in:
Daniel Mieg 2021-11-30 09:24:33 +01:00 committed by GitHub
parent ac09e6e4aa
commit 08a0fc0cd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
documentation/docs/pipelines/abapEnvironment/configuration.md
View File

@ -44,20 +44,7 @@ The annotation `@Library('piper-lib-os')` is a reference to the Jenkins Configur
An Overview of the releases of the project "Piper" library can be found [here](https://github.com/SAP/jenkins-library/releases).
## 3. Configuration for the Communication
The communication to the ABAP system is done using a Communication Arrangement. The Communication Arrangement is created during the pipeline stage `Prepare System` after the system creation via the command `cf create-service-key`. The configuration for the command needs to be stored in a JSON file. Create the file `sap_com_0510.json` in the repository with the following content:
```json
{
"scenario_id": "SAP_COM_0510",
"type": "basic"
}
```
Please have a look at the [step documentation](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/) for more details.
## 4. Configuration for Cloning the repositories
## 3. Configuration for Cloning the repositories
If you have specified the `Clone Repositories` Stage you can make use of a dedicated configuration file containing the repositories to be pulled and the branches to be switched on. The `repositories` flag makes use of such a configuration file and helps executing a Pull, Clone and Checkout of the Branches of the Repositores. Create the file `repositories.yml` with the following structure containing your repositories including the branches for this stage.
@ -71,7 +58,7 @@ repositories:
You can later use the `repositories.yml` file for the `repositories` parameter in the `Clone Repositories` stage used in chapter [7. Technical Pipeline Configuration](#7-technical-pipeline-configuration).
## 5. Configuration for ATC
## 4. Configuration for ATC
Create a file `atcConfig.yml` to store the configuration for the ATC run. In this file, you can specify which packages or software components shall be checked. Please have a look at the step documentation for more details. Here is an example of the configuration:
@ -83,7 +70,7 @@ atcobjects:
Please have a look at the [step documentation](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/) for more details.
## 6. Technical Pipeline Configuration
## 5. Technical Pipeline Configuration
Create a file `.pipeline/config.yml` where you store the configuration for the pipeline, e.g. apiEndpoints and credentialIds. The steps make use of the credentials store of the Jenkins server. Here is an example of the configuration file:
@ -94,7 +81,6 @@ general:
cfSpace: 'yourSpace'
cfCredentialsId: 'cfAuthentification'
cfServiceInstance: 'abapEnvironmentPipeline'
cfServiceKeyName: 'jenkins_sap_com_0510'
stages:
Prepare System:
cfService: 'abap'
@ -105,18 +91,16 @@ stages:
abapSystemID: 'H02'
abapSystemSizeOfPersistence: 4
abapSystemSizeOfRuntime: 1
cfServiceKeyConfig: 'sap_com_0510.json'
Clone Repositories:
strategy: 'Clone'
repositories: 'repositories.yml'
ATC:
atcConfig: 'atcConfig.yml'
steps:
cloudFoundryDeleteService:
Post:
cfDeleteServiceKeys: true
```
Some stages may only be executed if a certain condition is met. For example: the stage `Prepare System` will only be executed if it is configured in the stages section. Also, the created system will be deprovisioned in the cleanup routine - although it is necessary to configure the step `cloudFoundryDeleteService` as above.
Some stages may only be executed if a certain condition is met. For example: the stage `Prepare System` will only be executed if it is configured in the stages section. Also, the created system will be deprovisioned in the cleanup routine - although it is necessary to configure the step `cloudFoundryDeleteService` in the `Post`stage as shown above.
### Prepare system