]> git.immae.eu Git - github/fretlink/ansible-rundeck-jobs.git/blobdiff - README.md
Merge pull request #20 from ismaelbouyaf/remove-undeclared-keys
[github/fretlink/ansible-rundeck-jobs.git] / README.md
index 3c96d1eae973a6d3f27f386078a37e612ba6e6ad..9962610f75a9563aa10e44865a091091fa6eba34 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,6 +17,14 @@ 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
+* `rundeck_jobs_keys` a list of keys to import in rundeck. Each key is a dict with a `path`, a `value` and a `type` as declared in [https://docs.rundeck.com/3.0.x/api/index.html#upload-keys]().
+* `rundeck_keys_scoped_by_project` scope each key by project (In a project/ProjectName subdirectory)
+* `rundeck_keys_scoped_by_group` scope each key by group. Defaults to true if the group is defined, false otherwise
+* `rundeck_remove_missing_keys` remove keys that are not declared in ansible (possibly restrained to the scope defined above)
+
+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 +37,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
 ------------------