]> git.immae.eu Git - github/fretlink/ansible-rundeck-jobs.git/blob - README.md
9962610f75a9563aa10e44865a091091fa6eba34
[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 * `rundeck_jobs_group` the group of job to check for removal
21 * `rundeck_ignore_creation_errors` whether to ignore job creation error. Default to true to follow the 200 status given by rundeck API
22 * `rundeck_jobs_keys` a list of keys to import in rundeck. Each key is a dict with a `path`, a `value` and a `type` as declared in [https://docs.rundeck.com/3.0.x/api/index.html#upload-keys]().
23 * `rundeck_keys_scoped_by_project` scope each key by project (In a project/ProjectName subdirectory)
24 * `rundeck_keys_scoped_by_group` scope each key by group. Defaults to true if the group is defined, false otherwise
25 * `rundeck_remove_missing_keys` remove keys that are not declared in ansible (possibly restrained to the scope defined above)
26
27 A [dhall](https://dhall-lang.org/) Type representing the roles' variables is available in the `./dhall/Config.dhall` file to help you configure your projects with some type checking.
28
29 Dependencies
30 ------------
31
32 None
33
34 Example Playbook
35 ----------------
36
37 Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
38
39 - hosts: servers
40 vars:
41 rundeck_api_url: rundeck.example.com
42 rundeck_project: test
43 rundeck_jobs_path: /tmp/rundeck-jobs
44 roles:
45 - rundeck-jobs
46
47 License
48 -------
49
50 BSD
51
52 Author Information
53 ------------------
54
55 FretLink, Love and Truck