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