Merge pull request #19 from ismaelbouyaf/parametrize-vault

[github/fretlink/ansible-rundeck-jobs.git] / README.md

diff --git a/README.md b/README.md
index 2304d7515b7a5b70af8decd313f0de5e3cee596c..8a5f903a329ad4b6f2a369f8861080b42b428f8b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ This role synchronize a directory containing yaml definition of jobs with a rund
 Requirements
 ------------
 
-None
+* `jmespath` python module
 
 Role Variables
 --------------
@@ -17,6 +17,10 @@ Role Variables
 * `rundeck_api_token` the authentification token (mandatory).
 * `rundeck_api_version` api version supported by rundeck server. Default to 26.
 * `rundeck_remove_missing` Whether to delete jobs present in rundeck and not in file. Defaults to true.
+* `rundeck_jobs_group` the group of job to check for removal
+* `rundeck_ignore_creation_errors` whether to ignore job creation error. Default to true to follow the 200 status given by rundeck API
+
+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.
 
 Dependencies
 ------------
@@ -29,13 +33,17 @@ Example Playbook
 Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
 
     - hosts: servers
+      vars:
+        rundeck_api_url: rundeck.example.com
+        rundeck_project: test
+        rundeck_jobs_path: /tmp/rundeck-jobs
       roles:
-         - { role: rundeck-jobs, rundeck_api_url: rundeck.example.com, rundeck_project: test, rundeck_jobs_path: /tmp/rundeck-jobs }
+        - rundeck-jobs
 
 License
 -------
 
-TBD
+BSD
 
 Author Information
 ------------------