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/cloudFoundryCreateService.md
Shanuson 8f723caa31 Fix bug and added documentation for cloudFoundryCreateService step (#967)
* fix bug with wrong plugin parameter used
* provided default value for stash-content
* added documentation for step
2019-11-12 10:29:08 +01:00

38 lines
1.2 KiB
Markdown

# ${docGenStepName}
## ${docGenDescription}
## ${docGenParameters}
## ${docGenConfiguration}
## ${docJenkinsPluginDependencies}
## Example
The following Example will create the services specified in a file `manifest-create-service.yml` in cloud foundry org `cfOrg` of Cloud Foundry installation accessed via `https://test.server.com` in space `cfSpace` by using the username & password stored in `cfCredentialsId`.
```groovy
cloudFoundryCreateService(
script: this,
cloudFoundry: [apiEndpoint: 'https://test.server.com',
credentialsId: 'cfCredentialsId',
serviceManifest: 'manifest-create-service.yml',
org: 'cfOrg',
space: 'cfSpace'])
```
The following example additionally to above also makes use of a variable substitution file `mainfest-variable-substitution.yml`.
```groovy
cloudFoundryCreateService(
script: this,
cloudFoundry: [apiEndpoint: 'https://test.server.com',
credentialsId: 'cfCredentialsId',
serviceManifest: 'manifest-create-service.yml',
manifestVariablesFiles: ['mainfest-variable-substitution.yml'],
org: 'cfOrg',
space: 'cfSpace'])
```