]> git.immae.eu Git - github/fretlink/ansible-rundeck-jobs.git/blame - README.md
dhall: Add a basic dhall type to be able to configure the role
[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
030dd5c5 21
592f1948
PB
22A [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.
23
030dd5c5
GD
24Dependencies
25------------
26
27None
28
29Example Playbook
30----------------
31
32Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
33
34 - hosts: servers
73fc6fec
GD
35 vars:
36 rundeck_api_url: rundeck.example.com
37 rundeck_project: test
38 rundeck_jobs_path: /tmp/rundeck-jobs
030dd5c5 39 roles:
73fc6fec 40 - rundeck-jobs
030dd5c5
GD
41
42License
43-------
44
45TBD
46
47Author Information
48------------------
49
50FretLink, Love and Truck