github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/abapEnvironmentCreateSystem.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  - On SAP Business Technology Platform (SAP BTP), 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.
     8  - A (technical) user is required to access the SAP BTP 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.
     9  - Please make sure, that there are enough entitlements in the subaccount for the [Service Plan](https://help.sap.com/viewer/a96b1df8525f41f79484717368e30626/Cloud/en-US/c40cb18aeaa343389036fdcdd03c41d0.html), which you want to use for this step.
    10  
    11  ## ${docGenParameters}
    12  
    13  ## ${docGenConfiguration}
    14  
    15  ## ${docJenkinsPluginDependencies}
    16  
    17  ## Example: Configuration in the config.yml
    18  
    19  The recommended way to configure your pipeline is via the config.yml file. In this case, calling the step in the Jenkinsfile is reduced to one line:
    20  
    21  ```groovy
    22  abapEnvironmentCreateSystem script: this
    23  ```
    24  
    25  The configuration values for the system can be passed through the `config.yml` file:
    26  
    27  ```yaml
    28  steps:
    29    abapEnvironmentCreateSystem:
    30      cfCredentialsId: 'cfCredentialsId'
    31      cfApiEndpoint: 'https://test.server.com'
    32      cfOrg: 'cfOrg'
    33      cfSpace: 'cfSpace'
    34      cfServiceInstance: 'H02_Q_system'
    35      cfService: 'abap'
    36      cfServicePlan: 'standard'
    37      abapSystemAdminEmail: 'user@example.com'
    38      abapSystemDescription: 'ABAP Environment Q System'
    39      abapSystemIsDevelopmentAllowed: true
    40      abapSystemID: 'H02'
    41      abapSystemSizeOfPersistence: 4
    42      abapSystemSizeOfRuntime: 1
    43  ```
    44  
    45  ## Example: Configuration in the Jenkinsfile
    46  
    47  The step, including all parameters, can also be called directly from the Jenkinsfile. In the following example, a configuration file is used.
    48  
    49  ```groovy
    50  abapEnvironmentCreateSystem (
    51    script: this,
    52    cfCredentialsId: 'cfCredentialsId',
    53    cfApiEndpoint: 'https://test.server.com',
    54    cfOrg: 'cfOrg',
    55    cfSpace: 'cfSpace',
    56    cfServiceManifest: 'manifest.yml'
    57  )
    58  ```
    59  
    60  The file `manifest.yml` would look like this:
    61  
    62  ```yaml
    63  ---
    64  create-services:
    65  - name:   "H02_Q_system"
    66    broker: "abap"
    67    plan:   "standard"
    68    parameters: "{ \"admin_email\" : \"user@example.com\", \"description\" : \"ABAP Environment Q System\", \"is_development_allowed\" : true, \"sapsystemname\" : \"H02\", \"size_of_persistence\" : 4, \"size_of_runtime\" : 1 }"
    69  ```