mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-25 12:24:42 +02:00
33 lines
981 B
Markdown
33 lines
981 B
Markdown
|
# ${docGenStepName}
|
||
|
|
|
||
|
|
## ${docGenDescription}
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
* Cloud Foundry organization, space and deployment user are available
|
||
|
|
* Credentials for deployment have been configured in Jenkins with a dedicated Id
|
||
|
|
|
||
|
|
## ${docGenParameters}
|
||
|
|
|
||
|
|
## ${docGenConfiguration}
|
||
|
|
|
||
|
|
## ${docJenkinsPluginDependencies}
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
The following example creates a service key named "myServiceKey" for the service instance "myServiceInstance" in the provided cloud foundry organization and space. For the service key creation, the serviceKeyConfig is used.
|
||
|
|
|
||
|
|
```groovy
|
||
|
|
cloudFoundryCreateServiceKey(
|
||
|
|
script: this,
|
||
|
|
cloudFoundry: [
|
||
|
|
apiEndpoint: 'https://test.server.com',
|
||
|
|
credentialsId: 'cfCredentialsId',
|
||
|
|
org: 'cfOrg',
|
||
|
|
space: 'cfSpace',
|
||
|
|
serviceInstance: 'myServiceInstance',
|
||
|
|
serviceKey: 'myServiceKey',
|
||
|
|
serviceKeyConfig: '{ \"key\" : \"value\" }'
|
||
|
|
])
|
||
|
|
```
|