Execute workflows across your existing automations
or quickly automate previously manual procedures.

Rundeck by PagerDuty is an open source runbook automation service with a web console, command line tools and a WebAPI. It lets you easily standardize tasks to improve operational quality by deploying automation across a set of nodes.

• Visit the Website

• Read the latest documentation

• Get help from the Community

• Install Rundeck

See the Release Notes for the latest version information.

How To Build:

Primary build is supported with gradle. More info in the wiki.

Requirements: Java 11, NodeJs 18

Cloudsmith Authentication Setup

For PagerDuty employees with Cloudsmith access

Export your Cloudsmith token before building:

export CLOUDSMITH_NPM_TOKEN=your-cloudsmith-token-here

For contributors without Cloudsmith access

1. Delete the .npmrc and package-lock.json files in the ui-trellis package:

rm rundeckapp/grails-spa/packages/ui-trellis/.npmrc rundeckapp/grails-spa/packages/ui-trellis/package-lock.json 

2. And the .npmrc and package-lock.json files in the _package-manager directory:

rm rundeckapp/grails-app/assets/javascripts/_package-manager/.npmrc rundeckapp/grails-app/assets/javascripts/_package-manager/package-lock.json

Build with Gradle

Produces: rundeckapp/build/libs/rundeck-X.Y.war

./gradlew build

Docker Build

Uses the war artifact and creates the rundeck/rundeck:SNAPSHOT docker image:

./gradlew :docker:officialBuild

• dockerTags adds additional tags on the image
• • Ex: -PdockerTags=local,local-RUN-123
• jreVersion=openjdk-17-jre-headless specifies the JRE version for the image
  • Ex: -PjreVersion=openjdk-17-jre-headless

Run UI Tests

Run jest unit tests for Core UI

CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" dev:test:unit

Watch UI Tests

Run jest unit tests for Core UI and watch for changes

CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" dev:test:watch

Build UI in Dev Mode

Build the core UI components in dev mode, which copies the artifacts immediately to the assets dir of the running application.

CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" dev

Run Storybook for UI

Run storybook for the core UI components.

CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" storybook

Documentation

Available online at https://docs.rundeck.com/docs

FAQ: https://github.com/rundeck/rundeck/wiki/FAQ

Development

Refer to the IDE Development Environment to get set up using IntelliJ IDEA or Eclipse/STS.

• Issue tracker at github.com

Do you have changes to contribute? Please see the Development wiki page.

License

Copyright 2024 PagerDuty, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.