The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
openshiftBuild
: Trigger OpenShift BuildopenshiftCreateResource
: Create OpenShift Resource(s)openshiftDeleteResourceByJsonYaml
: Delete OpenShift Resource(s) from JSON or YAMLopenshiftDeleteResourceByKey
: Delete OpenShift Resource(s) by KeyopenshiftDeleteResourceByLabels
: Delete OpenShift Resource(s) using LabelsopenshiftDeploy
: Trigger OpenShift DeploymentopenshiftExec
: OpenShift ExecopenshiftImageStream
: OpenShift ImageStreamsopenshiftScale
: Scale OpenShift DeploymentopenshiftTag
: Tag OpenShift ImageopenshiftVerifyBuild
: Verify OpenShift BuildopenshiftVerifyDeployment
: Verify OpenShift DeploymentopenshiftVerifyService
: Verify OpenShift Servicestep([$class: 'OpenShiftBuildCanceller'])
: Cancel OpenShift Buildsstep([$class: 'OpenShiftDeployCanceller'])
: Cancel OpenShift Deploymentstep([$class: 'OpenShiftScalerPostAction'])
: Scale OpenShift Deploymentstep([$class: 'OpenShiftBuildVerifier'])
: Verify OpenShift Buildstep([$class: 'OpenShiftBuilder'])
: Trigger OpenShift Buildstep([$class: 'OpenShiftCreator'])
: Create OpenShift Resource(s)step([$class: 'OpenShiftDeleterJsonYaml'])
: Delete OpenShift Resource(s) from JSON or YAMLstep([$class: 'OpenShiftDeleterLabels'])
: Delete OpenShift Resource(s) using Labelsstep([$class: 'OpenShiftDeleterList'])
: Delete OpenShift Resource(s) by Keystep([$class: 'OpenShiftDeployer'])
: Trigger OpenShift Deploymentstep([$class: 'OpenShiftDeploymentVerifier'])
: Verify OpenShift Deploymentstep([$class: 'OpenShiftExec'])
: OpenShift Execstep([$class: 'OpenShiftImageTagger'])
: Tag OpenShift Imagestep([$class: 'OpenShiftScaler'])
: Scale OpenShift Deploymentstep([$class: 'OpenShiftServiceVerifier'])
: Verify OpenShift ServiceopenshiftVerifyBuild
: Verify OpenShift BuildopenshiftBuild
: Trigger OpenShift BuildopenshiftCreateResource
: Create OpenShift Resource(s)openshiftDeleteResourceByJsonYaml
: Delete OpenShift Resource(s) from JSON or YAMLopenshiftDeleteResourceByLabels
: Delete OpenShift Resource(s) using LabelsopenshiftDeleteResourceByKey
: Delete OpenShift Resource(s) by KeyopenshiftDeploy
: Trigger OpenShift DeploymentopenshiftVerifyDeployment
: Verify OpenShift DeploymentopenshiftExec
: OpenShift ExecopenshiftTag
: Tag OpenShift ImageopenshiftScale
: Scale OpenShift DeploymentopenshiftVerifyService
: Verify OpenShift ServiceopenshiftBuild
: Trigger OpenShift BuildbldCfg
String
apiURL
(optional)
String
authToken
(optional)
String
buildName
(optional)
String
checkForTriggeredDeployments
(optional)
String
commitID
(optional)
String
env
(optional)
name
String
value
String
namespace
(optional)
String
showBuildLogs
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftCreateResource
: Create OpenShift Resource(s)jsonyaml
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeleteResourceByJsonYaml
: Delete OpenShift Resource(s) from JSON or YAMLjsonyaml
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeleteResourceByKey
: Delete OpenShift Resource(s) by Keytypes
String
keys
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeleteResourceByLabels
: Delete OpenShift Resource(s) using Labelstypes
String
keys
String
values
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeploy
: Trigger OpenShift DeploymentdepCfg
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftExec
: OpenShift Execpod
String
apiURL
(optional)
String
arguments
(optional)
value
String
authToken
(optional)
String
command
(optional)
String
container
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftImageStream
: OpenShift ImageStreamsname
(optional)
String
tag
(optional)
String
namespace
(optional)
String
apiURL
(optional)
String
authToken
(optional)
String
changelog
(optional)
If 'Include in changelog' is enabled for an SCM source, then when a build occurs, the changes from that SCM source will be included in the changelog.
If 'Include in changelog' is disabled, then when a build occurs, the changes from this SCM source will not be included in the changelog.
boolean
poll
(optional)
If 'Include in polling' is enabled or 'Include in changelog' is enabled, then when polling occurs, the job will be started if changes are detected from this SCM source.
If 'Include in polling' is disabled and 'Include in changelog' is disabled, then when polling occurs, changes that are detected from this repository will be ignored.
boolean
verbose
(optional)
String
openshiftScale
: Scale OpenShift DeploymentdepCfg
String
replicaCount
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
verifyReplicaCount
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftTag
: Tag OpenShift ImagesrcStream
String
srcTag
String
destStream
String
destTag
String
alias
(optional)
String
apiURL
(optional)
String
authToken
(optional)
String
destinationAuthToken
(optional)
String
destinationNamespace
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftVerifyBuild
: Verify OpenShift BuildbldCfg
String
apiURL
(optional)
String
authToken
(optional)
String
checkForTriggeredDeployments
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftVerifyDeployment
: Verify OpenShift DeploymentdepCfg
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
replicaCount
(optional)
String
verbose
(optional)
String
verifyReplicaCount
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftVerifyService
: Verify OpenShift ServicesvcName
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
retryCount
(optional)
String
verbose
(optional)
String
step([$class: 'OpenShiftBuildCanceller'])
: Cancel OpenShift BuildsapiURL
String
namespace
String
authToken
String
verbose
String
bldCfg
String
step([$class: 'OpenShiftDeployCanceller'])
: Cancel OpenShift DeploymentapiURL
String
depCfg
String
namespace
String
authToken
String
verbose
String
step([$class: 'OpenShiftScalerPostAction'])
: Scale OpenShift DeploymentapiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftBuildVerifier'])
: Verify OpenShift BuildapiURL
String
bldCfg
String
namespace
String
authToken
String
verbose
String
checkForTriggeredDeployments
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftBuilder'])
: Trigger OpenShift BuildapiURL
String
bldCfg
String
namespace
String
env
name
String
value
String
authToken
String
verbose
String
commitID
String
buildName
String
showBuildLogs
String
checkForTriggeredDeployments
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftCreator'])
: Create OpenShift Resource(s)apiURL
String
namespace
String
authToken
String
verbose
String
jsonyaml
String
step([$class: 'OpenShiftDeleterJsonYaml'])
: Delete OpenShift Resource(s) from JSON or YAMLapiURL
String
namespace
String
authToken
String
verbose
String
jsonyaml
String
step([$class: 'OpenShiftDeleterLabels'])
: Delete OpenShift Resource(s) using LabelsapiURL
String
namespace
String
authToken
String
verbose
String
types
String
keys
String
values
String
step([$class: 'OpenShiftDeleterList'])
: Delete OpenShift Resource(s) by KeyapiURL
String
namespace
String
authToken
String
verbose
String
types
String
keys
String
step([$class: 'OpenShiftDeployer'])
: Trigger OpenShift DeploymentapiURL
String
depCfg
String
namespace
String
authToken
String
verbose
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftDeploymentVerifier'])
: Verify OpenShift DeploymentapiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftExec'])
: OpenShift ExecapiURL
String
namespace
String
authToken
String
verbose
String
pod
String
container
String
command
String
arguments
value
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftImageTagger'])
: Tag OpenShift ImageapiURL
String
testTag
String
prodTag
String
namespace
String
authToken
String
verbose
String
testStream
String
prodStream
String
destinationNamespace
String
destinationAuthToken
String
alias
String
step([$class: 'OpenShiftScaler'])
: Scale OpenShift DeploymentapiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
step([$class: 'OpenShiftServiceVerifier'])
: Verify OpenShift ServiceapiURL
String
svcName
String
namespace
String
authToken
String
verbose
String
openshiftVerifyBuild
: Verify OpenShift BuildbldCfg
String
apiURL
(optional)
String
authToken
(optional)
String
checkForTriggeredDeployments
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftBuild
: Trigger OpenShift BuildbldCfg
String
apiURL
(optional)
String
authToken
(optional)
String
buildName
(optional)
String
checkForTriggeredDeployments
(optional)
String
commitID
(optional)
String
env
(optional)
name
String
value
String
namespace
(optional)
String
showBuildLogs
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftCreateResource
: Create OpenShift Resource(s)jsonyaml
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeleteResourceByJsonYaml
: Delete OpenShift Resource(s) from JSON or YAMLjsonyaml
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeleteResourceByLabels
: Delete OpenShift Resource(s) using Labelstypes
String
keys
String
values
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeleteResourceByKey
: Delete OpenShift Resource(s) by Keytypes
String
keys
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftDeploy
: Trigger OpenShift DeploymentdepCfg
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftVerifyDeployment
: Verify OpenShift DeploymentdepCfg
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
replicaCount
(optional)
String
verbose
(optional)
String
verifyReplicaCount
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftExec
: OpenShift Execpod
String
apiURL
(optional)
String
arguments
(optional)
value
String
authToken
(optional)
String
command
(optional)
String
container
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftTag
: Tag OpenShift ImagesrcStream
String
srcTag
String
destStream
String
destTag
String
alias
(optional)
String
apiURL
(optional)
String
authToken
(optional)
String
destinationAuthToken
(optional)
String
destinationNamespace
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
openshiftScale
: Scale OpenShift DeploymentdepCfg
String
replicaCount
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
verbose
(optional)
String
verifyReplicaCount
(optional)
String
waitTime
(optional)
String
waitUnit
(optional)
String
openshiftVerifyService
: Verify OpenShift ServicesvcName
String
apiURL
(optional)
String
authToken
(optional)
String
namespace
(optional)
String
retryCount
(optional)
String
verbose
(optional)
String
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.