Rundeck Docs

System Requirements

The following operating systems are known to support Rundeck:

  • Linux: Most recent distributions are likely to work
  • Windows: XP, Server and above
  • Mac OS X 10.4 or later

Root (or Administrator on Windows) is not required or recommended. We recommend using a dedicated user account such as "rundeck".

If there is need for root access, please set up the Rundeck user to have access via sudo.

FIXME: needs cleanup

  • Supported Operating Systems: _ Red Hat Enterprise Linux _ CentOS _ Ubuntu _ Windows Server
  • A currently supported version of Mozilla Firefox or Google Chrome * Other HTML5 compliant web browsers may work but are not fully tested or supported.
  • 2 CPUs * 2 CPUs per member
  • 4 GB RAM * other notes about memory sizing
  • 20 GB hard disk * other notes about disk sizing
  • Database _ Mysql version _ Mariadb version _ Postgres version _ Oracle version
  • Log store _ File system _ S3 compatible object store
  • Amazon EC2 _ Instance size of m3.medium or larger _ An instance size of m3.xlarge or larger if there are more than 100 hosts

Java

Rundeck is a Java-Servlet based server and therefore requires the Java runtime.

The install process requires that the latest version of Java 8 be installed. Both the Open JDK and Sun/Oracle JVMs can be used. You must have the JAVA_HOME environment variable defined in your environment before running the launcher. The RPM will use the java found on your path. See Setting JAVA_HOME if you want to run a different version of java.

Verify your Java version to check it meets the requirement:

$ java -version

java version "1.8.0_131"
Java(TM) SE Runtime Environment (build 1.8.0_131-b11)
Java HotSpot(TM) 64-Bit Server VM (build 25.131-b11, mixed mode)

Network access

When the server starts, it binds to several TCP ports by default:

  • 4440 (http)
  • 4443 (https)

To check if the ports are free on a Unix host, run:

$ netstat -an | egrep '4440|4443'

If the ports are in use on the server, you will see output similar to below:

tcp46      0      0  *.4440                 *.*                    LISTEN

The installation procedures describe how to choose different ports, if there is a conflict.

In addition, TCP port 22 (by default) needs to be open on the clients for SSH.

Clients should be set up to allow the Rundeck server user to connect to the clients using SSH via public-key authentication. It should not prompt for a password. See Configure remote machine for SSH in the Administration chapter.

There are various ways for installing SSH on Windows; we recommend Cygwin.

Database

When you install the vanilla standalone rundeck configuration, it will use H2, an embedded database. It is convenient to have an embedded database when you are just trying Rundeck or using it for a non-critical purpose. Be aware though that using the H2 database is not considered safe for production because it not reslilient if Rundeck is not shutdown gracefully. When shutdown gracefully, Rundeck can write the data (kept in memory) to disk. If Rundeck is forcefully shutdown, the data can not be guaranteed to be written to file on disk and cause truncation and corruption.

Don't use the H2 embedded database for anything except testing and non-production.

Use an external database service like Mariadb, Mysql, Posgres or Oracle.

Also, be sure to locate your external database on a host(s) with sufficient capacity and performance. Don't create a downstream bottleneck!

For more about setting the datasource see: Configuration/Database.

Logstore

Rundeck records all job execution data into the Logstore. By default, Rundeck is configured to use the local file system. Normally, that is defined by the framework.logs.dir system setting found in framework.properties.

If you are setting up a clustered Rundeck see: Configuration/Logstore.

← Installing as an executable war →