Introduction
Rundeck is a powerful automation and orchestration platform that enables system administrators and DevOps teams to automate routine operational tasks across servers and environments. As organizations grow, there is often a need to migrate jobs between projects, replicate automation workflows across environments, or move jobs from one Rundeck server to another.
To simplify this process, Rundeck provides built-in functionality to export and import job definitions in XML and YAML formats. This feature allows administrators to back up jobs, migrate automation workflows between projects, clone jobs across environments, and maintain consistency across multiple Rundeck installations.
In this article, we will walk through the process of exporting a job from an existing Rundeck project and importing it into another project or server.
Why Export and Import Rundeck Jobs?
Exporting and importing jobs is useful in several scenarios:
- Migrating jobs between Rundeck servers
- Moving jobs between projects
- Creating job backups
- Replicating automation workflows
- Deploying standardized jobs across environments
- Recovering jobs after accidental deletion
Rundeck supports exporting job definitions in:
- XML format
- YAML format
Both formats contain the job configuration, workflow steps, options, schedules, notifications, and other associated settings.
Step 1: Export a Job from the Source Project
Log in to the existing Rundeck server.
Navigate to:
Project → JobsLocate the job that needs to be migrated.
From the job actions menu, select:
Download Job Definition in XMLor
Download Job Definition in YAMLThe job definition file will be downloaded to your local system.
This file contains all the information required to recreate the job on another Rundeck project or server.
Step 2: Open the Destination Project
Log in to the target Rundeck server or project.
Navigate to:
Rundeck → Select Project → Job Actions → Upload Definition
This option allows you to upload previously exported job definitions.
Step 3: Upload the Job Definition
Select the downloaded file.
Choose the appropriate format:
For XML files
XML Format
For YAML files
YAML Format
Ensure the selected format matches the exported file type.
Step 4: Configure Import Options
During the import process, Rundeck provides several options that determine how the job will be created.
Update Existing Job
Select:
Update Existing Job
if you want the imported job to overwrite an existing job with the same UUID.
Create a New Job
Select:
Always Create a New Job
if you want Rundeck to create a separate job instead of replacing an existing one.
This is useful when cloning jobs or testing modifications.
Understanding UUID Options
Every Rundeck job is assigned a unique identifier known as a UUID.
The UUID helps Rundeck distinguish one job from another.
Preserve UUID
Choose:
Preserve UUID
when importing jobs to a different Rundeck server.
This maintains the original job identity and is recommended for migrations.
Remove UUIDs
Choose:
Remove UUIDs
when importing jobs into the same Rundeck server.
Rundeck will generate a new UUID for the imported job and prevent conflicts with existing jobs.
Step 5: Import the Job
After selecting the desired options:
- Verify the file format.
- Verify UUID handling.
- Confirm overwrite or create-new behavior.
- Click:
Upload
Rundeck will process the job definition and create the job in the selected project.
Once completed, the imported job will appear in the job list and can be executed immediately.
Best Practices
When migrating jobs between environments:
- Export a backup before making changes.
- Use YAML for easier version control and readability.
- Preserve UUIDs when migrating to another server.
- Remove UUIDs when cloning jobs on the same server.
- Verify node filters and credentials after importing.
- Test imported jobs before using them in production.
Conclusion
Exporting and importing Rundeck jobs is a simple yet powerful feature that helps administrators migrate automation workflows between projects and servers with minimal effort. By leveraging XML or YAML job definitions, organizations can standardize automation processes, maintain backups, and efficiently deploy jobs across multiple environments. Understanding UUID handling and import options ensures smooth migrations while avoiding job conflicts and configuration issues.
Frequently Asked Questions (FAQ)
1. Which format should I use: XML or YAML?
Both formats are supported by Rundeck.
- XML is commonly used for traditional exports.
- YAML is more human-readable and easier to maintain in version control systems such as Git.
For DevOps workflows, YAML is generally preferred.
2. What happens if I preserve the UUID while importing into the same server?
If a job with the same UUID already exists, Rundeck may overwrite the existing job or generate conflicts depending on the selected import options.
For importing duplicate jobs into the same server, it is recommended to remove UUIDs.
3. Can I export and import multiple jobs at once?
Yes. Rundeck allows exporting multiple jobs and entire project job definitions. This is useful when migrating complete automation environments between servers.
Related Articles
- How to Reset the SA User Password of a Microsoft SQL Server Instance on a Windows Server with Plesk
Learn how to recover and reset SQL Server administrator credentials in a Windows hosting environment.
https://pheonixsolutions.com/blog/how-to-reset-the-sa-user-password-of-a-microsoft-sql-server-instance-on-a-windows-server-with-plesk/ - How to Install and Configure NSClient++ to Monitor Windows Servers Using Nagios
Monitor Windows servers effectively by integrating NSClient++ with Nagios.
https://pheonixsolutions.com/blog/how-to-install-and-configure-nsclient-to-monitor-the-windows-server-on-nagios/ - How to Change the Backup Location in Plesk for Windows Server
Learn how to relocate backup storage and optimize disk space management in Plesk.
https://pheonixsolutions.com/blog/how-to-change-the-location-for-backup-files-in-plesk-for-windows-server/