github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/pipelines/abapEnvironment/configuration.md (about)

     1  # Configuration
     2  
     3  In general, the SAP BTP, 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.
     4  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.
     5  
     6  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.
     7  
     8  | Stage                    | Steps |
     9  |--------------------------|-------|
    10  | Init                     | -     |
    11  | [Initial Checks](stages/initialChecks.md)           | [abapAddonAssemblyKitCheckPV](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckPV/), [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs/), [abapAddonAssemblyKitReserveNextPackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReserveNextPackages/),|
    12  | [Prepare System](stages/prepareSystem.md)           | [abapEnvironmentCreateSystem](https://sap.github.io/jenkins-library/steps/abapEnvironmentCreateSystem/) |
    13  | [Clone Repositories](stages/cloneRepositories.md)       | [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/), [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/), [abapEnvironmentCloneGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentCloneGitRepo/), [abapEnvironmentCheckoutBranch](https://sap.github.io/jenkins-library/steps/abapEnvironmentCheckoutBranch/)|
    14  | [Test](stages/test.md)                      | [abapEnvironmentRunATCCheck](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/), [abapEnvironmentRunAUnitTest](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunAUnitTest/), [abapEnvironmentPushATCSystemConfig](https://sap.github.io/jenkins-library/steps/abapEnvironmentPushATCSystemConfig/)|
    15  | [Build](stages/build.md)                    | [cloudFoundryCreateServiceKey](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateServiceKey/),  [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/), [abapEnvironmentAssembleConfirm](https://sap.github.io/jenkins-library/steps/abapEnvironmentAssembleConfirm/), [abapAddonAssemblyKitCreateTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCreateTargetVector/), [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
    16  | [Integration Tests](stages/integrationTest.md)        | [abapEnvironmentCreateSystem](https://sap.github.io/jenkins-library/steps/abapEnvironmentCreateSystem/), [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)|
    17  | [Confirm](stages/confirm.md)                  | -     |
    18  | [Publish](stages/publish.md)                  | [abapAddonAssemblyKitPublishTargetVector](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitPublishTargetVector/)|
    19  | [Post](stages/post.md)                     | [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)|
    20  
    21  ## 1. Prerequisites
    22  
    23  * Configure your Jenkins server according to the [documentation](https://sap.github.io/jenkins-library/guidedtour/).
    24  * Create a git repository on a host reachable by the Jenkins server (e.g. GitHub.com). The pipeline will be configured in this repository. Create a GitHub user with read access.
    25  * The entitlements for the ABAP environment system are available in the SAP BTP global account and assigned to the subaccount.
    26  * A Cloud Foundry organization & space with the allocated entitlements are available.
    27  * A Cloud Foundry user & password with the required authorization ("Space Developer") in the organization and space are available. User and password were saved in the Jenkins Credentials Store.
    28  
    29  ## 2. Jenkinsfile
    30  
    31  Create a file named `Jenkinsfile` in your repository with the following content:
    32  
    33  ```
    34  @Library('piper-lib-os') _
    35  
    36  abapEnvironmentPipeline script: this
    37  ```
    38  
    39  The annotation `@Library('piper-lib-os')` is a reference to the Jenkins Configuration, where you configured the project "Piper" library as a "Global Pipeline Library". If you want to **avoid breaking changes** we advise you to use a specific release of the Piper Library instead of the default master branch. This can be achieved by either adapting the configuration (see [documentation](https://sap.github.io/jenkins-library/infrastructure/customjenkins/#shared-library)) or by specifying the release within the annotaion:
    40  
    41  ```
    42  @Library('piper-lib-os@v1.53.0') _
    43  ```
    44  
    45  An Overview of the releases of the project "Piper" library can be found [here](https://github.com/SAP/jenkins-library/releases).
    46  
    47  ## 3. Configuration for Cloning the repositories
    48  
    49  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.
    50  
    51  ```yml
    52  repositories:
    53  - name: '/DMO/GIT_REPOSITORY'
    54    branch: 'master'
    55  - name: '/DMO/GIT_REPO'
    56    branch: 'master'
    57  ```
    58  
    59  You can later use the `repositories.yml` file for the `repositories` parameter in the `Clone Repositories` stage used in chapter [5. Technical Pipeline Configuration](#5-technical-pipeline-configuration).
    60  
    61  ## 4. Optional: Configuration for the ABAP Test Cockpit (ATC) and ABAP Unit Tests (AUnit)
    62  
    63  As a default, a configuration for ATC and AUnit is generated out of the `repositories.yml` file. This default configuration checks the listed repositories using the default ATC check variant and with no AUnit restrictions regarding `duration` and `risk level`.
    64  If you want to configure these tools yourself, you can create a tool specific configuration.
    65  
    66  ### ATC
    67  
    68  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](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunATCCheck/) for more details. You have to pass the filename `atcConfig.yml` to the `atcConfig` parameter in the [5. Technical Pipeline Configuration](#5-technical-pipeline-configuration). Here is an example of the configuration:
    69  
    70  ```yml
    71  atcobjects:
    72    softwarecomponent:
    73      - name: "/DMO/REPO"
    74  ```
    75  
    76  ### AUnit
    77  
    78  Create a file `aunitConfig.yml` to store the configuration for the AUnit run. In this file, you can specify which packages or software components shall be checked. Please have a look at the [step documentation](https://sap.github.io/jenkins-library/steps/abapEnvironmentRunAUnitTest/) for more details. You have to pass the filename `aunitConfig.yml` to the `aunitConfig` parameter in the [5. Technical Pipeline Configuration](#5-technical-pipeline-configuration). Here is an example of the configuration:
    79  
    80  ```yml
    81  title: My AUnit run
    82  objectSet:
    83    softwarecomponents:
    84    - name: Z_TEST_SC
    85    - name: Z_TEST_SC2
    86  ```
    87  
    88  ## 5. Technical Pipeline Configuration
    89  
    90  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:
    91  
    92  ```yml
    93  general:
    94    cfApiEndpoint: 'https://api.cf.eu10.hana.ondemand.com'
    95    cfOrg: 'your-cf-org'
    96    cfSpace: 'yourSpace'
    97    cfCredentialsId: 'cfAuthentification'
    98    cfServiceInstance: 'abapEnvironmentPipeline'
    99  stages:
   100    Prepare System:
   101      cfService: 'abap'
   102      cfServicePlan: 'standard'
   103      abapSystemAdminEmail: 'user@example.com'
   104      abapSystemDescription: 'ABAP Environment Q System'
   105      abapSystemIsDevelopmentAllowed: false
   106      abapSystemID: 'H02'
   107      abapSystemSizeOfPersistence: 4
   108      abapSystemSizeOfRuntime: 1
   109    Clone Repositories:
   110      strategy: 'Clone'
   111      repositories: 'repositories.yml'
   112    ATC:
   113      # In order to be executed, the ATC stage needs at least one configuration entry
   114      # If the ATC stage should not be executed, delete the whole section
   115      execute: stage
   116    AUnit:
   117      # In order to be executed, the AUnit stage needs at least one configuration entry
   118      # If the AUnit stage should not be executed, delete the whole section
   119      execute: stage
   120    Post:
   121      cfDeleteServiceKeys: true
   122  ```
   123  
   124  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.
   125  
   126  ### Prepare system
   127  
   128  The example values for the `Prepare System` stage are a suggestion. Please change them accordingly and don't forget to enter your own email address. Please be aware that creating a SAP BTP, ABAP environment instance may incur costs.
   129  
   130  Please have a look at the [step documentation](https://sap.github.io/jenkins-library/steps/abapEnvironmentCreateSystem/) for more details.
   131  
   132  ### Clone Repositories
   133  
   134  If the `Clone Repositories` stage is configured, you can specify the `strategy` that should be performed on the software components and the branches that you have configured in the `respositories.yml` file in step [4. Configuration for Cloning the repositories](#4-configuration-for-cloning-the-repositories). Per default the strategy will be set to `Pull` if not specified. The following strategies are supported and can be used on the software components and branches:
   135  
   136  * `Pull`: If you have specified Pull as the strategy the [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/) step will be used
   137  * `Clone`: If you have specified the Clone strategy the [abapEnvironmentCloneGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentCloneGitRepo/) step will be used
   138  * `CheckoutPull`: This strategy performs a Checkout of Branches with the [abapEnvironmentCheckoutBranch](https://sap.github.io/jenkins-library/steps/abapEnvironmentCheckoutBranch/) step followed by a Pull of the Software Component with the [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/) step
   139  
   140  Note that you can use the `repositories.yml` file with the `repositories` parameter consistently for all strategies.
   141  
   142  The values for `cfApiEndpoint`,`cfOrg` and `cfSpace` can be found in the respective overview pages in the SAP BTP cockpit. The SAP BTP / Cloud Foundry credentials, saved in the Jenkins credentials store with the ID `cfCredentialsId`, must refer to a user with the required authorizations ("Space Developer") for the SAP BTP / Cloud Foundry organization and space.
   143  
   144  ### ATC & AUnit
   145  
   146  The ATC and AUnit stage will be executed, if the `config.yml` file contains an entry for the respective stage. If you are using the default configuration a placeholder entry `execute: stage` has to be added in order to activate the stages. If you are using a dedicated configuration file - `atcConfig.yml` and `aunitConfig.yml` - this is not necessary.
   147  
   148  ## 7. Create a Jenkins Pipeline
   149  
   150  On your Jenkins server click on `New Item` to create a new pipeline. Provide a name and select the type `Pipeline`.
   151  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.
   152  
   153  If you want to configure a build trigger, this can be done in the section of the same name. Here is one example: to run the pipeline every night, you can tick the box "Run periodically". In the visible input field, you can specify a shedule. Click on the questionsmark to read the documentation. The following example will result in the pipeline running every night between 3am and 4am.
   154  
   155  ```
   156  H H(3-4) * * *
   157  ```
   158  
   159  Make sure to check the general option "Do not allow concurrent builds" in order to prevent concurrent build processes.
   160  
   161  ### Stage Names
   162  
   163  The stage name for the extension is usually the displayed name, e.g. `ATC.groovy` or `Prepare System.groovy`. One exception is the generated `Post` stage. While the displayed name is "Declarative: Post Actions", you can extend this stage using `Post.groovy`.
   164  
   165  ## Extension
   166  
   167  You can extend each stage of this pipeline following the [general extensibility documentation](../../extensibility.md) and the specific [ABAP Environment pipeline extensibility documentation](extensibility.md).