Skip to main content

Use Rundeck Example Jobs

Use Rundeck Example Jobs


A good way to understand different problem solving approaches in Rundeck is by seeing how they’re implemented. The Community Welcome Projectopen in new window has a series of individual example jobsopen in new window that you can download, import into your Rundeck instance, adapt, and test. The example jobs are written to work with the Welcome Projects, but these steps can be used to import into any project.

The library of example jobs provides examples of job definitions for common use-cases and platform-focused runbooks to help show new users the power of runbook automation and make it easy for existing users to add new job definitions to their Rundeck. Rundeck uses exchangeable formats to share their jobs: XML or/and YAML, making it easy to store on any repository.

This guide covers:

  • How to test individual job definitions in the Community Welcome Project

Testing the Job Definitions on a Local Rundeck Instance

The job definitions are available to download here: in new window

Download the zip file from the repository:

  1. Navigate to in new window
  2. Click on the “latest” release in the right,
  3. Download the Source Code (.zip) file.
  4. Extract the contents to a folder on your local hard drive.

All runbook job definitions are located in the runbooks/yaml folder inside the main repository directory.

  1. Click on the Jobs page (left menu) of your Project.
  2. And click on the Upload a job definition button.

    Upload Definition

  3. Click on Browse to select any YAML file downloaded from the repository.

    Select Job Definition

  4. Scroll down and click on the Upload button.
  5. Now the job is imported. In the screenshot we chose to upload the Global Log Filter Usage example job.

    Definition Upload Success

  6. Run the job by clicking on the job name and then on Run Job Now

    Run Job Now

  7. Then, you can see the results.

    Job Results