github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/resources/metadata/tmsExport.yaml (about)

     1  metadata:
     2    name: tmsExport
     3    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.
     4    longDescription: |-
     5      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.
     6  
     7      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.
     8      For more information, see [official documentation of SAP Cloud Transport Management service](https://help.sap.com/viewer/p/TRANSPORT_MANAGEMENT_SERVICE)
     9  
    10      !!! note "Prerequisites"
    11      * You have subscribed to and set up TMS, as described in [Initial Setup](https://help.sap.com/viewer/7f7160ec0d8546c6b3eab72fb5ad6fd8/Cloud/en-US/66fd7283c62f48adb23c56fb48c84a60.html), which includes the configuration of your transport landscape.
    12      * A corresponding service key has been created, as described in [Set Up the Environment to Transport Content Archives directly in an Application](https://help.sap.com/viewer/7f7160ec0d8546c6b3eab72fb5ad6fd8/Cloud/en-US/8d9490792ed14f1bbf8a6ac08a6bca64.html). This service key (JSON) must be stored as a secret text within the Jenkins secure store or provided as value of tmsServiceKey parameter.
    13  spec:
    14    inputs:
    15      secrets:
    16        - name: credentialsId
    17          description: Jenkins 'Secret text' credentials ID containing service key for SAP Cloud Transport Management service.
    18          type: jenkins
    19      resources:
    20        - name: buildResult
    21          type: stash
    22      params:
    23        - name: tmsServiceKey
    24          type: string
    25          description: Service key JSON string to access the SAP Cloud Transport Management service instance APIs. If not specified and if pipeline is running on Jenkins, service key, stored under ID provided with credentialsId parameter, is used.
    26          scope:
    27            - PARAMETERS
    28            - STEPS
    29            - STAGES
    30          mandatory: true
    31          secret: true
    32          resourceRef:
    33            - name: credentialsId
    34              type: secret
    35              param: tmsServiceKey
    36        - name: customDescription
    37          type: string
    38          description: Can be used as the description of a transport request. Will overwrite the default, which is corresponding Git commit ID.
    39          scope:
    40            - PARAMETERS
    41            - STEPS
    42            - STAGES
    43          resourceRef:
    44            - name: commonPipelineEnvironment
    45              param: git/commitId
    46        - name: namedUser
    47          type: string
    48          description: 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.
    49          default: Piper-Pipeline
    50          scope:
    51            - PARAMETERS
    52            - STEPS
    53            - STAGES
    54        - name: nodeName
    55          type: string
    56          description: 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.
    57          scope:
    58            - PARAMETERS
    59            - STEPS
    60            - STAGES
    61          mandatory: true
    62        - name: mtaPath
    63          type: string
    64          description: 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.
    65          scope:
    66            - PARAMETERS
    67            - STEPS
    68            - STAGES
    69          resourceRef:
    70            - name: commonPipelineEnvironment
    71              param: mtarFilePath
    72        - name: mtaVersion
    73          type: string
    74          description: 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.
    75          default: "*"
    76          scope:
    77            - PARAMETERS
    78            - STEPS
    79            - STAGES
    80        - name: nodeExtDescriptorMapping
    81          type: map[string]interface{}
    82          description: '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"}.'
    83          scope:
    84            - PARAMETERS
    85            - STEPS
    86            - STAGES
    87        - name: proxy
    88          type: string
    89          description: Proxy URL which should be used for communication with the SAP Cloud Transport Management service backend.
    90          scope:
    91            - PARAMETERS
    92            - STEPS
    93            - STAGES
    94    outputs:
    95      resources:
    96        - name: influx
    97          type: influx
    98          params:
    99            - name: step_data
   100              fields:
   101                - name: tms
   102                  type: bool