1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/documentation/docs/steps/cloudFoundryCreateSpace.md
Srinikitha Kondreddy 75e696ad7b
Add steps for cf space creation and deletion (#2049)
* [wip] Add steps for cf spaces creation and deletion

* Add tests

* Add cf space creation groovy file

* Fix shell script

* Fix shell script

* Add cloudFoundryCreateSpace command to command line controller

* Fix format

* Add cloudFoundryDeleteSpace command to command line controller

* Refactor cloudFoundryDeleteSpace step

* Add cloudFoundryDeleteSpace groovy file

* Add missing test

* Fix tests

* Add docu for cloudFoundryCreateSpace step

* Add docu for cloudFoundryDeleteSpace step

* Code review changes

Co-authored-by: Marcus Holl <marcus.holl@sap.com>
2020-09-24 11:30:25 +02:00

35 lines
808 B
Markdown

# ${docGenStepName}
## ${docGenDescription}
## Prerequisites
* You have a user for the SAP Cloud Platform Cloud Foundry Environment
* Credentials have been configured in Jenkins with a dedicated Id
## ${docGenParameters}
## ${docGenConfiguration}
## ${docJenkinsPluginDependencies}
## Example
### Space Creation in Cloud Foundry with a simple example
The following example creates an user defined space in a Cloud Foundry.
You can store the credentials in Jenkins and use the `cfCredentialsId` parameter to authenticate to Cloud Foundry.
This can be done accordingly:
```groovy
cloudFoundryCreateSpace(
cfApiEndpoint : 'https://test.server.com',
cfOrg : 'cfOrg',
cfSpace: 'cfSpace', //Name of the cf space to be created
cfCredentialsId: 'cfCredentialsId',
script: this,
)
```