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 Dependencies
  23 ------------
  24
  25 None
  26
  27 Example Playbook
  28 ----------------
  29
  30 Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
  31
  32     - hosts: servers
  33       vars:
  34         rundeck_api_url: rundeck.example.com
  35         rundeck_project: test
  36         rundeck_jobs_path: /tmp/rundeck-jobs
  37       roles:
  38         - rundeck-jobs
  39
  40 License
  41 -------
  42
  43 TBD
  44
  45 Author Information
  46 ------------------
  47
  48 FretLink, Love and Truck