]> git.immae.eu Git - github/fretlink/ansible-rundeck-jobs.git/blob - README.md
Merge pull request #1 from gaetanfl/first_version
[github/fretlink/ansible-rundeck-jobs.git] / README.md
1 Rundeck jobs
2 =========
3
4 This role synchronize a directory containing yaml definition of jobs with a rundeck project
5
6 Requirements
7 ------------
8
9 * `jmespath` python module
10
11 Role 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
21 Dependencies
22 ------------
23
24 None
25
26 Example Playbook
27 ----------------
28
29 Including 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 vars:
33 rundeck_api_url: rundeck.example.com
34 rundeck_project: test
35 rundeck_jobs_path: /tmp/rundeck-jobs
36 roles:
37 - rundeck-jobs
38
39 License
40 -------
41
42 TBD
43
44 Author Information
45 ------------------
46
47 FretLink, Love and Truck