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

Do not consider values from project config as defaults.

Browse Source
This commit is contained in:
Marcus Holl 2018-03-08 15:41:57 +01:00
parent 6e1a1245e8
commit 3b5e1d9942
2 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/docs/steps/mtaBuild.md
View File

@ -12,8 +12,8 @@ Executes the SAP MTA Archive Builder to create an mtar archive of the applicatio
| parameter | mandatory | default | possible values | | parameter | mandatory | default | possible values |
| -----------------|-----------|--------------------------------------------------------|--------------------| | -----------------|-----------|--------------------------------------------------------|--------------------|
| `script` | yes | | | | `script` | yes | | |
| `buildTarget` | yes | `'buildTarget'` from step configuration `'mtaBuild'` | 'CF', 'NEO', 'XSA' | | `buildTarget` | yes | `'NEO'` | 'CF', 'NEO', 'XSA' |
| `mtaJarLocation` | no | `'mtaJarLocation'`from step configuration `'mtaBuild'` | | | `mtaJarLocation` | no | | |
* `script` - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the `this` parameter, as in `script: this`. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters. * `script` - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the `this` parameter, as in `script: this`. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters.
* `buildTarget` - The target platform to which the mtar can be deployed. * `buildTarget` - The target platform to which the mtar can be deployed.

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

@ -17,47 +17,47 @@ needs to be extracted into the folder provided by `neoHome`. In case this parame
* **Java 8 or higher** - needed by the *Neo-Java-Web-SDK* * **Java 8 or higher** - needed by the *Neo-Java-Web-SDK*
## 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 |
| -------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------|-----------------| | -------------------|-----------|-------------------------------|-------------------------------------------------|
| `account` | no | `'account'` from step configuration `'neoDeploy'` | | | `account` | no | | |
| `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` | | `deployMode` | yes | `'mta'` | `'mta'`, `'warParams'`, `'warPropertiesFile'` |
| `script` | yes | | | | `script` | yes | | |
| `archivePath` | yes | | | | `archivePath` | yes | | |
| `deployHost` deprecated, use `host` | no | `'account'` from step configuration `'neoDeploy'`, or propertey `'DEPLOY_HOST'` from `commonPipelineEnvironment` (deprecated) | | | `deployHost` deprecated, use `host` | no | | |
| `deployAccount` deprecated, use `account` | no | `'host'` from step configuration `'neoDeploy'`, or property `'CI_DEPLOY_ACCOUNT'` from `commonPipelineEnvironment` (deprecated) | | | `deployAccount` deprecated, use `account` | no | | |
| `host` | no | `'account'` from step configuration `'neoDeploy'` | | | `host` | no | | |
| `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | | | `neoCredentialsId` | no | `'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 | | | `neoHome` | no | | |
## 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 |
| -------------------|-----------|----------------------------------------------------------------------------------------------|-------------------------------------------------| | -------------------|-----------|-------------------------------|-------------------------------------------------|
| `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` | | `archivePath` | yes | | |
| `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` | | `deployMode` | yes | `'mta'` | `'mta'`, `'warParams'`, `'warPropertiesFile'` |
| `script` | yes | | | | `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` |
| `archivePath` | yes | | | | `script` | yes | | |
| `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | | | `archivePath` | yes | | |
| `neoHome` | no | `'neoHome'` from step configuration `'neoDeploy'`. Otherwise Environment is checked for `NEO_HOME`, <br>otherwise the neo toolset is expected in the path | | | `neoCredentialsId` | no | `'CI_CREDENTIALS_ID'` | |
| `propertiesFile` | yes | | | | `neoHome` | no | | |
| `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'` | | | `account` | no | | |
| `deployMode` | yes | `'MTA'` | `'MTA'`, `'WAR_PARAMS'`, `'WAR_PROPERTIESFILE'` | | `deployMode` | yes | `'mta'` | `'mta'`, `'warParams'`, `'warPropertiesFile'` |
| `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` | | `warAction` | yes | `'deploy'` | `'deploy'`, `'rolling-update'` |
| `script` | yes | | | | `script` | yes | | |
| `archivePath` | yes | | | | `archivePath` | yes | | |
| `deployHost` deprecated, use `host` | no | `'account'` from step configuration `'neoDeploy'`, or propertey `'DEPLOY_HOST'` from `commonPipelineEnvironment` (deprecated) | | | `deployHost` deprecated, use `host` | no | |
| `deployAccount` deprecated, use `account` | no | `'host'` from step configuration `'neoDeploy'`, or property `'CI_DEPLOY_ACCOUNT'` from `commonPipelineEnvironment` (deprecated) | | | `deployAccount` deprecated, use `account` | no | |
| `host` | no | `'account'` from step configuration `'neoDeploy'` | | | `host` | no | | |
| `neoCredentialsId` | no | `'neoCredentialsId'` from step configuration `'neoDeploy'` or hard coded value `'CI_CREDENTIALS_ID'` | | | `neoCredentialsId` | no | `'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 | | | `neoHome` | no | | |
| `applicationName` | yes | | | | `applicationName` | yes | | |
| `runtime` | yes | | | | `runtime` | yes | | |
| `runtime-version` | yes | | | | `runtime-version` | yes | | |
| `size` | no | `'lite'` | `'lite'`, `'pro'`, `'prem'`, `'prem-plus'` | | `vmSize` | no | `'lite'` | `'lite'`, `'pro'`, `'prem'`, `'prem-plus'` |
* `deployMode` - The deployment mode which should be used. Available options are `'MTA'` (default), `'WAR_PARAMS'` (deploying WAR file and passing all the deployment parameters via the function call) and `'WAR_PROPERTIESFILE'` (deploying WAR file and putting all the deployment parameters in a .properties file) * `deployMode` - The deployment mode which should be used. Available options are `'MTA'` (default), `'WAR_PARAMS'` (deploying WAR file and passing all the deployment parameters via the function call) and `'WAR_PROPERTIESFILE'` (deploying WAR file and putting all the deployment parameters in a .properties file)
@ -72,7 +72,7 @@ needs to be extracted into the folder provided by `neoHome`. In case this parame
* `applicationName` - Name of the application you want to manage, configure, or deploy * `applicationName` - Name of the application you want to manage, configure, or deploy
* `runtime` - Name of SAP Cloud Platform application runtime * `runtime` - Name of SAP Cloud Platform application runtime
* `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. * `vmSize` - 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. The step is prepared for being executed in docker. The corresponding parameters can be applied. See step `dockerExecute` for details.