Giter Site home page Giter Site logo

task's Introduction

task

pipeline

travis

readthedocs

Ansible role to run arbitrary tasks.

avatar

Full documentation on Readthedocs.

Source code on:

Github.

Gitlab.

Part of:

doombot

Ingredients

ingredient

Contents

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

# Or:
# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.task
      user_tasks:
        - https://is.gd/vVCfKI
      expand: false

# 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

If you want to run the tests, you will also need:

Compatibility

License

MIT. See the LICENSE file for more details.

Links

UML

Deployment

The full project structure is shown below:

deploy

Main

The project data flow is shown below:

main

Author

author

The Travelling Vaudeville Villain.

Enjoy!!!

enjoy

task's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.