2019-03-28 15:38:25 +02:00
|
|
|
# ${docGenStepName}
|
2018-08-15 09:30:35 +02:00
|
|
|
|
2019-03-28 15:38:25 +02:00
|
|
|
## ${docGenDescription}
|
2018-08-15 09:30:35 +02:00
|
|
|
|
2018-12-14 19:10:11 +02:00
|
|
|
## Prerequisites
|
2018-08-15 09:30:35 +02:00
|
|
|
|
|
|
|
* Cloud Foundry organization, space and deployment user are available
|
|
|
|
* Credentials for deployment have been configured in Jenkins with a dedicated Id
|
|
|
|
|
|
|
|
![Jenkins credentials configuration](../images/cf_credentials.png)
|
|
|
|
|
2019-03-28 15:38:25 +02:00
|
|
|
## ${docGenParameters}
|
2018-08-15 09:30:35 +02:00
|
|
|
|
2019-03-28 15:38:25 +02:00
|
|
|
## ${docGenConfiguration}
|
2018-08-15 09:30:35 +02:00
|
|
|
|
2019-05-24 15:44:31 +02:00
|
|
|
## ${docJenkinsPluginDependencies}
|
2019-05-24 15:41:49 +02:00
|
|
|
|
2018-08-15 09:30:35 +02:00
|
|
|
## Example
|
|
|
|
|
|
|
|
```groovy
|
2018-10-17 11:01:09 +02:00
|
|
|
cloudFoundryDeploy(
|
|
|
|
script: script,
|
|
|
|
deployType: 'blue-green',
|
|
|
|
cloudFoundry: [apiEndpoint: 'https://test.server.com', appName:'cfAppName', credentialsId: 'cfCredentialsId', manifest: 'cfManifest', org: 'cfOrg', space: 'cfSpace'],
|
|
|
|
deployTool: 'cf_native'
|
|
|
|
)
|
2018-08-15 09:30:35 +02:00
|
|
|
```
|