mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-12 10:55:20 +02:00
9812391145
Without this change the default setting from dockerExecute and dockerExecuteOnKubernetes are overruled. With this change the user has to explicitly configure a step if they want this behaviour. Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
156 lines
4.1 KiB
YAML
156 lines
4.1 KiB
YAML
metadata:
|
|
name: xsDeploy
|
|
description: Performs xs deployment
|
|
longDescription: |
|
|
Performs xs deployment
|
|
spec:
|
|
inputs:
|
|
secrets:
|
|
- name: credentialsId
|
|
description: Jenkins 'Username with password' credentials ID containing username/password for accessing xs endpoint.
|
|
type: jenkins
|
|
params:
|
|
- name: deployOpts
|
|
type: string
|
|
description: Additional options appended to the deploy command. Only needed for sophisticated cases. When provided it is the duty of the provider to ensure proper quoting / escaping.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default:
|
|
- name: operationIdLogPattern
|
|
type: string
|
|
description: Regex pattern for retrieving the ID of the operation from the xs log.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default: ^.*xs bg-deploy -i (.*) -a.*$
|
|
aliases:
|
|
- name: deployIdLogPattern
|
|
- name: mtaPath
|
|
type: string
|
|
description: Path to deployable
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
resourceRef:
|
|
- name: commonPipelineEnvironment
|
|
param: mtaPath
|
|
- name: action
|
|
type: string
|
|
description: Used for finalizing the blue-green deployment.
|
|
default: NONE
|
|
possibleValues:
|
|
- NONE
|
|
- Resume
|
|
- Abort
|
|
- Retry
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: mode
|
|
type: string
|
|
description: "Controls if there is a standard deployment or a blue green deployment. Values: 'DEPLOY', 'BG_DEPLOY'"
|
|
default: DEPLOY
|
|
possibleValues:
|
|
- NONE
|
|
- DEPLOY
|
|
- BG_DEPLOY
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
- name: operationId
|
|
type: string
|
|
description: The operation ID. Used in case of bg-deploy in order to resume or abort a previously started deployment.
|
|
default:
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
resourceRef:
|
|
- name: commonPipelineEnvironment
|
|
param: operationId
|
|
- name: apiUrl
|
|
type: string
|
|
description: The api url (e.g. https://example.org:12345
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
- name: username
|
|
aliases:
|
|
- name: user
|
|
deprecated: true
|
|
type: string
|
|
description: Username
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
secret: true
|
|
mandatory: true
|
|
resourceRef:
|
|
- name: credentialsId
|
|
type: secret
|
|
param: username
|
|
- name: password
|
|
type: string
|
|
description: Password
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
secret: true
|
|
mandatory: true
|
|
resourceRef:
|
|
- name: credentialsId
|
|
type: secret
|
|
param: password
|
|
- name: org
|
|
type: string
|
|
description: The org
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
- name: space
|
|
type: string
|
|
description: The space
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
- name: loginOpts
|
|
type: string
|
|
description: Additional options appended to the login command. Only needed for sophisticated cases. When provided it is the duty of the provider to ensure proper quoting / escaping.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
- name: xsSessionFile
|
|
type: string
|
|
description: The file keeping the xs session.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
outputs:
|
|
resources:
|
|
- name: commonPipelineEnvironment
|
|
type: piperEnvironment
|
|
params:
|
|
- name: operationId
|
|
containers:
|
|
- name: xs
|
|
image: ppiper/xs-cli
|