This repository serves as a comprehensive knowledge base for developing Rundeck plugins.
These examples are designed to help you understand, edit, and build plugins for testing purposes.
The repository contains the following example plugins:
- Example Step Plugins: Demonstrates step plugins written in Groovy, including workflow and node step plugins.
- Example Notification Plugins: Includes examples for sending notifications, such as email and shell script-based notifications.
- Example Log Plugins: Provides examples for custom log handling.
- Example Step Plugins: Demonstrates step plugins written in Java, including node step and remote script node step plugins.
- Example Notification Plugin: An example notification plugin written in Java.
- Example Audit Plugin: Captures auditing events from the Rundeck application.
- Example Execution Lifecycle Plugin: Demonstrates execution lifecycle hooks for Rundeck jobs.
- Example Storage Plugins: Examples for custom storage backends.
- Example Script Node Step Plugin: A script-based node step plugin.
- Example Script Remote Node Step Plugin: A script-based remote node step plugin.
- JSON Plugin: Provides JSON format support for resource definitions, including a parser and generator.
Each plugin includes build instructions in its respective README.md. Most plugins use Gradle or Maven for building. For example:
./gradlew buildThe resulting .jar or .zip file can be found in the build/libs directory.
To install a plugin:
- Copy the built plugin file (e.g., .jar or .zip) to the $RDECK_BASE/libext directory of your Rundeck server.
- Alternatively, upload the plugin via the Rundeck GUI under Plugins > Upload Plugin.
Refer to the individual plugin README.md files for usage instructions and configuration details.
Each example is a real, buildable Gradle or Maven project, and each is scanned by Snyk through the org-wide security workflow. Because these examples are meant to be copied as starting points, they aim to model current, patched dependency versions: reported vulnerabilities are fixed (by upgrading or overriding the affected dependency) rather than suppressed. See SECURITY.md for how findings are handled.
We welcome contributions to improve these examples or add new ones. Please follow these steps:
- Fork the repository.
- Create a feature branch.
- Submit a pull request with a detailed description of your changes.
Historically, example plugin code was located in the examples folder of the Rundeck project. This repository aims to modernize and align those examples with the latest guidelines. Check back regularly for updates.
This repository is licensed under the Apache License 2.0.