OpenShift Pipeline Jenkins Plugin

openshiftBuild: Trigger OpenShift Build

bldCfg
If you run `oc get bc` for the project listed in "nameSpace", that is the value you want to put here.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

buildName (optional)
The value here is what you supply with the --from-build option when invoking the OpenShift `oc start-build` command. It allows you to point to OpenShift build to a previously run build, and run another build with exactly the same source and destination metadata. If you do not supply a value, the plugin will generate a new OpenShift build based on the Build Configuration referenced.

Type: String

checkForTriggeredDeployments (optional)
This flag is the toggle for turning on or off the verification that any deployments triggered by this build's output fired.

Type: String

commitID (optional)
The value here is what you supply with the --commit option when invoking the OpenShift `oc start-build` command. It allows you to point the OpenShift build to a specific commit hash from the git-log of the source repository. If you do not supply a value, the plugin assumes the latest version from the source repository should be used.

Type: String

env (optional)
Specify a list of environment variables to include in the build (see `oc start-build -e ...`).

Array/List

Nested Object

name
The name of the environment variable to set.

Type: String

value
The value for the environment variable.

Type: String

namespace (optional)

Type: String

showBuildLogs (optional)
Indicates whether the build logs get dumped to the console of the Jenkins build.

Type: String

verbose (optional)

Type: String

waitTime (optional)

Type: String

waitUnit (optional)

Type: String

openshiftCreateResource: Create OpenShift Resource(s)

jsonyaml
The JSON or YAML formatted text that conforms to the schema for defining the various OpenShift resources.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

openshiftDeleteResourceByJsonYaml: Delete OpenShift Resource(s) from JSON/YAML

jsonyaml
The JSON or YAML formatted text that conforms to the schema for defining the various OpenShift resources.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

openshiftDeleteResourceByKey: Delete OpenShift Resource(s) by Key

types
The comma separated list of types of API objects to delete. See https://docs.openshift.org/latest/rest_api/index.html for the supported types.

Type: String

keys
The comma separated list of keys of the API objects to delete.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

openshiftDeleteResourceByLabels: Delete OpenShift Resource(s) using Labels

types
The comma separated list of types of API objects to delete, where those objects have labels corresponding to the specified key/value pairs. See https://docs.openshift.org/latest/rest_api/index.html for the supported types.

Type: String

keys
The comma separated list of keys of the labels in the API objects to delete.

Type: String

values
The comma separated list of values of the labels in the API objects to delete.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

openshiftDeploy: Trigger OpenShift Deployment

depCfg
If you run `oc get dc` for the project listed in "nameSpace", that is the value you want to put here.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

waitTime (optional)

Type: String

waitUnit (optional)

Type: String

openshiftExec: OpenShift Exec

pod
The pod in which to execute a command.

Type: String

apiURL (optional)

Type: String

arguments (optional)
Specify a list of arguments to pass to the command.

Array/List

Nested Object

value
The value for the environment variable.

Type: String

authToken (optional)

Type: String

command (optional)
The name of the command to execute.

Type: String

container (optional)
The container in which to execute a command. If not specified, the first container in the pod will be used.

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

waitTime (optional)

Type: String

waitUnit (optional)

Type: String

openshiftImageStream: OpenShift ImageStreams

name (optional)
The name of the ImageStream is what shows up in the NAME column if you dump all the ImageStream's with the `oc get is` command invocation.

Type: String

tag (optional)
The specific image tag within the ImageStream to monitor.

Type: String

namespace (optional)

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

changelog (optional)

Type: boolean

poll (optional)

Type: boolean

verbose (optional)

Type: String

openshiftScale: Scale OpenShift Deployment

depCfg
If you run `oc get dc` for the project listed in "nameSpace", that is the value you want to put here.

Type: String

replicaCount
The value here should be the number of started pods desired for the deployment specified. It is the equivalent of the value supplied to --replicas with an `oc scale` command invocation. This is a required parameter. If an integer is not specified here, this build step can not be added to the job. Note: specifying a 0 is allowed, and means you do not want any pods for the specified deployment config running.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

verifyReplicaCount (optional)
This flag is the toggle for turning on or off the verification that the specified replica count for the deployment has been reached.

Type: String

waitTime (optional)

Type: String

waitUnit (optional)

Type: String

openshiftTag: Tag OpenShift Image

srcStream
The name of the ImageStream for the existing tag.

Type: String

srcTag
The name of the existing tag, or an actual, existing image ID. The image referenced will have the new tag applied to it.

Type: String

destStream
One or more ImageStream names in a comma delimited list. If multiple streams and multiple destination tags are specified, the two lists must contain the same number of elements.

Type: String

destTag
One or more tag names in a comma delimited list. If multiple streams and multiple destination tags are specified, the two lists must contain the same number of elements.

Type: String

alias (optional)
This flag is the equivalent of the `--alias` option for the `oc tag` command. When false, the destination tag type is "ImageStreamImage", and when true, the destination tag type is "ImageStreamTag".

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

destinationAuthToken (optional)
The value here is what you supply with the --token option when invoking the OpenShift `oc` command. If you do not supply a value, the plugin will assume it is running in the OpenShift Jenkins image and attempt to load the kubernetes service account token stored in that image.

Type: String

destinationNamespace (optional)
The value here should match the value from the output from `oc project` if you created the resources related to this task from the command line. If nothing is specified, the plugin will inspect the PROJECT_NAME environment variable.

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

openshiftVerifyBuild: Verify OpenShift Build

bldCfg
If you run `oc get bc` for the project listed in "nameSpace", that is the value you want to put here.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

checkForTriggeredDeployments (optional)
This flag is the toggle for turning on or off the verification that any deployments triggered by this build's output fired.

Type: String

namespace (optional)

Type: String

verbose (optional)

Type: String

waitTime (optional)

Type: String

waitUnit (optional)

Type: String

openshiftVerifyDeployment: Verify OpenShift Deployment

depCfg
If you run `oc get dc` for the project listed in "nameSpace", that is the value you want to put here.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

replicaCount (optional)
This optional field's value represents the number expected running pods for the deployment for the DeploymentConfig specified. If no value is specified it will work the number of running pods against the desired replica count in the DeploymentConfig.

Type: String

verbose (optional)

Type: String

verifyReplicaCount (optional)
This flag is the toggle for turning on or off the verification that the specified replica count for the deployment has been reached.

Type: String

waitTime (optional)

Type: String

waitUnit (optional)

Type: String

openshiftVerifyService: Verify OpenShift Service

svcName
The equivalent to the name supplied to a `oc get service` command line invocation.

Type: String

apiURL (optional)

Type: String

authToken (optional)

Type: String

namespace (optional)

Type: String

retryCount (optional)

Type: String

verbose (optional)

Type: String