Configuration file layout differs between the RPM and Launcher installation methods.
/etc/rundeck
|-- admin.aclpolicy
|-- framework.properties
|-- log4j.properties
|-- profile
|-- project.properties
|-- jaas-loginmodule.conf
|-- log4j.properties
|-- realm.properties
|-- rundeck-config.properties
`-- ssl
|-- ssl.properties
|-- keystore (not packaged)
`-- truststore (not packaged)
$RDECK_BASE/etc
|-- admin.aclpolicy
|-- framework.properties
|-- log4j.properties
|-- profile
`-- project.properties
$RDECK_BASE/server/config
|-- jaas-loginmodule.conf
|-- realm.properties
`-- rundeck-config.properties
Configuration is specified in a number of standard Rundeck configuration files generated during the installation process.
The purpose of each configuration file is described in its own section.
Administrator access control policy defined with a [aclpolicy] document.
This file governs the access for the "admin" group and role.
See role based access control for information about setting up policy files for other user groups.
Configuration file used by shell tools and core Rundeck services. This file will be created for you at install time.
Some important settings:
framework.server.hostname: Hostname of the Rundeck server nodeframework.server.name: Name (identity) of the Rundeck server nodeframework.projects.dir: Path to the directory containing Rundeck Project directories. Default is $RDECK_BASE/projects.framework.var.dir: Base directory for output and temp files used by the server and CLI tools. Default is $RDECK_BASE/var.framework.logs.dir: Directory for log files written by core services and Rundeck Server's Job executions. Default is $RDECK_BASE/var/logsframework.server.username: Username for connection to the Rundeck serverframework.server.password: Password for connection to the Rundeck serverframework.rundeck.url: Base URL for Rundeck server.SSH Connection settings:
framework.ssh.keypath: Path to the SSH private key file used for SSH connectionsframework.ssh.user: Default username for SSH Connections, if not overridden by Node specific value.framework.ssh.timeout: timeout in milliseconds for SSH connections and executions. The default is "0" (no timeout). You can modify this to change the maximum time allowed for SSH connections.Other settings:
framework.log.dispatch.console.format: Default format for non-terse node execution logging run by the dispatch CLI tool.Static authentication tokens for API access:
You can define the location of a .properties file in framework.properties:
rundeck.tokens.file=/etc/rundeck/tokens.propertiesThe tokens.properties file should contain static authentication tokens you wish to use, keyed by the associated username:
username: token_string
username2: token_string2
...
The token_strings can be used as Authentication tokens to the API.
Rundeck uses log4j as its application logging facility. This file defines the logging configuration for the Rundeck server.
Shell environment variables used by the shell tools. This file contains several parameters needed during the startup of the shell tools like umask, Java home and classpath, and SSL options.
Rundeck project configuration file. One of these is generated at project setup time.
| Property | Description |
|---|---|
project.name | Declare the project name. |
project.ssh-authentication | SSH authentication type (eg, privateKey). |
project.ssh-keypath | SSH identify file. |
service.FileCopier.default.provider | Default script file copier plugin. |
service.NodeExecutor.default.provider | Default node executor plugin. |
resources.source.N... | Defines a Resource model source see Resource Model Sources. |
Here's an example that configures a File source:
resources.source.1.config.file=/var/rundeck/projects/${project.name}/etc/resources.xml
resources.source.1.config.generateFileAutomatically=true
resources.source.1.config.includeServerNode=true
resources.source.1.type=file
Another that configures a URL source:
resources.source.2.config.cache=true
resources.source.2.config.timeout=30
resources.source.2.config.url=http\://example.com/nodes
resources.source.2.type=url
And one that configures a Directory source:
resources.source.3.config.directory=/var/rundeck/projects/${project.name}/site_nodes
resources.source.3.type=directory
Additional sources increment the source number. You can reference the project name by using the ${project.name} context variable.
JAAS configuration for the Rundeck server. The listing below shows the file content for a normal RPM installation. One can see it specifies the use of the PropertyFileLoginModule:
RDpropertyfilelogin {
org.eclipse.jetty.plus.jaas.spi.PropertyFileLoginModule required
debug="true"
file="/etc/rundeck/realm.properties";
};
Property file user directory when PropertyFileLoginModule is used. Specified from jaas-loginmodule.conf.
The primary Rundeck webapp configuration file. Defines default loglevel, datasource configuration, and GUI customization.
The URL and From: address used in email notifications are managed via the settings located in the rundeck-config.properties file.
The two properties are:
Here's an example:
grails.serverURL=https://node.fully.qualified.domain.name:4443
grails.mail.default.from=deployer@domain.com
If a sporadic DB connection failure happens when an execution finishes, Rundeck may fail to update the state of the execution in the database, causing the execution to appear is if it is still "running".
Rundeck now attempts to retry the update to correctly register the final state of the execution. You can tune how many times and how often this retry occurs with these config values:
# attempt to retry the final state update
rundeck.execution.finalize.retryMax=10
rundeck.execution.finalize.retryDelay=5000
# attempt to retry updating job statistics after execution finishes
rundeck.execution.stats.retryMax=3
rundeck.execution.stats.retryDelay=5000
Delay is in milliseconds. If a max is set to -1, then retries will happen indefinitely.