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

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  * You have a user for the SAP BTP Cloud Foundry environment
     8  * Credentials have been configured in Jenkins with a dedicated Id
     9  
    10  ## ${docGenParameters}
    11  
    12  ## ${docGenConfiguration}
    13  
    14  ## ${docJenkinsPluginDependencies}
    15  
    16  ## Example
    17  
    18  ### Space Creation in Cloud Foundry with a simple example
    19  
    20  The following example creates an user defined space in a Cloud Foundry.
    21  
    22  You can store the credentials in Jenkins and use the `cfCredentialsId` parameter to authenticate to Cloud Foundry.
    23  
    24  This can be done accordingly:
    25  
    26  ```groovy
    27  cloudFoundryCreateSpace(
    28      cfApiEndpoint : 'https://test.server.com',
    29      cfOrg : 'cfOrg',
    30      cfSpace: 'cfSpace', //Name of the cf space to be created
    31      cfCredentialsId: 'cfCredentialsId',
    32      script: this,
    33  )
    34  ```