]> git.immae.eu Git - github/fretlink/ansible-rundeck-jobs.git/blame - README.md
Unmask Job creation error
[github/fretlink/ansible-rundeck-jobs.git] / README.md
CommitLineData
030dd5c5
GD
1Rundeck jobs
2=========
3
4This role synchronize a directory containing yaml definition of jobs with a rundeck project
5
6Requirements
7------------
8
93ed8f13 9* `jmespath` python module
030dd5c5
GD
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.
c3e54982 20* `rundeck_jobs_group` the group of job to check for removal
95a202dc 21* `rundeck_ignore_creation_errors` whether to ignore job creation error. Default to true to follow the 200 statu given by rundeck API
030dd5c5 22
592f1948
PB
23A [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.
24
030dd5c5
GD
25Dependencies
26------------
27
28None
29
30Example Playbook
31----------------
32
33Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
34
35 - hosts: servers
73fc6fec
GD
36 vars:
37 rundeck_api_url: rundeck.example.com
38 rundeck_project: test
39 rundeck_jobs_path: /tmp/rundeck-jobs
030dd5c5 40 roles:
73fc6fec 41 - rundeck-jobs
030dd5c5
GD
42
43License
44-------
45
95a202dc 46BSD
030dd5c5
GD
47
48Author Information
49------------------
50
51FretLink, Love and Truck