aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 43 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9f78f6c..2304d75 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
1# ansible-rundeck-jobs 1Rundeck jobs
2Synchronize rundeck jobs from a dir with a rundeck project 2=========
3
4This role synchronize a directory containing yaml definition of jobs with a rundeck project
5
6Requirements
7------------
8
9None
10
11Role Variables
12--------------
13
14* `rundeck_jobs_path` path of the directory containing the job definition (mandatory).
15* `rundeck_project` name of the rundeck project (mandatory).
16* `rundeck_api_url` base url of api (mandatory).
17* `rundeck_api_token` the authentification token (mandatory).
18* `rundeck_api_version` api version supported by rundeck server. Default to 26.
19* `rundeck_remove_missing` Whether to delete jobs present in rundeck and not in file. Defaults to true.
20
21Dependencies
22------------
23
24None
25
26Example Playbook
27----------------
28
29Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
30
31 - hosts: servers
32 roles:
33 - { role: rundeck-jobs, rundeck_api_url: rundeck.example.com, rundeck_project: test, rundeck_jobs_path: /tmp/rundeck-jobs }
34
35License
36-------
37
38TBD
39
40Author Information
41------------------
42
43FretLink, Love and Truck