tmsExport¶
This step allows you to export an MTA file (multi-target application archive) and multiple MTA extension descriptors into a TMS (SAP Cloud Transport Management service) landscape for further TMS-controlled distribution through a TMS-configured landscape.
Description¶
This step allows you to export an MTA file (multi-target application archive) and multiple MTA extension descriptors into a TMS (SAP Cloud Transport Management service) landscape for further TMS-controlled distribution through a TMS-configured landscape. The MTA file is attached to a new transport request which is added to the import queues of the follow-on transport nodes of the specified export node.
TMS lets you manage transports between SAP Business Technology Platform accounts in Neo and Cloud Foundry, such as from DEV to TEST and PROD accounts. For more information, see official documentation of SAP Cloud Transport Management service
Prerequisites
- You have subscribed to and set up TMS, as described in Initial Setup, which includes the configuration of your transport landscape.
- A corresponding service key has been created, as described in Set Up the Environment to Transport Content Archives directly in an Application. This service key (JSON) must be stored as a secret text within the Jenkins secure store or provided as value of serviceKey parameter.
Usage¶
We recommend to define values of step parameters via .pipeline/config.yml file.
In this case, calling the step is essentially reduced to defining the step name.
Calling the step can be done either in an orchestrator specific way (e.g. via a Jenkins library step) or on the command line.
library('piper-lib-os')
tmsExport script: this
piper tmsExport
Outputs¶
| Output type | Details |
|---|---|
| influx | measurement step_data
|
Parameters¶
Overview - Step¶
| Name | Mandatory | Additional information |
|---|---|---|
| nodeName | yes | |
| script | (yes) |  reference to Jenkins main pipeline script |
| serviceKey | (yes) |  pass via ENV or Jenkins credentials (credentialsId) |
| customDescription | no | |
| mtaPath | no | |
| mtaVersion | no | |
| namedUser | no | |
| nodeExtDescriptorMapping | no | |
| proxy | no | |
| tmsServiceKey | no | pass via ENV or Jenkins credentials |
| verbose | no | activates debug output |
Overview - Execution Environment¶
Orchestrator-specific only
These parameters are relevant for orchestrator usage and not considered when using the command line option.
| Name | Mandatory | Additional information |
|---|---|---|
| stashContent | no | |
Details¶
customDescription¶
Can be used as the description of a transport request. Will overwrite the default, which is corresponding Git commit ID.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | no |
| Default | $PIPER_customDescription (if set) |
| Secret | no |
| Configuration scope |
|
| Resource references | commonPipelineEnvironment: reference to: git/commitId |
mtaPath¶
Defines the relative path to .mtar file for the export to the SAP Cloud Transport Management service. If not specified, it will use the .mtar file created in mtaBuild.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | no |
| Default | $PIPER_mtaPath (if set) |
| Secret | no |
| Configuration scope |
|
| Resource references | commonPipelineEnvironment: reference to: mtarFilePath |
mtaVersion¶
Defines the version of the MTA for which the MTA extension descriptor will be used. You can use an asterisk (*) to accept any MTA version, or use a specific version compliant with SemVer 2.0, e.g. 1.0.0 (see semver.org). If the parameter is not configured, an asterisk is used.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | no |
| Default | * |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
namedUser¶
Defines the named user to execute transport request with. The default value is 'Piper-Pipeline'. If pipeline is running on Jenkins, the name of the user, who started the job, is tried to be used at first.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | no |
| Default | Piper-Pipeline |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
nodeExtDescriptorMapping¶
Available only for transports in Cloud Foundry environment. Defines a mapping between a transport node name and an MTA extension descriptor file path that you want to use for the transport node, e.g. nodeExtDescriptorMapping: {"nodeName": "example.mtaext", "nodeName2": "example2.mtaext"}.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | map[string]interface{} |
| Mandatory | no |
| Default | $PIPER_nodeExtDescriptorMapping (if set) |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
nodeName¶
Defines the name of the export node - starting node in TMS landscape. The transport request is added to the queues of the follow-on nodes of export node.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | yes |
| Default | $PIPER_nodeName (if set) |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
proxy¶
Proxy URL which should be used for communication with the SAP Cloud Transport Management service backend.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | no |
| Default | $PIPER_proxy (if set) |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
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 for retrieving, e.g. configuration parameters.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | Jenkins Script |
| Mandatory | yes |
| Default | |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
serviceKey¶
Service key JSON string to access TMS (SAP Cloud Transport Management service) instance APIs. This can be a service key for TMS, or a service key for CALM (SAP Cloud Application Lifecycle Management) service. If not specified and if pipeline is running on Jenkins, service key, stored under ID provided with credentialsId parameter, is used.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | yes |
| Default | $PIPER_serviceKey (if set) |
| Secret | yes |
| Configuration scope |
|
| Resource references | Jenkins credential id: id: credentialsIdreference to: serviceKey |
stashContent¶
Jenkins-specific: Used for proper environment setup.
Specific stashes that should be considered for the step execution.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | []string |
| Mandatory | no |
| Default | - buildResult |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
tmsServiceKey¶
DEPRECATION WARNING: This parameter has been deprecated, please use the serviceKey parameter instead, which supports both service key for TMS (SAP Cloud Transport Management service), as well as service key for CALM (SAP Cloud Application Lifecycle Management) service. Service key JSON string to access the SAP Cloud Transport Management service instance APIs.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Mandatory | no |
| Default | $PIPER_tmsServiceKey (if set) |
| Secret | yes |
| Configuration scope |
|
| Resource references | none |
verbose¶
verbose output
| Scope | Details |
|---|---|
| Aliases | - |
| Type | bool |
| Mandatory | no |
| Default | false |
| Possible values | - true- false |
| Secret | no |
| Configuration scope |
|
| Resource references | none |
credentialsId¶
Jenkins 'Secret text' credentials ID containing service key for TMS (SAP Cloud Transport Management service) or CALM (SAP Cloud Application Lifecycle Management) service.
| Scope | Details |
|---|---|
| Aliases | - |
| Type | string |
| Configuration scope |
|