Skip to content

Commit

Permalink
Merge branch 'development' of github.com:dtolabs/rundeck into develop…
Browse files Browse the repository at this point in the history
…ment
  • Loading branch information
gschueler committed Dec 6, 2010
2 parents 6cfcee1 + 75896d4 commit abb2dc0
Show file tree
Hide file tree
Showing 11 changed files with 49 additions and 39 deletions.
4 changes: 2 additions & 2 deletions Makefile
Expand Up @@ -44,8 +44,8 @@ appdocs: docs
mkdir -p ./rundeckapp/web-app/docs
cp docs/en/dist/html/* ./rundeckapp/target/launcher-contents/docs
cp docs/en/dist/html/* ./rundeckapp/web-app/docs
cp docs/en/manpages/man1/*.gz ./rundeckapp/target/launcher-contents/docs/man/man1
cp docs/en/manpages/man5/*.gz ./rundeckapp/target/launcher-contents/docs/man/man5
cp docs/en/dist/man/man1/*.1 ./rundeckapp/target/launcher-contents/docs/man/man1
cp docs/en/dist/man/man5/*.5 ./rundeckapp/target/launcher-contents/docs/man/man5

$(launcher): appdocs $(core) $(RUNDECK_FILES)
./build.sh rundeckapp
Expand Down
10 changes: 10 additions & 0 deletions core/src/templates/etc/user.aclpolicy.template
@@ -0,0 +1,10 @@
<policies>
<policy description="User group has access to run and kill jobs.">
<context project="*">
<command group="*" job="*" actions="workflow_run,workflow_kill"/>
</context>
<by>
<group name="user"/>
</by>
</policy>
</policies>
4 changes: 2 additions & 2 deletions docs/en/manpages/Makefile
Expand Up @@ -20,7 +20,7 @@ clean : $(DIRS)

#generate md file for index for each man section
htmlindex: subdirs
-rm man1.index.md man5.index.md
-rm -f man1.index.md man5.index.md
echo "## Command Reference" >> man1.index.md
for i in man1/*.md ; do \
f=$$(basename $$i); \
Expand All @@ -34,4 +34,4 @@ htmlindex: subdirs
done;
#concat md files and generate index.html
$(PANDOC) -s index.md man1.index.md man5.index.md --css=$(CSS) --template=$(TEMPLATES)/html.template --include-before=$(TEMPLATES)/before.html --include-after=$(TEMPLATES)/after.html -o $(DIST)/html/index.html;
-rm man1.index.md man5.index.md
-rm -f man1.index.md man5.index.md
2 changes: 1 addition & 1 deletion docs/en/manpages/man1/Makefile
Expand Up @@ -6,7 +6,7 @@ TEMPLATES=../../templates
.SUFFIXES: .1.gz .1
.PHONY: all

all: manpages html
all: manpages html roff

manpages: dispatch.1.gz rd-jobs.1.gz rd-options.1.gz rd-setup.1.gz rd-queue.1.gz run.1.gz

Expand Down
7 changes: 2 additions & 5 deletions docs/en/manpages/man1/rd-jobs.1.md
Expand Up @@ -8,13 +8,10 @@ rd-jobs - List or load jobs to the RunDeck server

# SYNOPSIS

dispatch [*action*] [*action options*]...
rd-jobs [*action*] [*action options*]...

# DESCRIPTION

The dispatch command is used to remotely execute ad-hoc shell commands
on a set of nodes which are specified by the filter options.

The rd-jobs command lists Jobs stored on the server and optionally downloads them as XML, or uploads Job XML to the server from a file.

The tool works in one of two *ACTION* modes:
Expand Down Expand Up @@ -101,7 +98,7 @@ and the URL to view the Job in the server.

The Load action uploads the specified file to the server, and the list of loaded jobs are displayed. If any Jobs cannot be stored (e.g. the user is unauthorized to run a certain command), the list of unsuccessfully created jobs are also displayed.

The `-d,\--duplicate` option lets you specify what should happen if any
The `-d,--duplicate` option lets you specify what should happen if any
of the Job definitions have the same Name and Group of an existing Job
on the server. The default option is "update", which means to
overwrite the existing definitions with the new version. "skip" means
Expand Down
9 changes: 3 additions & 6 deletions docs/en/manpages/man1/rd-setup.1.md
Expand Up @@ -16,7 +16,7 @@ The rd-setup command is used to setup the RunDeck software after the distributio

During the first time installation or if the -f flag is set rd-setup
will create a new instance of the framework and generate all the
configuration files found in $RD_BASE/etc.
configuration files found in $RDECK_BASE/etc.

# OPTIONS

Expand Down Expand Up @@ -46,10 +46,7 @@ of rd-setup:
* JAVA_HOME
:Java installation directory

* RD_HOME
: RunDeck installation directory

* RD_BASE
* RDECK_BASE
: RunDeck framework instance directory

# EXECUTION #
Expand All @@ -69,7 +66,7 @@ Execute the rd-setup command defining the framework hostname as
# FILES #

The rd-setup command generates a working configuration from a set of
template files found in: $RD_HOME/lib/templates/etc. Additionally,
template files found in: $RDECK_BASE/lib/templates/etc. Additionally,
initial configuration default values are maintained in
rd-defaults.properties but these can be overwridden using
\--key=value flags.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/manpages/man1/run.1.md
Expand Up @@ -12,7 +12,7 @@ run [-h] [-v] [-l level] [nodefilters] [-i id] [-j group/name][\-- arguments]

# DESCRIPTION

The run command is used to start the execution of a Job defined in CTL Center. The Job is executed on the server, and the ID for the execution is displayed. This is equivalent to logging in to CTL Center and starting a Job within the web application GUI.
The run command is used to start the execution of a Job defined in RunDeck. The Job is executed on the server, and the ID for the execution is displayed. This is equivalent to logging in to RunDeck and starting a Job within the web application GUI.

The Job can either be specified by ID (-i), or by name and optional group (-j). The Node filters used for the execution of the job can also be specified on the commandline, and will be used instead of any already defined for the Job. Arguments to the Execution can be specfied after (\--).

Expand Down
2 changes: 1 addition & 1 deletion docs/en/manpages/man5/Makefile
Expand Up @@ -6,7 +6,7 @@ TEMPLATES=../../templates
.SUFFIXES: .5.gz .5
.PHONY: all

all: manpages html
all: manpages html roff

manpages: aclpolicy-v10.5.gz job-v20.5.gz resource-v10.5.gz

Expand Down
6 changes: 4 additions & 2 deletions docs/en/manpages/man5/aclpolicy-v10.5.md
Expand Up @@ -13,7 +13,7 @@ same directory, helping the management of each set of rules. This
reduces the complexity of each file. The default path is

* RPM install: `/etc/rundeck/client`
* Launcher install: `$RDBASE_BASE/etc`
* Launcher install: `$RDECK_BASE/etc`

Policy files are parsed using XPath that is fairly liberal in what it
excepts. So creating arbitrary blocks for documentation or
Expand Down Expand Up @@ -90,10 +90,12 @@ Known actions are:

Possible values are limitless so it requires an understanding of the
job definition you're trying to run. The best way to understand what
the actions are is to look at the rd-audit.log.
the actions are is to look at the rundeck-audit.log.
This will show all the options as they're being evaluated.

## `<context>` Element

...is currently ignored.

The RunDeck source code and all documentation may be downloaded from
<https://github.com/dtolabs/rundeck/>.
37 changes: 20 additions & 17 deletions docs/en/manpages/man5/job-v20.5.md
@@ -1,4 +1,4 @@
% JOB-V20(1) RunDeck User Manuals | Version 1.0
% JOB-V20(5) RunDeck User Manuals | Version 1.0
% Alex Honor
% November 20, 2010

Expand Down Expand Up @@ -52,47 +52,43 @@ element is allowed.

*Nested elements*

id
[id](#id)

: job identifier

name
[name](#name-1)

: the job name

description
[description](#description)

: the job description

additional

: additional information

group
[group](#group)

: group name

context
[context](#context)

: command context

dispatch
[dispatch](#dispatch)

: dispatch options

sequence
[sequence](#sequence)

: workflow sequence

notification
[notification](#notification)

: email noticfications

nodefilters
[nodefilters](#nodefilters)

: node filtering expressions

loglevel
[loglevel](#loglevel)

: the logging level

Expand Down Expand Up @@ -488,11 +484,11 @@ excludeprecedence

*Nested elements*

include
[include](#include)

: include filter

exclude
[exclude](#exclude)

: exclude filter

Expand Down Expand Up @@ -719,3 +715,10 @@ recipients
*Example*

<email recipients="test@example.com,dev@example.com" />

# SEE ALSO

`rd-jobs` (1).

The RunDeck source code and all documentation may be downloaded from
<https://github.com/dtolabs/rundeck/>.
5 changes: 3 additions & 2 deletions docs/en/manpages/man5/resource-v10.5.md
@@ -1,4 +1,4 @@
% PROJECT-V10(1) RunDeck User Manuals | Version 1.0
% PROJECT-V10(5) RunDeck User Manuals | Version 1.0
% Alex Honor
% November 20, 2010

Expand Down Expand Up @@ -194,4 +194,5 @@ Reference a Port setting named "tomcatListenPort".




The RunDeck source code and all documentation may be downloaded from
<https://github.com/dtolabs/rundeck/>.

0 comments on commit abb2dc0

Please sign in to comment.