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

Rundeck jobs
=========

This role synchronize a directory containing yaml definition of jobs with a rundeck project

Requirements
------------

* `jmespath` python module

Role Variables
--------------

* `rundeck_jobs_path` path of the directory containing the job definition (mandatory).
* `rundeck_project` name of the rundeck project (mandatory).
* `rundeck_api_url` base url of api (mandatory).
* `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.

Dependencies
------------

None

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
      roles:
         - { role: rundeck-jobs, rundeck_api_url: rundeck.example.com, rundeck_project: test, rundeck_jobs_path: /tmp/rundeck-jobs }

License
-------

TBD

Author Information
------------------

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