This plugin is a Notifier that will talk to a RunDeck instance (via its HTTP API) to schedule a job execution on RunDeck after a successful build on Jenkins.
Table of Contents
RunDeck is an open-source tool for automating tasks on multiple nodes, with both a CLI and a web-based interface. You can use it to deploy your application to multiple nodes/appserv easily. It has a concept of jobs and build similar to Jenkins.
You have 3 ways to use this plugin :
Note that you can combine those use-cases.
The goal is to have a 0-click deployment process : you commit a change, Jenkins picks it up, build, test and so on, and then triggers a job execution on RunDeck for deploying your application.
First, you need to configure your RunDeck instance on the main Jenkins configuration page :
As of Rundeck plugin version 3.0, you can specify an Authtoken instead of Login/Password. Additionally you can set the API version if you need to use a lower number than the latest version.
You can use the "Test Connection" button to make sure that Jenkins can talk to your RunDeck instance :
Then, for each Jenkins job, configure the target RunDeck job that should be executed, along with its options :
The goal is to continue the deployment pipeline after a successful deployment : RunDeck deploys your application, and triggers a build on Jenkins to run some integration tests (using Selenium for example).
Then, configure the "RunDeck Trigger" on your Jenkins jobs : activate it, and optionally filter the notifications from RunDeck.
If your Jenkins job is started by a RunDeck notification, you can access the data of the RunDeck notification as environment variables :
Using Jenkins as an Option provider for RunDeck is very easy, because you don't need to configure anything on the Jenkins side. You just need to point your RunDeck option "remote url" to one of the following url :
List all artifacts for a given project / build, with a reference to the absolute url of the artifact. Useful if you have multiple artifacts to deploy (one per architecture for example).
List all builds (versions) for a given project / artifact, with a reference to the absolute url of the artifact. Useful if you have only 1 main artifact, but want to easily re-deploy an older version of the artifact.
Note: Rundeck will call the url anonymously which means the Jenkins job should provide access to Discover and Read the job. See Matrix based security documentation: https://wiki.jenkins-ci.org/display/JENKINS/Matrix-based+security#Matrix-basedsecurity-Job
This plugin is not compatible with all versions of RunDeck
If you are using Plugin version 3.x and need to access an older Rundeck server, you can set the API version in the plugin settings.
You can find older versions of the plugin here : http://maven.jenkins-ci.org/content/repositories/releases/org/jenkins-ci/plugins/rundeck/
Skip to end of metadata Go to start of metadata