jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Code Issues Releases Activity

Docu update neoDeploy

Browse Source
This commit is contained in:
Marcus Holl 2018-02-27 09:30:44 +01:00
parent d45720bcda
commit b51a747fcb
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/docs/steps/neoDeploy.md
View File

@ -19,13 +19,16 @@ needs to be extracted into the folder provided by `neoHome`. In case this parame
## Parameters when using MTA deployment method (default - MTA) ## Parameters when using MTA deployment method (default - MTA)
| parameter | mandatory | default | possible values | | parameter | mandatory | default | possible values |
| -------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------|-----------------| | -------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------|-----------------|
| `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` | | `account` | no | `'account'` from step configuration `'neoDeploy'` | |
| `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` |
| `script` | yes | | | | `script` | yes | | |
| `archivePath` | yes | | | | `archivePath` | yes | | |
| `deployHost` | no | `'account'` from step configuration `'neoDeploy'`, or propertey `'DEPLOY_HOST'` from `commonPipelineEnvironment` (deprecated) | | | `deployHost` deprecated, use `host` | no | `'account'` from step configuration `'neoDeploy'`, or propertey `'DEPLOY_HOST'` from `commonPipelineEnvironment` (deprecated) | |
| `deployAccount` | no | `'host'` from step configuration `'neoDeploy'`, or property `'CI_DEPLOY_ACCOUNT'` from `commonPipelineEnvironment` (deprecated) | | | `deployAccount` deprecated, use `account` | no | `'host'` from step configuration `'neoDeploy'`, or property `'CI_DEPLOY_ACCOUNT'` from `commonPipelineEnvironment` (deprecated) | |
| `host` | no | `'account'` from step configuration `'neoDeploy'` | |
| `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | | | `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | |
| `neoHome` | no | Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | | | `neoHome` | no | `'neoHome'` from step configuration `'neoDeploy'`. Otherwise Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | |
## Parameters when using WAR file deployment method with .properties file (WAR_PROPERTIESFILE) ## Parameters when using WAR file deployment method with .properties file (WAR_PROPERTIESFILE)
| parameter | mandatory | default | possible values | | parameter | mandatory | default | possible values |
| -------------------|-----------|----------------------------------------------------------------------------------------------|-------------------------------------------------| | -------------------|-----------|----------------------------------------------------------------------------------------------|-------------------------------------------------|
@ -33,21 +36,24 @@ needs to be extracted into the folder provided by `neoHome`. In case this parame
| `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` | | `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` |
| `script` | yes | | | | `script` | yes | | |
| `archivePath` | yes | | | | `archivePath` | yes | | |
| `neoCredentialsId` | no | `'CI_CREDENTIALS_ID'` | | | `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | |
| `neoHome` | no | Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | | | `neoHome` | no | `'neoHome'` from step configuration `'neoDeploy'`. Otherwise Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | |
| `propertiesFile` | yes | | | | `propertiesFile` | yes | | |
## Parameters when using WAR file deployment method witout .properties file - with parameters (WAR_PARAMS) ## Parameters when using WAR file deployment method witout .properties file - with parameters (WAR_PARAMS)
| parameter | mandatory | default | possible values | | parameter | mandatory | default | possible values |
| -------------------|-----------|----------------------------------------------------------------------------------------------|-------------------------------------------------| | -------------------|-----------|----------------------------------------------------------------------------------------------|-------------------------------------------------|
| `account` | no | `'account'` from step configuration `'neoDeploy'` | |
| `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` | | `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` |
| `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` | | `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` |
| `script` | yes | | | | `script` | yes | | |
| `archivePath` | yes | | | | `archivePath` | yes | | |
| `deployHost` | no | `'DEPLOY_HOST'` from `commonPipelineEnvironment` | | | `deployHost` deprecated, use `host` | no | `'account'` from step configuration `'neoDeploy'`, or propertey `'DEPLOY_HOST'` from `commonPipelineEnvironment` (deprecated) | |
| `deployAccount` | no | `'CI_DEPLOY_ACCOUNT'` from `commonPipelineEnvironment` | | | `deployAccount` deprecated, use `account` | no | `'host'` from step configuration `'neoDeploy'`, or property `'CI_DEPLOY_ACCOUNT'` from `commonPipelineEnvironment` (deprecated) | |
| `neoCredentialsId` | no | `'CI_CREDENTIALS_ID'` | | | `host` | no | `'account'` from step configuration `'neoDeploy'` | |
| `neoHome` | no | Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | | | `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | |
| `neoHome` | no | `'neoHome'` from step configuration `'neoDeploy'`. Otherwise Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | |
| `applicationName` | yes | | | | `applicationName` | yes | | |
| `runtime` | yes | | | | `runtime` | yes | | |
| `runtime-version` | yes | | | | `runtime-version` | yes | | |
@ -68,6 +74,8 @@ needs to be extracted into the folder provided by `neoHome`. In case this parame
* `runtime-version` - Version of SAP Cloud Platform application runtime * `runtime-version` - Version of SAP Cloud Platform application runtime
* `size` - Compute unit (VM) size. Acceptable values: lite, pro, prem, prem-plus. * `size` - Compute unit (VM) size. Acceptable values: lite, pro, prem, prem-plus.
The step is prepared for being executed in docker. The corresponding parameters can be applied. See step `dockerExecute` for details.
## Return value ## Return value
none none