diff --git a/docs/en/manual/01-introduction.md b/docs/en/manual/01-introduction.md index 5819c6f5a17..d3fafd6d390 100644 --- a/docs/en/manual/01-introduction.md +++ b/docs/en/manual/01-introduction.md @@ -27,10 +27,10 @@ Already itching to install it? Jump ahead to ### Who makes the Rundeck software? Rundeck is developed on GitHub as a project called -[dtolabs/rundeck](https://github.com/dtolabs/rundeck). -Many ideas for Rundeck come from [DTO Solutions](http://www.dtosolutions.com) -consultants working in the field, however all are welcome to join the project -and contribute. +[dtolabs/rundeck](https://github.com/dtolabs/rundeck) +by [SimplifyOps](http://simplifyops.com) and the Rundeck community. +All new users are welcomed to participate in the project and contribute. +Please vote on feature ideas on the [Rundeck Trello Board](https://trello.com/b/sn3g9nOr/rundeck-development). Rundeck is free software and is public under the [Apache Software License]. diff --git a/docs/en/manual/02-getting-started.md b/docs/en/manual/02-getting-started.md index 0aa724562fc..6c3601cbd20 100644 --- a/docs/en/manual/02-getting-started.md +++ b/docs/en/manual/02-getting-started.md @@ -115,7 +115,7 @@ Simply download it, and place it into a directory that will be the `RDECK_BASE` Start the Rundeck server by running the jar using java: - java -jar rundeck-launcher-1.5.0.jar + java -jar rundeck-launcher-1.6.0.jar ## Upgrading Rundeck diff --git a/docs/en/manual/03-basics.md b/docs/en/manual/03-basics.md index b99dd01e057..37751400f89 100644 --- a/docs/en/manual/03-basics.md +++ b/docs/en/manual/03-basics.md @@ -43,13 +43,6 @@ logout, view your user profile and a link to this online help. ![Top navigation bar](../figures/fig0201.png) -Run - -: The Run page is used to execute ad hoc commands. It - displays filtered Node resources 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. Jobs @@ -58,58 +51,48 @@ Jobs Jobs matching the filtering criteria. These filter settings can be saved to a Users profile. Only authorized jobs will be visible. -History +Nodes + +: 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. + +Activity -: From the History page, one can view currently executing commands - in the "Now Running" area or browse execution history. The execution +: 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. + the page (see Rundeck Administration to enable RSS). Project menu : The top navigation bar contains a menu to select the desired project. If only one project exists, the menu will - automatically be defaulted. You can create new projects from + automatically be selected. You can create new projects from this menu, too. -Admin +Configure : If your login belongs to the "admin" group and therefore granted - "admin" privileges, a wrench icon will be displayed next to your login - name. This page allows the admin to view group memberships for all - users, as well as, edit their profile data. Project configuration includes - adding plugins and exporting/importing project archives. - -User profile - -: Shows a page showing group memberships. + "admin" privileges, a "Configure" tab will be displayed next to your login + name. This page allows the admin to manage Project configuration. + From the Configure page you can also export and import project archives. + The Configure page also allows the admin to view group memberships for all + users, as well as, edit their profile data. -Logout +User -: Pressing this link ends the login session and will require a subsequent login. +: Shows a popup menu to logout and view your profile page showing group memberships. Help : Opens a page to this user manual. -#### Now running - -The "Now running" section appears at the top of the Run and Jobs pages -and provides a view into the execution queue. -Any currently executing command executed from the Run page -or any Job executed in the Jobs page will be listed. -The "Now running" section will -include information like the name of the job, when it started, -who ran it, and a link to the execution output. - -![Now running](../figures/fig0215.png) - -Jobs that have been run before also have a progress bar approximating -duration. - ### Shell Tools Rundeck includes a number of shell tools to dispatch commands, load @@ -156,10 +139,10 @@ create a new project. To start with, the only field you need to enter is the Project Name. You can change the other values later from the -[GUI Admin Page](../administration/configuration.html#gui-admin-page). +[GUI Configure Page](../administration/configuration.html#gui-admin-page). After entering your project name, Rundeck initializes it and returns -you to the "Run" page. +you to the "Jobs" page. Projects can be created at any time by going back to the Project menu and selecting the "Create a new project..." item. @@ -198,7 +181,7 @@ Each Rundeck Project has its own Resource Model. The initial resource model will contain information just about the Rundeck server host and is useful just for running local commands on the Rundeck server. -You can browse the project resource model by going to the "Run" page. +You can browse the project resource model by going to the "Jobs" page. In the shell, you can list the Node resources in a resource model using the shell tool, `dispatch`. @@ -314,7 +297,7 @@ Rundeck currently has two resource model document formats built in: You can enable more formats using [Resource Format Plugins](plugins.html#resource-format-plugins). -## Pluggable Resource Model Sources +### Pluggable Resource Model Sources Each project can have multiple sources for Resource model information, and you can use or write plugins to enable new sources for entries in the Resource model. @@ -324,35 +307,30 @@ You can configure the sources via the GUI from the Admin page, see or by modifying the project configuration file, see [Resource Model Sources](plugins.html#resource-model-sources). -## Command Execution - -Rundeck supports two modes of execution: *ad-hoc commands* and *Job*. - -An *ad-hoc command* is any system command or shell script executed -via a node executor. Ad hoc commands can be executed via a -command line utility named `dispatch` or run from -the graphical console. +## Jobs A *Job* specifies a sequence of one or more steps that can be run once (i.e, is temporary) or named and stored for later use. See [Jobs](jobs.html) to learn how to execute Rundeck jobs. -### Execution options +### Job Workflows + +See [Job Workflows](job-workflows.html). + +### Job Options + +See [Job Options](job-options.html). -Execution can be controlled by various types of options. +## Nodes -Execution control -: Concurrency - is controlled by setting the "threadcount". Execution can continue even if - some node fails if the "keepgoing" option is set to true. +### Node filtering -Node Filters -: Filtering options specify include and exclude filters to - determine which nodes from the project resource model to distribute - commands to. +Filtering options specify include and exclude filters to +determine which nodes from the project resource model to distribute +commands to. Filter Keywords @@ -428,13 +406,14 @@ case an error occurs : Consult the [rd-options(1)](../manpages/man1/rd-options.html) manual page for the complete reference on available dispatch options. - + + ### Ad-hoc commands Typically, an ad-hoc command is a shell script or system executable that you run at an interactive terminal. Ad-hoc commands can be -executed via the `dispatch` shell command or a graphical -shell. +executed via the `dispatch` shell command or from the Nodes page +in the GUI. #### Shell tool command execution @@ -519,23 +498,22 @@ below (see [output](rundeck-basics.html#following-execution-output)). ![Ad hoc execution output](../figures/fig0208.png) -You will also notice the ad hoc execution listed in the "Now running" -part of the page, located above the command prompt. +You will also notice the ad hoc execution listed in the "Activity" +part of the page, located below the command output. All running executions are listed there. Each running execution is listed, showing the start time, the user running it, and a link to follow execution output on a separate page. ![Now running ad hoc command](../figures/fig0207-b.png) -At the bottom of the page, you will see a "History" section containing +The "Activity" section also contains all executions in the selected project for the last 24 hours. After the execution -completes, a new event will be added to the history. A yellow highlight -indicates when the command leaves the Now running section and enters -the history table. +completes, a new event will be added to the list. A yellow highlight +indicates when the command completes. ![Run history](../figures/fig0207-c.png) -History is organized in summary form using a table layout. The "Summary" column +Activity is organized in summary form using a table layout. The first column shows the command or script executed. The "Node Failure Count" contains the number of nodes where an error in execution occurred. If no errors occurred, "ok" will be displayed. The "User" and "Time" columns show the user that executed @@ -551,21 +529,9 @@ Tail Output : Displays output messages from the command execution as if you were running the Unix `tail -f` command on the output log file. - By default, only the last 20 lines of output is displayed but this - can be expanded or reduced by pressing the "-" or "+" buttons. You - can also type in an exact number into the textfield. ![Ad hoc execution output](../figures/fig0208.png) -Annotated - -: The annotated mode displays the output messages in the order they - are received but labels the each line with the Node from which the - message originated. Through its additional controls each Node - context can be expanded to show the output it produced, or - completely collapsed to hide the textual detail. - ![Annotated output](../figures/fig0209.png) - -Compact +By Node : Output messages are sorted into Node specific sections and are not interlaced. By default, the messages are collapsed but can be @@ -576,8 +542,8 @@ Compact Sometimes it is useful to have a page where just the execution output is displayed separately. One purpose is to share a link to others -interested in following the output messages. Click the "output >>" -link in the "Now running" section to go to the execution follow page. +interested in following the output messages. Click the "Show >>" +link in the "Activity" section to go to the execution follow page. Also, notice the URL in the location bar of your browser. This URL can be shared to others interested in the progress of execution. The URL @@ -594,7 +560,7 @@ After execution completes, the command will have a status: Failed Nodes..." in case you would like to retry the command. You can download the entire output as a text file from this -page. Press the "Download" link to retrieve the file to your desk top. +page. Press the "Download" link to retrieve the file to your desktop. ### Controlling command execution @@ -652,7 +618,7 @@ failed: By default, commands or scripts executed on the command line by `dispatch` are queued as temporary jobs in Rundeck. The `dispatch` command -is equivalent to a "Run and Forget" action in the graphical console. +is equivalent to a "Run and Forget". The script below is a long running check that will conduct a check periodically waiting a set time between each pass. The script can be run with or without @@ -689,9 +655,8 @@ dash): ### Tracking execution -Queued ad-hoc command and temporary or saved Job executions can be -tracked from the "Run" page in the "[Now Running](rundeck-basics.html#now-running)" area at the top of -the page. +Queued ad-hoc command and Job executions can be +tracked from the "Activity" page. Execution can also be tracked using the [rd-queue](../manpages/man1/rd-queue.html) shell tool. @@ -752,56 +717,55 @@ Two plugin files are included with the default Rundeck installation for your use * [Stub plugin](plugins.html#stub-plugin): simply prints the command or script instead of running it. * [Script plugin](plugins.html#script-plugin): executes an external script file to perform the command, useful for developing your own plugin with the [Script Plugin Development](../developer/plugin-development.html#script-plugin-development) model. -## History +## Activity History for queued ad-hoc commands, as well as, Job executions is stored by the Rundeck server. History data -can be filtered and viewed inside the "History" page. +can be filtered and viewed inside the "Activity" page. -![History page](../figures/fig0211.png) +![Activity page](../figures/fig0211.png) -### Filtering event history +### Filtering Activity -By default, the History page will list history for the 8 -executions. The page contains a filter control that can be used to +By default, the Activity page will list running executions and history +recent executions. The page contains a filter control that can be used to expand or limit the executions. The filter form contains a number of fields to limit search: * Within: Time range. Choices include 1 day, 1 week, 1 month or other (given a start after/before to ended after/before). -* Name: Job title name. -* Project: Project name. This may be set if the project menu was used. +* Job Name: Job title name. * User: User initiating action. -* Summary: Message text. +* Ad hoc command: Command typed into the command bar or via `dispatch`. * Result: Success or failure status. ![History filter form](../figures/fig0212.png) After filling the form pressing the "Filter" button, the page will -display events matching the search. +display executions matching the search. Filters can be saved to a menu that makes repeating searches more convenient. Click the "save this filter..." link to save the filter configuration. -### Event view +### Execution listings -History for each execution contains the command(s) executed, -dispatcher options, success status and a link to a file containing all +Information for each execution contains the command or Job executed, +options, success status and a link to a file containing all the output messages. -![Event view](../figures/fig0213.png) +![Execution view](../figures/fig0213.png) If any errors occurred, the "Node Failure Count" column will show the number of nodes in red text. A bar chart indicates the percent failed. -![Event view](../figures/fig0216.png) +![Execution view](../figures/fig0216.png) ### RSS link -An RSS icon provides a link to an RSS view of the events that match +If configured, an RSS icon provides a link to an RSS view of the events that match the current filtering criteria. ![RSS link](../figures/fig0214.png) diff --git a/docs/en/manual/04-jobs.md b/docs/en/manual/04-jobs.md index 4d1da3f7ee4..d82fbf095ed 100644 --- a/docs/en/manual/04-jobs.md +++ b/docs/en/manual/04-jobs.md @@ -204,45 +204,11 @@ From the Jobs, page press the "New Job" button to begin creating a Job. ![New Job button](../figures/fig0301.png) -### Temporary Jobs -A temporary job is a bit like an ad-hoc command except you get more -control over how the commands will execute plus the execution can be -better tracked within the Rundeck webapp. - -To create a temporary job, begin by logging in to the Rundeck -graphical console, and press the "Jobs" tab. - -1. Locate the "New Job" button in the right hand corner and press it to display the "Create New Job" form. -1. A job is defined in terms of one or more workflow steps. In the Workflows area, click the "Add a step" link. -1. Workflow steps can be one of several types. Click the "Script" workflow step type. -1. A script type can be any script that can be executed on the target -hosts. Type in the "info" shell script we executed earlier using -dispatch. -1. At the bottom of the form, push the "Run and Forget" button to begin execution. -1. Execution output can be followed on the subsequent page. - -![Temporary job form](../figures/fig0302.png) - -### Saved Jobs - -Running ad hoc commands and temporary jobs are a typical part of day -to day administrative work. Occasionally, ad-hoc commands become -routine procedures and if were reusable, would become more valuable. These jobs -could be handed off to others in the team or invoked from within other -Jobs. Rundeck provides an interface to declare and save jobs, both -graphically or declared with an XML file. - - -### Simple saved job - -For the first saved Job example, create a Job that calls the info script. +For the first Job example, create a Job that calls the info script. 1. Like in the earlier example, begin by pressing the "New Job" button. 1. Within the new job form: - - Select "Yes" for the "Save this job?" - prompt. Pressing Yes reveals a form to define a name, group and - description for the job. - For "Job Name", enter "info" and for the "Group", enter "adm/resources". - If you want to specify your own UUID you can enter it in the field. @@ -514,7 +480,7 @@ See also: [rd-queue](../manpages/man1/rd-queue.html). ## Deleting Jobs -In the Job detail page, click the red "X" icon for to delete the Job. +In the Job edit page, click the red "X" icon for to delete the Job. ![Job delete button](../figures/fig0311.png) diff --git a/docs/figures/fig0201.png b/docs/figures/fig0201.png index 05fdde1291e..d2b0d8b3a3f 100644 Binary files a/docs/figures/fig0201.png and b/docs/figures/fig0201.png differ diff --git a/docs/figures/fig0202.png b/docs/figures/fig0202.png new file mode 100644 index 00000000000..202e95451bd Binary files /dev/null and b/docs/figures/fig0202.png differ diff --git a/docs/figures/fig0203.png b/docs/figures/fig0203.png index b6402dfaf82..e4e684e2605 100644 Binary files a/docs/figures/fig0203.png and b/docs/figures/fig0203.png differ diff --git a/docs/figures/fig0204.png b/docs/figures/fig0204.png index 90a1d16d66a..24aca6b8bdf 100644 Binary files a/docs/figures/fig0204.png and b/docs/figures/fig0204.png differ diff --git a/docs/figures/fig0205.png b/docs/figures/fig0205.png index c561f3bc00e..934b3b7d782 100644 Binary files a/docs/figures/fig0205.png and b/docs/figures/fig0205.png differ diff --git a/docs/figures/fig0207-b.png b/docs/figures/fig0207-b.png index 6907238d949..8cca1f309eb 100644 Binary files a/docs/figures/fig0207-b.png and b/docs/figures/fig0207-b.png differ diff --git a/docs/figures/fig0207-c.png b/docs/figures/fig0207-c.png index a87d8c9dd78..e7e093e05fb 100644 Binary files a/docs/figures/fig0207-c.png and b/docs/figures/fig0207-c.png differ diff --git a/docs/figures/fig0207.png b/docs/figures/fig0207.png index a488d3ca230..0869f8fc6fb 100644 Binary files a/docs/figures/fig0207.png and b/docs/figures/fig0207.png differ diff --git a/docs/figures/fig0208.png b/docs/figures/fig0208.png index 71e0579c12c..074485fed8d 100644 Binary files a/docs/figures/fig0208.png and b/docs/figures/fig0208.png differ diff --git a/docs/figures/fig0210.png b/docs/figures/fig0210.png index 07a5684fc87..ee030f4d8ab 100644 Binary files a/docs/figures/fig0210.png and b/docs/figures/fig0210.png differ diff --git a/docs/figures/fig0211.png b/docs/figures/fig0211.png index 1f0aa8a2c63..b0a0864899f 100644 Binary files a/docs/figures/fig0211.png and b/docs/figures/fig0211.png differ diff --git a/docs/figures/fig0212.png b/docs/figures/fig0212.png index 6634c041f93..91a9dd17781 100644 Binary files a/docs/figures/fig0212.png and b/docs/figures/fig0212.png differ diff --git a/docs/figures/fig0213.png b/docs/figures/fig0213.png index 62346ef59c1..0eeedc9289f 100644 Binary files a/docs/figures/fig0213.png and b/docs/figures/fig0213.png differ diff --git a/docs/figures/fig0216.png b/docs/figures/fig0216.png index 1aa94adfb66..84b9085c581 100644 Binary files a/docs/figures/fig0216.png and b/docs/figures/fig0216.png differ diff --git a/docs/figures/fig0301.png b/docs/figures/fig0301.png index 6f7c15fd6f2..701be4a3127 100644 Binary files a/docs/figures/fig0301.png and b/docs/figures/fig0301.png differ diff --git a/docs/figures/fig0302.png b/docs/figures/fig0302.png index f71a9b8caaa..a48b6c61e50 100644 Binary files a/docs/figures/fig0302.png and b/docs/figures/fig0302.png differ diff --git a/docs/figures/fig0303.png b/docs/figures/fig0303.png index c65175bbaf3..f194fdc7a81 100644 Binary files a/docs/figures/fig0303.png and b/docs/figures/fig0303.png differ diff --git a/docs/figures/fig0304.png b/docs/figures/fig0304.png index 40e4467151a..906c6bf2678 100644 Binary files a/docs/figures/fig0304.png and b/docs/figures/fig0304.png differ diff --git a/docs/figures/fig0305.png b/docs/figures/fig0305.png index 306e2bc7b6a..f2a41b180b2 100644 Binary files a/docs/figures/fig0305.png and b/docs/figures/fig0305.png differ diff --git a/docs/figures/fig0310.png b/docs/figures/fig0310.png index 7f52f48bfb5..fce8da351b7 100644 Binary files a/docs/figures/fig0310.png and b/docs/figures/fig0310.png differ diff --git a/docs/figures/fig0311.png b/docs/figures/fig0311.png index b7dbc243ed8..350b3406597 100644 Binary files a/docs/figures/fig0311.png and b/docs/figures/fig0311.png differ diff --git a/docs/figures/fig0312.png b/docs/figures/fig0312.png index d831c102f25..595bac77862 100644 Binary files a/docs/figures/fig0312.png and b/docs/figures/fig0312.png differ diff --git a/docs/figures/fig0313.png b/docs/figures/fig0313.png index e370c171316..42d9ba1f229 100644 Binary files a/docs/figures/fig0313.png and b/docs/figures/fig0313.png differ diff --git a/docs/figures/fig0314.png b/docs/figures/fig0314.png index e3aaf4c6a14..09f916b7331 100644 Binary files a/docs/figures/fig0314.png and b/docs/figures/fig0314.png differ diff --git a/docs/figures/fig0316.png b/docs/figures/fig0316.png index ae9f8c56b12..e419cafa350 100644 Binary files a/docs/figures/fig0316.png and b/docs/figures/fig0316.png differ diff --git a/docs/figures/fig0318.png b/docs/figures/fig0318.png index aa550e602dc..906c6bf2678 100644 Binary files a/docs/figures/fig0318.png and b/docs/figures/fig0318.png differ diff --git a/docs/figures/fig0319-b.png b/docs/figures/fig0319-b.png index c149cbdd4c5..07910e325e7 100644 Binary files a/docs/figures/fig0319-b.png and b/docs/figures/fig0319-b.png differ diff --git a/docs/figures/fig0319.png b/docs/figures/fig0319.png index b21537830bb..ce75466e9b6 100644 Binary files a/docs/figures/fig0319.png and b/docs/figures/fig0319.png differ diff --git a/docs/figures/fig0320.png b/docs/figures/fig0320.png index 87156a082a8..04e3a796bb3 100644 Binary files a/docs/figures/fig0320.png and b/docs/figures/fig0320.png differ diff --git a/docs/figures/fig0321.png b/docs/figures/fig0321.png index ba5d5e08060..3fa4cb7e3a1 100644 Binary files a/docs/figures/fig0321.png and b/docs/figures/fig0321.png differ diff --git a/docs/figures/fig0402.png b/docs/figures/fig0402.png index 1d8ec725ad0..2ddc4dca050 100644 Binary files a/docs/figures/fig0402.png and b/docs/figures/fig0402.png differ diff --git a/docs/figures/fig0403.png b/docs/figures/fig0403.png index 55106d2aa19..fd5fae799d8 100644 Binary files a/docs/figures/fig0403.png and b/docs/figures/fig0403.png differ diff --git a/docs/figures/fig0405.png b/docs/figures/fig0405.png index 1683169a421..de6aa7ed979 100644 Binary files a/docs/figures/fig0405.png and b/docs/figures/fig0405.png differ diff --git a/docs/figures/fig0406.png b/docs/figures/fig0406.png index 2734f41e9d2..7a61bb66a5d 100644 Binary files a/docs/figures/fig0406.png and b/docs/figures/fig0406.png differ diff --git a/docs/figures/fig0502.png b/docs/figures/fig0502.png index 1284b3b6a2b..249cc9af8ad 100644 Binary files a/docs/figures/fig0502.png and b/docs/figures/fig0502.png differ diff --git a/docs/figures/fig0504.png b/docs/figures/fig0504.png index 23369126d25..6a27e77e0d2 100644 Binary files a/docs/figures/fig0504.png and b/docs/figures/fig0504.png differ diff --git a/docs/figures/fig0601.png b/docs/figures/fig0601.png index e9173e8edbb..5d2f3a6d653 100644 Binary files a/docs/figures/fig0601.png and b/docs/figures/fig0601.png differ diff --git a/docs/figures/fig0602.png b/docs/figures/fig0602.png index d47cc1929f4..cef9f7d7be2 100644 Binary files a/docs/figures/fig0602.png and b/docs/figures/fig0602.png differ diff --git a/docs/figures/fig0603.png b/docs/figures/fig0603.png index 8192eabe7dc..ff3e6db088a 100644 Binary files a/docs/figures/fig0603.png and b/docs/figures/fig0603.png differ diff --git a/docs/figures/fig0604.png b/docs/figures/fig0604.png index 7fa0cb68363..ca51a00a074 100644 Binary files a/docs/figures/fig0604.png and b/docs/figures/fig0604.png differ diff --git a/docs/figures/fig0605.png b/docs/figures/fig0605.png index 0510f60ba3a..900fce57be8 100644 Binary files a/docs/figures/fig0605.png and b/docs/figures/fig0605.png differ diff --git a/docs/figures/fig0606.png b/docs/figures/fig0606.png index edd048d7861..0dba2e687b7 100644 Binary files a/docs/figures/fig0606.png and b/docs/figures/fig0606.png differ diff --git a/docs/figures/fig0607.png b/docs/figures/fig0607.png index 8fd3becbfc0..3840ef69139 100644 Binary files a/docs/figures/fig0607.png and b/docs/figures/fig0607.png differ diff --git a/docs/figures/fig0608.png b/docs/figures/fig0608.png index 1da6d3721f1..0fcd5eecdfa 100644 Binary files a/docs/figures/fig0608.png and b/docs/figures/fig0608.png differ