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
  22 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.
  23
  24 Dependencies
  25 ------------
  26
  27 None
  28
  29 Example Playbook
  30 ----------------
  31
  32 Including 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
  35       vars:
  36         rundeck_api_url: rundeck.example.com
  37         rundeck_project: test
  38         rundeck_jobs_path: /tmp/rundeck-jobs
  39       roles:
  40         - rundeck-jobs
  41
  42 License
  43 -------
  44
  45 TBD
  46
  47 Author Information
  48 ------------------
  49
  50 FretLink, Love and Truck