Welcome, Guest Login

Rundeck Enterprise Support Center

Installing a Single Instance of Rundeck Pro Cluster On Windows

Last Updated: Feb 21, 2018 05:26AM PST
Note: these instructions are for installing a single instance "cluster" (one cluster member only) for evaluation or standalone usage. 

1.   Install Rundeck Pro

This guide will install Rundeck PRO as a Service on a Windows Server. It uses the Rundeck PRO  launcher installer (Jar file).
  • Choose a root directory (e.g. C:\rundeck). 
  • Place rundeckpro-launcher-cluster-X.X.X.jar in that directory
  • Go to the RDECK_BASE (e.g. C:\rundeck)  folder and launch the installation of rundeck.
     cd C:\rundeck
     java -jar rundeckpro-launcher-cluster-X.X.X.jar

Screenshot 2017-10-05 14.05.00.png
  • After Rundeck PRO started, stop the process.
  • Create a bat file (e.g. start_rundeck.bat) and place it under %RDECK_BASE%
     set CURDIR=%~dp0
     call %CURDIR%etc\profile.bat
     java %RDECK_CLI_OPTS% %RDECK_SSL_OPTS% -jar    
     rundeckpro-launcher-cluster-X.X.X.jar --skipinstall -d  >> %CURDIR%\var\logs\service.log  2>&1

Screenshot 2017-10-05 14.08.22.png
  • Place the executable under %RDECK_BASE% (you can place it elsewhere, but for the sake of the example let's use always the root dir)
  • Open a prompt and issue these commands (Administrator mode required to install a service)
     cd C:\rundeck
     nssm.exe install RUNDECK

  • the GUI pops up, set "path" as %RDECK_BASE%\start_rundeck.bat , startup directory  as %RDECK_BASE% (optionally set "low" on the process tab, under priority, to avoid server cpu spike when starting rundeck)
Screenshot 2017-10-05 14.11.04.png
  • Go to the service management console (services.msc) and you'll find RUNDECK listed as a service. Starting it will start the rundeck process.
Screenshot 2017-10-05 14.12.19.png

2. Login to the GUI

By default, rundeck will be installed in port 4440. To access rundeck, go to the following URL: http://servername:4440.
Normally, it is necessary to modify the [servername] parameter on %RDECK_BASE%\server\config\rundeck-config.properties to access the GUI, for example:
Screenshot 2017-10-05 14.14.03.png
Change grails.serverURL with the server name or IP.
(this change needs the rundeck service to be restarted)
Screenshot 2017-10-04 14.21.44.png
The default username and password is “admin”

3. Start-Stop instances

Use the Service Windows GUI to start/stop/restart the instance

4. Install License File

  • Go to the GUI and click on the “No License Key File is installed” button
Screenshot 2017-10-04 14.22.53.png
  • Then click on “Upload License File”
Screenshot 2017-10-03 14.29.11.png
  • Then select the license file (.key file)  and press “Update License File”
Screenshot 2017-10-03 14.31.33.png
  • Finally, it is necessary to change the “Passive Mode”  to “Active”
Screenshot 2017-10-03 14.31.44.png

5. Folder Structure

|       admin.aclpolicy => Administrator access control policy defined with a [aclpolicy] document
|       apitoken.aclpolicy => Default API ACL policies
|       cli-log4j.properties => This file defines the logging configuration for the Commandline tools.
|       framework.properties => Configuration file used by shell tools and core Rundeck services
|       preferences.properties
|       profile
|       profile.bat => Shell environment variables used by the shell tools
|       project.properties =>Rundeck project configuration file when using Filsystem based project defintions.
+---libext => Plugin folder
+---projects => Projects data (eg: resource files, project properties, etc)
|   +---config
|   |       jaas-loginmodule.conf
|   |       realm.properties => Property file user directory when PropertyFileLoginModule is used
|   |       rundeck-config.properties => This is the primary Rundeck webapp configuration file. Defines default loglevel, datasource configuration, and GUI customization.
|   |       ssl.properties => To enable SSL access to rundeck
|   |      
|   +---data => H2 database
|   |       grailsdb.mv.db
|   +---exp
|   +---lib
|   +---logs => Rundeck logging 
|   |       rundeck.access.log => access to rundeck
|   |       rundeck.api.log => Api calls
|   |       rundeck.audit.log => Authorization messages pertaining to aclpolicy
|   |       rundeck.executions.log => Logs of all executions
|   |       rundeck.jobs.log => Log of all job definition changes
|   |       rundeck.log=> General Rundeck application messages
|   |       rundeck.options.log=> Logs remote HTTP requests for Options JSON data
|   |       rundeck.project.log
|   |       rundeck.storage.log=> Standard input and output generated during runtime
|   +---sbin
|   \---work
+---tools=> rd-acl client (to manage ACL validation)
\---var   => Executions Logs folder
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
Invalid characters found