Links Moved

This document provides the new location of moved links.

Introduction

What Is This Guide About

What Is Rundeck

Who Makes The Rundeck Software

Getting Help

Rundeck From 30000 Feet

Rundeck Features

Rundeck In Context

Rundeck Architecture

Feedback

Whats Next

Getting Started

Rundeck Basics

Command Dispatching

Resource Model

Authorization

Project

Installing Rundeck

System Requirements

Java

Network Access

Installing From Source

Installing With Rpm

Installing With Launcher

Launcher Options

System Properties

Upgrading Rundeck

First Time Setup

Logins

Group Membership

Summary

Rundeck Basics

Rundeck Interfaces

Graphical Console

Now Running

Shell Tools

Project Setup

Resource Model

Resource Model Document Formats

Pluggable Resource Model Sources

Command Execution

Dispatcher Options

Filtering Nodes Graphically

Filtering Nodes In The Shell

Ad Hoc Commands

Shell Tool Command Execution

Graphical Command Shell Execution

Following Execution Output

Separate Execution Follow Page

Controlling Command Execution

Queuing Commands To Rundeck

Tracking Execution

Plugins

Ssh Plugin

Included Plugins

History

Filtering Event History

Event View

Tips And Tricks

Saving Filters

Auto Completion

Summary

Jobs

Job Groups

Job Uuids

Listing And Filtering Jobs

Filtering Jobs

Viewing Job Detail

Running A Job

Choose Execution Options

Following Running Jobs

Creating Jobs

Temporary Jobs

Saved Jobs

Simple Saved Job

Node Dispatching And Filtering

Dynamic Node Filters

Scheduled Jobs

Job Notifications

Job History

Killing Jobs

Deleting Jobs

Updating And Copying Jobs

Exporting Job Definitions

Importing Job Definitions

Summary

Job Workflows

Workflow Definition

Workflow Control Settings

Workflow Steps

Command Step

Script Step

Script File Step

Job Reference Step

Reordering Steps

Save The Changes

Summary

Job Options

Prompting The User

Secure Options

Options Editor

Defining An Option

Remote Option Values

Script Usage

Calling A Job With Options

Summary

Rundeck By Example

Acme Anvils

Rundeck Set Up

Tag Classification And Command Dispatching

Jobs

Job Structure

Job Grouping

Job Option

Allowed Values

Script Access To Option Data

Job Workflow Composition

Running The Job

Job Access Control

Resource Model Source Examples

Resource Editor Examples

Option Model Provider Examples

Administration

Startup And Shutdown

Rpm

Setting Java_home

Launcher

Configuration

Configuration Layout

Rpm Layout

Launcher Layout

Configuration Files

Admin.Aclpolicy

Framework.Properties

Log4j.Properties

Profile

Project.Properties

Jaas Loginmodule.Conf

Realm.Properties

Rundeck Config.Properties

Notification Email Settings

Gui Admin Page

System Information Page

User Profiles Page

Project Configuration

Resource Model Sources Configuration

File Resource Model Source

Directory Resource Model Source

Script Resource Model Source

Url Resource Model Source

Default Node Executor Configuration

Default File Copier Configuration

Logs

Backup And Recovery

Recovery

Relational Database

Enable Rdbsupport

Customize The Datasource

Add The Jdbc Driver

Ssh

Ssh Configuration Requirements

Ssh Key Generation

Configuring Remote Machine For Ssh

Passing Environment Variables Through Remote Command

Managing Logins

Realm.Properties

Active Directory

Communicating Over Secure Ldap Ldaps:

Redundant Connection Options

Authorization

Access Control Policy

Specific Resources And Resource Types

Special Api Token Authentication Group

Rundeck Resource Authorizations

Application Scope Resources And Actions

Project Scope Resources And Actions

Node Resource Properties

Access Control Policy Actions Example

Troubleshooting Access Control Policy

Authorization Caveats

Configuring Rundeck For Ssl

Securing Passwords

Troubleshooting Keystore

Optional Pem Export

Customizing Rundeck Gui

Customizing Configuration For Scale

File Descriptors

Java Heap Size

Quartz Job Threadcount

Jmx Instrumentation

Resource Model Source

Requirements

Configuration

Implementations And Examples

Simple Vcs Url Resource Model Source

Amazon Ec2 Nodes

Third Party Url Resource Model Sources

Option Model Provider

Requirements

Configuration

Json Format

Variable Expansion In Remote Urls

Remote Request Failures

Implementations And Examples

Hudson Artifacts Option Provider

Yum Repoquery Option Model Provider

Resource Editor

Definition

Using Properties

Using Remoteurl

Streamlining The Interface

Examples

Simple Site Integration

Webhooks

Execution Notification Content

Execution Notification Headers

Execution Notification Url Token Expansion

Rundeck Api

Rundeck Plugins

Installing Plugins

Uninstalling Or Updating Plugins

About Plugins

Types Of Plugins

Node Execution Plugins

Resource Model Source Plugins

Resource Format Plugins

About Services And Providers

Using Providers

Node Execution Services

Node Specific

Project Or Framework Scope

Resource Model Sources

Resource Model Source Configuration

Resource Format Generators And Parsers

When Node Execution Service Providers Are Invoked

Built In Providers

Node Execution Services

Ssh Provider

Configuring Scp File Copier

Configuring Ssh Authentication Type

Configuring Ssh Username

Configuring Ssh Private Keys

Configuring Ssh Password Authentication

Configuring Secondary Sudo Password Authentication

Resource Model Sources

File Resource Model Source Configuration

Url Resource Model Source Configuration

Directory Resource Model Source Configuration

Script Resource Model Source Configuration

Resource Format Services

Pre Installed Plugins

Script Plugin

Configuring Script Exec

Configuring The Command For Script Exec

Configuring The Working Directory

Configuring The Shell

Defining The Script Exec Command

Requirements For The Script Exec Command

Configuring Script Copy

Configuring The Command For Script Copy

Configuring The Working Directory

Configuring The Shell

Configuring The Remote Filepath

Defining The Script Copy Command

Defining The Script Copy Filepath

Requirements Of Script Copy Command

Example Scripts

Stub Plugin

Plugin Development

Java Plugin Development

Provider Classes

Jar Dependencies

Available Services:

Provider Lifecycle

Node Executor Providers

File Copier Providers

Resource Model Source Providers

Resource Format Parser And Generator Providers

Script Plugin Development

Provider Metadata

Configurable Resource Model Source Script Plugin

How Script Plugin Providers Are Invoked

Script Provider Requirements