This chapter helps new users get started with Rundeck. We will begin by explaining a few essential Rundeck concepts and terminology and then discuss installation, project setup and introduce you to the top level navigation of the interface.
Several fundamental concepts underlie and drive the Rundeck system. If you are a new user, knowing about them will help you use or integrate Rundeck into your environment.
If a running Rundeck instance isn't already available to you, there are a couple ways you can try it.
The default port for the web interface is
4440. If you installed Rundeck on your local machine, go to this URL: http://localhost:4440
Rundeck requires every user to login. The default installation defines an "admin" user with access to perform all actions. Use "admin" for username and password.
A new installation will not contain any projects so Rundeck will present you with a dialog to create one. Press the "New Project" button to create a project. Fill the project creation form with a desired name. Project names can contain letters and numbers but do not use spaces or special characters. The Project setup chapter in the Administrator guide will show you how to learn to add Nodes, automate the creation and maintenance of Rundeck projects.
Once the project has been created you are ready to use your Rundeck instance.
The Rundeck page header contains global navigation control to move between tabbed pages: Jobs, Nodes, Commands and Activity. It also has links to Configure the project, logout, view your user profile and a link to this online help.
The top navigation bar contains a menu to select the desired project. If only one project exists, the menu will automatically be selected. You can create new projects from this menu, too.
From the Jobs page, one can list, create and run Jobs. A configurable filter allows a user to limit the Job listing to those Jobs matching the filtering criteria. These filter settings can be saved to a Users profile. Only authorized jobs will be visible.
The Nodes page is used to browse your Nodes configured in your Project resource model. A filter control can be used to limit the listing to just the Node resources matching the filter criteria. Given the appropriate authorization you can also execute ad hoc commands to your filtered node set.
The Commands page lets you execute arbitrary commands against the nodes that match the node filter.
From the Activity page, one can view currently executing commands and Jobs or browse execution history. The execution history can be filtered based on user selected parameters. Once the filter has been set, the matching history is displayed. The current filter settings also configure an RSS link, found in the top right of the page (see Rundeck Administration to enable RSS).
If your login belongs to the "admin" group and therefore granted "admin" privileges, a "Configure" icon will be displayed in the top navigation bar. From the Configure page you can edit project configuration, export and import project archives, view system information, and see what plugins are installed.
The User menu lets you logout and view your profile page. Your user profile lists your group memberships and a form to list and generate API tokens.
Opens a page to this user manual.
Rundeck includes a number of shell tools to dispatch commands, load and run Job definitions and interact with the dispatcher queue. These command tools are an alternative to functions accessible in the graphical console.
See the Command line tools.
You can also use the Web API to interface with all aspects of node and Job execution.
See the Rundeck API page for a reference on the endpoints and examples.
If you prefer to manage job and resource definitions using text files you can do so using XML or YAML formats.
See the Document Format Reference.