Skip to content

spinnakerTriggerPipeline

Description

Triggers a Spinnaker pipeline from a Jenkins pipeline. Spinnaker is for example used for Continuous Deployment scenarios to various Clouds.

Parameters

name mandatory default possible values
script yes
spinnaker/application yes
spinnaker/certFileCredentialsId no
spinnaker/gateUrl yes
spinnaker/keyFileCredentialsId no
spinnaker/pipelineNameOrId yes
spinnaker/pipelineParameters no
timeout no 60
verbose no true, false
  • script - 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.
  • spinnaker/application -
  • spinnaker/certFileCredentialsId - Defines the id of the file credentials in your Jenkins credentials store which contain the client certificate file for Spinnaker authentication.
  • spinnaker/gateUrl - Defines the url of the Spinnaker Gateway Service as API endpoint for communication with Spinnaker.
  • spinnaker/keyFileCredentialsId - Defines the id of the file credentials in your Jenkins credentials store which contain the private key file for Spinnaker authentication.
  • spinnaker/pipelineNameOrId - Defines the name/id of the Spinnaker pipeline.
  • spinnaker/pipelineParameters - Parameter map containing Spinnaker pipeline parameters.
  • timeout - Defines the timeout in minutes for checking the Spinnaker pipeline result. By setting to 0 the check can be de-activated.
  • verbose - Whether verbose output should be produced.

Step configuration

We recommend to define values of step parameters via config.yml file.

In following sections of the config.yml the configuration is possible:

parameter general step/stage
script
spinnaker/application X X
spinnaker/certFileCredentialsId X X
spinnaker/gateUrl X X
spinnaker/keyFileCredentialsId X X
spinnaker/pipelineNameOrId X X
spinnaker/pipelineParameters X X
timeout X
verbose X X

Dependencies

The step depends on the following Jenkins plugins

Transitive dependencies are omitted.

The list might be incomplete.

Consider using the ppiper/jenkins-master docker image. This images comes with preinstalled plugins.