User Guide Overview
User Guide Overview
This User Guide provides comprehensive information for automation authors and users of Rundeck and Runbook Automation.
For information about installing and administering Rundeck, see the Administration Guide.
Projects
Create and manage projects, configure SCM integration, set up resource model sources, and configure node execution methods. Projects are the foundation for organizing your automation work.
Jobs
Create and manage automation jobs with workflows, options, notifications, and hundreds of plugin integrations. Jobs are the core automation units in Rundeck.
Plugins
Explore Rundeck's extensive plugin ecosystem including integrations with AWS, Azure, GCP, Kubernetes, Datadog, Jira, PagerDuty, ServiceNow, and many more platforms.
Nodes
Manage your infrastructure nodes, configure node filters, set up health checks, and use node enhancers to enrich node data.
Key Storage
Securely store and manage passwords, private keys, and other sensitive data using Rundeck's built-in key storage or integrations with AWS Secrets Manager, Azure Key Vault, HashiCorp Vault, CyberArk, and Delinea.
Commands
Execute ad-hoc commands across your nodes directly from the Rundeck interface.
Activity
Monitor job executions, view execution history, and analyze automation activity across your projects.
Schedules (Commercial)
Manage project-level schedules and configure job scheduling policies for Rundeck Enterprise and Process Automation.
Calendars (Commercial)
Define blackout windows and maintenance calendars to control when jobs can execute in Rundeck Enterprise and Process Automation.
Webhooks
Configure incoming webhooks to trigger jobs from external systems like GitHub, PagerDuty, Datadog, AWS SNS, and more.
Project Settings
Configure project-level settings including defaults, integrations, and behavior.
System Menu
Access system-wide configurations, user management, and system reports.
Profile Menu
Manage your user profile, preferences, and personal settings.
Integrations
Connect Rundeck with external platforms and services for enhanced automation workflows.
Document Formats
Reference documentation for Rundeck's file formats including ACL policies, job definitions, and resource models.