Skip to main content

Project Settings


Project Settings

Each Rundeck Project has it's own unique Configuration Page which contains lets you view and manage project settings.

Edit Configuration...

Use this section to edit Project Settings like the name, various defaults and enable job execution project wide.

Details

Edit the Project Name and Description.

Execution History Clean

When enabled this setting will clean out old executions to help keep your data clean.

Execution History Clean
Execution History Clean

Execution Mode

Used to manage job execution and schedule configuration at project level. If there is a need to disable all job executions for this project, or disabled all scheduled jobs (but still run manually) use the check boxes in this section.

User Interface

Additional configuration for the user interface for this project that can show or hide helpful information for project users.

User Interface
User Interface

Default Node Executor Configuration

When Rundeck executes a command on a node, it does so via a "Node Executor". The most common built-in Node Executor is the "SSH" implementation, which uses SSH to connect to the remote node, however other implementations can be used.

Select the Default Node Executor you wish to use for all remote Nodes for the project:

Default Node Executor Choice
Default Node Executor Choice

You can install more types of Node Executors as plugins, see Node Execution Plugins.

Tips

When using SSH node executor and SCP file copier, the properties will be shared between the file copier and the node executor, so any change made for the node executor will affect the file copier and vice versa. If a more specific configuration is required, this can be done directly in the node definition.

Default File Copier Configuration

When Rundeck executes a script on a node, it does so by first copying the script as a file to the node, via a "File Copier". (It then uses a "Node Executor" to execute the script like a command.)

The most common built-in File Copier is the "SCP" implementation, which uses SCP to copy the file to the remote node, however other implementations can be used.

Select the Default File Copier you wish to use for all remote Nodes for the project:

Default File Copier Choice
Default File Copier Choice

You can install more types of File Copiers as plugins, see Node Execution Plugins.

Tips

When using SCP file copier and SSH node executor, the properties will be shared between the file copier and the node executor, so any change made for the file copier will affect the node executor and vice versa. If a more specific configuration is required, this can be done directly in the node definition.

Edit Nodes...

This section lets you add and modify Node Resource Model Sources for the project. These sources contain the node definitions for the project. A default source will be defined listing the Rundeck Host as a node as a result of the initial project creation. You can configure additional Node Sources to gather all the node information relevant to this project.

See Node Sourcesopen in new window for more details.

Node Enhancers

Take advantage of the node enhancers that Rundeck offers by adding them to your nodes. See Node Enhancers for more details.

Access Control

Control access to the project with ACL Policy GUIopen in new window (Enterprise) or Access Control Policyopen in new window files.

Edit Readme...

A project ReadMe can provide some important context for a Project. The content can be formatted using Markdown and can displayed on the Project's home page and as part of the Project Listing.

Edit Message of the Day...

The Message of the Day is a way to communicate important messages to Project users. The message can be dismissed or hidden after reading using the [x] in the upper right corner.

Message of the Day
Message of the Day

More info in the Projects Sectionopen in new window

Setup SCM...

More info in the Projects Section > SCMopen in new window

Export Archive...

Use this to export the Project to an Archive file for backup or migration purposes.

More info in the Projects Sectionopen in new window.

Import Archive...

Use this to import a Project archive file.

More info in the Projects Sectionopen in new window.

Delete Project...

Use this to delete the project. Note it will delete all associated jobs, node sources, etc.

Plugins Control

Plugins Control can be used to selectively enable/disable plugins available to this project.

More info in the Projects Sectionopen in new window.