abapAddonAssemblyKitPublishTargetVector¶
This step triggers the publication of the Target Vector according to the specified scope.
Description¶
This step reads the Target Vector ID from the addonDescriptor in the commonPipelineEnvironment and triggers the publication of the Target Vector.
With targetVectorScope "T" the Target Vector will be published to the test environment and with targetVectorScope "P" it will be published to the productive environment.
For Terminology refer to the Scenario Description.
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')
abapAddonAssemblyKitPublishTargetVector script: this
piper abapAddonAssemblyKitPublishTargetVector
Prerequisites¶
- The credentials to access the AAKaaS (Technical Communication User) must be stored in the Jenkins Credential Store
- This step needs an existing Target Vector as well as the scope where it should be published.
- The Target Vector ID is taken from the addonDescriptor in the commonPipelineEnvironment.
- If you run prior to this step the step abapAddonAssemblyKitCreateTargetVector, the Target Vector will be created and its ID will be written to the commonPipelineEnvironment
A detailed description of all prerequisites of the scenario and how to configure them can be found in the Scenario Description.
Parameters¶
Overview - Step¶
Name | Mandatory | Additional information |
---|---|---|
addonDescriptor | yes | |
password | (yes) | |
script | (yes) | |
username | (yes) | |
abapAddonAssemblyKitEndpoint | no | |
maxRuntimeInMinutes | no | |
pollingIntervalInSeconds | no | |
targetVectorScope | no | |
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 |
---|---|---|
Details¶
abapAddonAssemblyKitEndpoint¶
Base URL to the Addon Assembly Kit as a Service (AAKaaS) system
Scope | Details |
---|---|
Aliases | - |
Type | string |
Mandatory | no |
Default | https://apps.support.sap.com |
Secret | no |
Configuration scope |
|
Resource references | none |
addonDescriptor¶
Structure in the commonPipelineEnvironment containing information about the Product Version and corresponding Software Component Versions
Scope | Details |
---|---|
Aliases | - |
Type | string |
Mandatory | yes |
Default | $PIPER_addonDescriptor (if set) |
Secret | no |
Configuration scope |
|
Resource references | commonPipelineEnvironment: reference to: abap/addonDescriptor |
maxRuntimeInMinutes¶
Maximum runtime for status polling in minutes
Scope | Details |
---|---|
Aliases | - |
Type | int |
Mandatory | no |
Default | 16 |
Secret | no |
Configuration scope |
|
Resource references | none |
password¶
Password for the Addon Assembly Kit as a Service (AAKaaS) system
Scope | Details |
---|---|
Aliases | - |
Type | string |
Mandatory | yes |
Default | $PIPER_password (if set) |
Secret | yes |
Configuration scope |
|
Resource references | none |
pollingIntervalInSeconds¶
Wait time in seconds between polling calls
Scope | Details |
---|---|
Aliases | - |
Type | int |
Mandatory | no |
Default | 60 |
Secret | no |
Configuration scope |
|
Resource references | none |
script¶
Jenkins-specific: Used for proper environment setup.
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 |
targetVectorScope¶
Determines whether the Target Vector is published to the productive ('P') or test ('T') environment
Scope | Details |
---|---|
Aliases | - |
Type | string |
Mandatory | no |
Default | T |
Possible values | - T - P |
Secret | no |
Configuration scope |
|
Resource references | none |
username¶
User for the Addon Assembly Kit as a Service (AAKaaS) system
Scope | Details |
---|---|
Aliases | - |
Type | string |
Mandatory | yes |
Default | $PIPER_username (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 |
abapAddonAssemblyKitCredentialsId¶
Jenkins-specific: Used for proper environment setup. See using credentials for details.
Credential stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system
Scope | Details |
---|---|
Aliases | - |
Type | string |
Configuration scope |
|
Examples¶
Configuration in the config.yml¶
The recommended way to configure your pipeline is via the config.yml file. In this case, calling the step in the Jenkinsfile is reduced to one line:
abapAddonAssemblyKitPublishTargetVector(
targetVectorScope: 'T',
script: this,
)
If the step is to be configured individually the config.yml should look like this:
steps:
abapAddonAssemblyKitPublishTargetVector:
abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId'
More convenient ways of configuration (e.g. on stage level) are described in the respective scenario/pipeline documentation.