JenkinsJobTriggerOperator

Jenkins

Trigger a Jenkins Job and monitor it’s execution. This operator depend on python-jenkins library, version >= 0.4.15 to communicate with jenkins server. You’ll also need to configure a Jenkins connection in the connections screen.

View on GitHub

Last Updated: Oct. 26, 2022

Access Instructions

Install the Jenkins provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

jenkins_connection_idRequiredThe jenkins connection to use for this job
job_nameRequiredThe name of the job to trigger
parametersThe parameters block provided to jenkins for use in the API call when triggering a build. (templated)
sleep_timeHow long will the operator sleep between each status request for the job (min 1, default 10)
max_try_before_job_appearsThe maximum number of requests to make while waiting for the job to appears on jenkins server (default 10)
allowed_jenkins_statesIterable of allowed result jenkins states, default is ['SUCCESS']

Documentation

Trigger a Jenkins Job and monitor it’s execution. This operator depend on python-jenkins library, version >= 0.4.15 to communicate with jenkins server. You’ll also need to configure a Jenkins connection in the connections screen.

Was this page helpful?