constrict0r.task
task
.. image:: https://gitlab.com/constrict0r/task/badges/master/pipeline.svg :alt: pipeline
.. image:: https://travis-ci.com/constrict0r/task.svg :alt: travis
.. image:: https://readthedocs.org/projects/task/badge :alt: readthedocs
Ansible role to run arbitrary tasks.
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/avatar.png :alt: avatar
Full documentation on Readthedocs <https://task.readthedocs.io>_.
Source code on:
Github <https://github.com/constrict0r/task>_.
Gitlab <https://gitlab.com/constrict0r/task>_.
Part of: <https://gitlab.com/explore/projects?tag=doombot>_
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/doombot.png :alt: doombot
Ingredients
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/ingredient.png :alt: ingredient
Contents
Description <#Description>_Usage <#Usage>_Variables <#Variables>_expand <#expand>_user_tasks <#user-tasks>_configuration <#configuration>_
YAML <#YAML>_Attributes <#Attributes>_item_expand <#item-expand>_item_path <#item-path>_
Requirements <#Requirements>_Compatibility <#Compatibility>_License <#License>_Links <#Links>_UML <#UML>_Deployment <#deployment>_Main <#main>_
Author <#Author>_
Description
Ansible role to run arbitrary tasks.
It allows to specify a task file or URL and this role will run it without having to write a playbook or another role.
This role performs the following actions:
Ensure the requirements are installed.
Update the apt cache.
Ensure dependencies are installed.
If the user_tasks variable is defined run each specified task.
If the configuration variable is defined and the user_tasks variable is defined, run each specified task.
Inside each specified task is possible to use the unified variable that will have the list of specified users.
This role expand files or URLs by default so you must write your items like:
::
user_tasks: - item_path: ['https://is.gd/uE0TTp'] item_expand: false
You can change this default behaviour by:
- Setting the expand variable to false.
Or
- Add to an item the attribute item_expand setted to true.
Usage
- To install and execute:
..
::
ansible-galaxy install constrict0r.task
ansible localhost -m include_role -a name=constrict0r.task -K
- Passing variables:
..
::
ansible localhost -m include_role -a name=constrict0r.task -K \
-e "{user_tasks: ['https://is.gd/uE0TTp']}"
- To include the role on a playbook:
..
::
- hosts: servers
roles:
- {role: constrict0r.task}
- To include the role as dependency on another role:
..
::
dependencies:
- role: constrict0r.task
user_tasks: ['https://is.gd/uE0TTp']
- To use the role from tasks:
..
::
- name: Execute role task.
import_role:
name: constrict0r.task
vars:
user_tasks: ['https://is.gd/uE0TTp']
To run tests:
::
cd task chmod +x testme.sh ./testme.sh
On some tests you may need to use sudo to succeed.
Variables
The following variables are supported:
expand
Boolean value indicating if load items from file paths or URLs or just treat files and URLs as plain text.
If set to true this role will attempt to load items from the especified paths and URLs.
If set to false each file path or URL found on user_tasks will be treated as plain text.
This variable is set to true by default.
::
ansible localhost -m include_role -a name=constrict0r.task
-e "expand=true configuration='/home/username/my-config.yml' titles='user_tasks'"
If you wish to override the value of this variable, specify an item_path and an item_expand attributes when passing the item, the item_path attribute can be used with URLs too:
::
ansible localhost -m include_role -a name=constrict0r.task
-e "{expand: false,
user_tasks: [
item_path: '/home/username/my-config.yml',
item_expand: false
], titles: 'user_tasks'}"
To prevent any unexpected behaviour, it is recommended to always specify this variable when calling this role.
user_tasks
Absolute file path or URL to a .yml file containing ansible tasks to execute.
Each file or URL on this variable will be checked to see if it exists and if it does, the task is executed.
This variable is empty by default.
::
Including from terminal.
ansible localhost -m include_role -a name=constrict0r.task -K -e
"{user_tasks: [item_path: https://is.gd/vVCfKI, item_expand: false]}"
Or:
Including from terminal.
ansible localhost -m include_role -a name=constrict0r.task -K -e
"{user_tasks: [https://is.gd/vVCfKI], expand: false}"
Including on a playbook.
- hosts: servers
roles:
- role: constrict0r.task
user_tasks:
- item_path: https://is.gd/vVCfKI item_expand: false
- role: constrict0r.task
user_tasks:
Or:
Including on a playbook.
- hosts: servers
roles:
- role: constrict0r.task
user_tasks:
- https://is.gd/vVCfKI expand: false
- role: constrict0r.task
user_tasks:
To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e
"{user_tasks: [item_path: https://is.gd/vVCfKI, item_expand: false]}"
Or:
To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e
"{user_tasks: [https://is.gd/vVCfKI], expand: false}"
configuration
Absolute file path or URL to a .yml file that contains all or some of the variables supported by this role.
It is recommended to use a .yml or .yaml extension for the configuration file.
This variable is empty by default.
::
Using file path.
ansible localhost -m include_role -a name=constrict0r.task -K -e
"configuration=/home/username/my-config.yml"
Using URL.
ansible localhost -m include_role -a name=constrict0r.task -K -e
"configuration=https://my-url/my-config.yml"
To see how to write a configuration file see the YAML file format section.
YAML
When passing configuration files to this role as parameters, it’s recommended to add a .yml or .yaml extension to the each file.
It is also recommended to add three dashes at the top of each file:
::
You can include in the file the variables required for your tasks:
::
user_tasks: - ['https://is.gd/uE0TTp']
If you want this role to load list of items from files and URLs you can set the expand variable to true:
::
user_tasks: /home/username/my-config.yml
expand: true
If the expand variable is false, any file path or URL found will be treated like plain text.
Attributes
On the item level you can use attributes to configure how this role handles the items data.
The attributes supported by this role are:
item_expand
Boolean value indicating if treat this item as a file path or URL or just treat it as plain text.
::
user_tasks: - item_expand: true item_path: /home/username/my-config.yml
item_path
Absolute file path or URL to a .yml file.
::
user_tasks: - item_path: /home/username/my-config.yml
This attribute also works with URLs.
Requirements
Ansible <https://www.ansible.com>_ >= 2.8.Jinja2 <https://palletsprojects.com/p/jinja/>_.Pip <https://pypi.org/project/pip/>_.Python <https://www.python.org/>_.PyYAML <https://pyyaml.org/>_.Requests <https://2.python-requests.org/en/master/>_.
If you want to run the tests, you will also need:
Docker <https://www.docker.com/>_.Molecule <https://molecule.readthedocs.io/>_.Setuptools <https://pypi.org/project/setuptools/>_.
Compatibility
Debian Buster <https://wiki.debian.org/DebianBuster>_.Debian Raspbian <https://raspbian.org/>_.Debian Stretch <https://wiki.debian.org/DebianStretch>_.Ubuntu Xenial <http://releases.ubuntu.com/16.04/>_.
License
MIT. See the LICENSE file for more details.
Links
Github <https://github.com/constrict0r/task>_.Gitlab <https://gitlab.com/constrict0r/task>_.Gitlab CI <https://gitlab.com/constrict0r/task/pipelines>_.Readthedocs <https://task.readthedocs.io>_.Travis CI <https://travis-ci.com/constrict0r/task>_.
UML
Deployment
The full project structure is shown below:
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/deploy.png :alt: deploy
Main
The project data flow is shown below:
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/main.png :alt: main
Author
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/author.png :alt: author
The Travelling Vaudeville Villain.
Enjoy!!!
.. image:: https://gitlab.com/constrict0r/img/raw/master/task/enjoy.png :alt: enjoy
ansible-galaxy install constrict0r.task