Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/melezhik/sparrow
Sparrow - script distribution platform for Linux OS
https://github.com/melezhik/sparrow
automation cli outthentic-plugins sparrow sparrow-client sparrow-plugin sparrow-task task-runner
Last synced: about 2 months ago
JSON representation
Sparrow - script distribution platform for Linux OS
- Host: GitHub
- URL: https://github.com/melezhik/sparrow
- Owner: melezhik
- Created: 2015-11-24T12:03:28.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-01-13T14:39:08.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T20:53:57.170Z (2 months ago)
- Topics: automation, cli, outthentic-plugins, sparrow, sparrow-client, sparrow-plugin, sparrow-task, task-runner
- Language: Perl
- Homepage: https://sparrowhub.org
- Size: 810 KB
- Stars: 77
- Watchers: 9
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
Awesome Lists containing this project
README
# NAME
Sparrow - multipurpose scenarios manager.
# ATTENTION
***This is Sparrow for Perl5 and it is no longer supported and deprecated.***
***If you're looking for Sparrow6 - Raku version of Sparrow, see [Sparrow6](https://github.com/melezhik/Sparrow6)***
***If you still want to use this version follow [Sparrow](https://metacpan.org/pod/Sparrow)
for the latest CPAN release. However, pay attention that:***
* ***All [Sparrow plugins](https://github.com/melezhik/sparrow-plugins) are only compatible with Sparrow6 version.***
* ***SparrowHub repository is abolished and no longer exists***
# SYNOPSIS
# Install
$ sudo yum install git # only required for installing private plugins
$ sudo yum install curl
$ cpanm Sparrow
# Build statuses
[](https://travis-ci.org/melezhik/sparrow)
[](https://ci.appveyor.com/project/melezhik/sparrow)
# Sparrow plugins
Sparrow plugins are shareable multipurpose scenarios distributed via central repository - [SparrowHub](https://sparrowhub.org).
Every single plugin represents a various scripts to solve a specific task. Plugins are easily installed, configured and run on
dedicated servers with the help of sparrow console client.
The notion of sparrow plugins is very close to the conception of CPAN modules in Perl or Ruby gems in Ruby.
It's just a small suites of scripts to solve a specific tasks.
Supported plugin types.
Sparrow supports two types of plugins depending on underlying runner to execute plugin scenarios. They are:
* [Outthentic](https://github.com/melezhik/outthentic) Plugins
* [SWAT](https://github.com/melezhik/swat) Plugins
To find a specific sparrow plugin say this:
$ sparrow plg search nginx
To install a sparrow plugin say this:
$ sparrow plg install nginx-check
See [sparrow command line API](#api) below.
# Sparrow client
`Sparrow` is a console client to search, install, setup and run various sparrow plugins.
Think about it as of `cpan client` for CPAN modules or `gem client` for Ruby gems.
You run Sparrow client by using `sparrow` command.
To print out Sparrow currently installed version, run this:
$ sparrow --version
# Sparrow basic entities
Sparrow architecture comprises of 4 basic parts:
* Plugins
* Tasks
* Projects
* Task Boxes
# Tasks
_Task_ is configurable sparrow plugin. Some plugins does not require configuration and could be run as is,
but many ones require some piece of input data. Thus sparrow task is a container for:
* plugin
* plugin configuration
Plugin configuration is just a text file in one of 4 formats:
* [Config::General](https://metacpan.org/pod/Config::General) format - consumed by Outthentic plugins
* YAML format - consumed by both Swat and Outthentic plugins
* JSON format - consumed by Outthentic plugins
* [Config::Tiny](https://metacpan.org/pod/Config::Tiny) format - consumed by Swat plugins
# Projects
Projects are _logical groups_ of sparrow tasks. It is convenient to split a whole list of tasks to different logical groups.
Like some tasks for system related issues - f.e. checking [disk available space](https://sparrowhub.org/info/df-check) or inspecting [stale processes](https://sparrowhub.org/info/stale-proc-check), other tasks for
web services related issues - f.e. [checking nginx health](https://sparrowhub.org/info/nginx-check) or [monitoring http errors](https://sparrowhub.org/info/logdog) in web server logs, so on.
# Task Boxes
Sparrow tasks boxes are JSON format files to describe sequential tasks to run.
You could think about sparrow boxes as of multi tasks. Sparrow runs tasks from the box sequentially.
# API
This is a sparrow command line API documentation.
## Projects API
Sparrow project is a logical group of sparrow tasks. To create a project use `sparrow project create` command:
**sparrow project create $project\_name**
Command examples:
# system level tasks
$ sparrow project create system
# web servers related tasks
$ sparrow project create web-servers
To get project information say this:
**sparrow project show $project\_name**
For example:
$ sparrow project show system
To get projects list say this:
**sparrow project list**
To remove project data say this:
**sparrow project remove $project\_name**
For example:
$ sparrow project remove web-servers
***NOTE!*** This command will remove all project tasks as well!
## Plugins API
To search available plugins use `sparrow plg search` command:
**sparrow plg search $pattern**
Where $pattern is Perl regular expression pattern.
Examples:
# find ssh-* plugins
$ sparrow plg search ssh
[found sparrow plugins]
type name
public ssh-sudo-check
public ssh-sudo-try
public sshd-check
# find package managers plugins
$ sparrow plg search package
[found sparrow plugins]
type name
public package-generic
To list all available plugins say this:
$ sparrow plg search
### Index API
Sparrow index is cached data used by sparrow to search plugins.
Index consists of two parts:
* private plugins index , see [SPL file](#spl-file) section for details
* public plugins index, [PUBLIC PLUGINS](#public-plugins) section for details
There are two basic command to work with index:
* **sparrow index summary**
This command will show timestamps and file locations for public and private index files.
* **sparrow index update**
This command will fetch fresh index from SparrowHub and update local cached index.
This is very similar to what `cpan index reload` command does.
You need `sparrow index update` to get know about updates, changes of SparrowHub repository. For example
when someone release new version of plugin.
See [public plugins](#public-plugins) section for details on sparrow public plugins and SparrowHub.
### Installing sparrow plugins
**sparrow plg install $plugin\_name**
For example:
$ sparrow plg search nginx # to get know available nginx* plugins
$ sparrow plg install nginx-check # to download and install a chosen plugin
$ sparrow plg install nginx-check --version 0.1.1 # install specific version
Installing plugin from local source:
$ cd /plg/src/ && sparrow plg install /path/to/source --local
Install plugin from local source recursively:
$ sparrow plg install /path/to/plugins --local --recursive
This command will recursively go through /path/to/plugins directory and for every directory containing
`sparrow.json` file runs `sparrow plg install .` command.
Forcefully reinstall plugin
Use `force` flag to reinstall local plugins:
$ sparrow plg install /path/to/source --local --recursive --force
$ sparrow plg install /path/to/plugins --local --force
Reinstall plugins dependencies
Use `install-deps`.. It only works with public plugins:
$ sparrow plg install cpan-upload --install-deps
To see installed plugin list say this:
$ sparrow plg list
To get installed plugin information say this:
**sparrow plg show $plugin\_name**
To remove plugin installed use `sparrow plg remove` command:
**sparrow plg remove $plugin\_name**
For example:
$ sparrow plg remove df-check
### Getting plugin man page
If plugin author supply his plugin with man page it could be shown as:
**sparrow plg man $plugin\_name**
For example:
$ sparrow plg man df-check
Aliase. `info` and `help` are just aliases for `plg man` command:
$ sparrow plg info df-check
$ sparrow plg help df-check
## Tasks API
### Create tasks
To create a task use `sparrow task add` command:
**sparrow task add $project\_name $task\_name $plugin\_name [opts]**
Tasks always belong to projects, so to create a task you have to create a project first if not exists.
Tasks binds a plugin with configuration, so to create a task you have to install a plugin first.
Command examples:
$ sparrow project create system
$ sparrow plg install df-check
$ sparrow task add system disk-health df-check
Options:
* --quiet - suppress output of this command.
For example:
$ sparrow task add system disk-health df-check --quiet 1
* --host - pass hostname parameter.
It's useful when create tasks for swat plugins
$ sparrow task add web nginx-check swat-nginx --host 127.0.0.1:80
### Getting task list
To list all the task with projects use:
**sparrow task list**
You can filter tasks out by using `--search` options:
# list tasks with project name or task name matching `database` and `production` strings
$ sparrow task list --search database --search production
# you can use Perl5 regexps in --search filters:
$ sparrow task list --search database --search '(test|dev)'
### Run plugins
There are two ways to run sparrow plugins:
* as\_is
* as tasks
The first one is simplest as it does not require creating a task at all. If you don't want provide a specific plugin configuration,
you may run a plugin as is using `sparrow plg run` command:
**sparrow plg run [ parameters ]**
For example:
$ sparrow plg run df-check
Parameters:
* **verbose**
Sets verbose mode to get some extra message when running plugin
The second way requires task creation and benefits in applying specific configuration for a plugin:
**sparrow task run $project\_name $task\_name [ parameters ]**
For example:
$ sparrow task run system disk-health
See [configuring tasks](#configuring-tasks) section on how one can configure task plugin.
Parameters:
* **verbose**
### Setting runtime parameters
***NOTE!*** Runtime parameters are only supported for Outthentic plugins.
It is possible to pass _whatever_ runtime configuration parameters when running tasks or plugins:
$ sparrow plg run df-check --param threshold=60
$ sparrow task run system disk-health --param threshold=60
# or even nested and multi parameters!
$ sparrow plg run foo --param foo.bar.baz=60 --param id=100
Runtime parameters override default parameters ones set in tasks configurations, see [configuring tasks](#configuring-task) section.
### Setting plugin runner parameters
When executing sparrow plugin sparrow relies on underlying runner defined by plugin type. There are two types of sparrow plugins:
* Outthentic Plugins
* SWAT Plugins
Both runners accept specific parameters.
For outthentic runner parameters follow [Outthentic](https://github.com/melezhik/outthentic#options) documentation.
For swat runner parameters follow [Swat](https://github.com/melezhik/swat#swat-runner) documentation.
Here are some examples:
# outthentic plugins:
$ sparrow task run system/disk-health --format concise --purge-cache
$ sparrow task run system/disk-health --debug 2
# swat plugins:
$ sparrow task run web/nginx-check --prove -Q
### Running tasks with cron
When running tasks with cron it is handy only have an output if something goes wrong,
f.e. if plugin failed for some reasons. Use `--cron` flag to enable this behavior:
**sparrow task run $project\_name $task\_name --cron**
Running task with --cron flag suppress a normal output and only emit something in case of failures.
Example:
$ sparrow task system disk-health --cron # pleas keep quite if disk space is ok
### Configuring tasks
Task configuration is a some input parameters consumed by plugin binded to task.
User should consult plugin documentation to get know a certain structure of configuration data to feed.
Sparrow supports two configuration formats:
* Config::Tiny ( Swat plugins )
* Config::General ( Outthentic plugins )
* YAML ( Outthentic and Swat plugins )
* JSON ( Outthentic plugins )
Use `task ini` command to set task configuration:
**sparrow task ini $project\_name $task\_name**
For example:
$ export EDITOR=nano
# Config::General format
$ sparrow task ini system disk-health
# disk used threshold in %
threshold = 80
# JSON format
$ sparrow task ini system disk-health
{
"threshold": 80
}
# YAML format
$ sparrow task ini system disk-health
# disk used threshold in %
threshold: 80
Having this sparrow will save plugin configuration in the file related to task and will use it during task run:
$ sparrow task run system disk-health # the value of threshold is 80
User could copy existed configuration from file using `task load_ini` command:
**sparrow task load_ini $project\_name $task\_name /path/to/ini/file**
For example:
$ sparrow task load_ini system disk-health /etc/plugins/disk.yaml # load from YAML file
$ sparrow task load_ini system disk-health /etc/plugins/disk.json # load from JSON file
$ sparrow task load_ini system disk-health /etc/plugins/disk.conf # load from Config::General file
To get task configuration use `sparrow task show` command:
**sparrow task show $project\_name $task\_name**
For example:
$ sparrow task show system disk-health
Alternative way to configure sparrow task is to load configuration from yaml/json file _during_ task run:
$ cat disk.yml
---
threshold: 80
$ sparrow task run system disk --yaml disk.yml
$ cat disk.json
{
"threshold": 80
}
$ sparrow task run system disk --json disk.json
While `sparrow task ini/load_ini` command saves task configuration and makes it persistent,
`sparrow task run --yaml|--json` command applies plugin configuration only for runtime and won't save it after plugin execution.
For common usage, when user runs tasks manually first approach is more convenient,
while the second one is a _way automatic_, when tasks configurations are kept as yaml files
and maintained out of sparrow scope and applied during task run.
### Removing tasks
Use this command to remove task from the project container:
**sparrow task remove $project\_name $task\_name**
Examples:
# remove task disk-health project system
$ sparrow task remove system disk-health
### Alternative task names notation
When working with task you may use an alternative task names notation:
$project_name/$task_name
Examples:
$ sparrow task run system/disk
$ sparrow task show system/disk
$ sparrow task remove system/disk
$ sparrow task ini system/disk
# so on ...
### Dump task configuration
You may dump task configuration using `--dump-config` flag, no action will be performed,
just task configuration data will be printed out in JSON format:
$ sparrow task run system/disk --dump-config
Dump-config could be useful when copy some task configuration into other:
$ sparrow task run system/disk --dump-config > /tmp/system-disk.json
$ nano /tmp/system-disk.json
$ sparrow task load ini system/disk2 /tmp/system-disk.json
### Copy task
If you need to copy existed task to another project use `task copy` command:
***sparrow task copy project1 task project2 task2***
This command copies task `task1` from project `project1` to project named `project2`
and give it a name `task2`
You can use alternative task notation here:
$ sparrow task copy project1/task1 project2/task2
### Save/Restore tasks
To port tasks from one server to another use `save|restore` command:
$ sparrow task save /var/data/tasks
$ sparrow task restore /var/data/tasks
**sparrow task save /path/to/tasks/dir**
Sparrow `task save` command accept path to directory where existing tasks get dumped and saved to.
**sparrow task restore /path/to/tasks/dir**
Likewise sparrow `task restore` command accept path to directory with tasks to restore.
`Merge` option.
By default `sparrow task save` remove existing data ( if found ) from target directory. You disable this
behavior by passing `--merge` option:
$ sparrow task save /var/data/tasks --merge # add currents tasks to existed in /var/data/tasks
Ignore tasks.
You can omit some project/tasks from resulted save using `task.ignore` file:
$ nano ~/task.ignore
project1/task1
project2/task2
This will exclude the project1/task2 and project2/task2 tasks from resulted save. You can use regexp here:
$ nano ~/task.ignore
project1/.* # any tasks from project1
project2/task[2-9] # tasks 2 .. 9 from project2
The format of task ignore file:
project_name/task_name
Where `project_name` and `task_name` could be full names or regexps.
You may specify alternative location for task ignore file using `--ignore` option:
$ sparrow task save /var/data/tasks --ignore /etc/task.ignore
The default location for task ignore file is `~/task.ignore`
Other options:
- `--quiet` - makes output less verbose
## Task boxes API
Run task box - collection of sparrow tasks.
**sparrow box run $path [opts]**
Where $path is the path to task box specification file ( json or yaml format).
## The structure of task box specification file ( outthentic plugins ):
JSON:
[
{ // task1
"task" : "task1_name",
"plugin" : "plugin_name",
"data" : { // plugin parameters
"param1" : "value1",
"param2" : "value2"
}
},
{ // task2
"task" : "task2_name",
"plugin" : "plugin_name",
"data" : { // plugin parameters
"param1" : "value1",
"param2" : "value2"
}
}
// so on
]
YAML:
---
# task1
- task: task1_name
plugin: plugin name
data:
param1: value1
param2: value2
# task2
- task: task2_name
plugin: plugin_name
data:
param1: value1
param2: value2
# so on
Command example:
$ sparrow box run /var/sparrow/boxes/nginx.json
$ sparrow box run /var/sparrow/boxes/nginx.yaml
Task box specification file example:
JSON:
[
{
"task" : "install favorite packages",
"plugin" : "package_generic",
"data" : {
"list" : "nano curl mc hunspell"
}
},
{
"task" : "setup git",
"plugin" : "git-base",
"data" : {
"email" : "[email protected]", "name" : "Alexey Melezhik"
}
}
]
YAML:
---
- task: disk check
plugin: df-check
data:
threshold: 95
- task: disk check
plugin: df-check
data:
threshold: 95
- task: test plugin
plugin: foo-generic
data: {}
- task: test ruby plugin
plugin: ruby-test
data: {}
## The structure of tasks box specification file ( swat plugins ):
JSON:
[
// task1
{
"task" : "task1_name",
"plugin" : "plugin_name",
"type" : "swat",
"host" : "http host"
},
// task2
{
"task" : "task2_name",
"plugin" : "plugin_name",
"type" : "swat",
"host" : "http host"
}
// so on
]
YAML:
---
# task1
- task: task1_name
plugin: plugin_name
type: swat
host: http host
# task2
- task: task2_name
plugin: plugin_name
type: swat
host: http host
# so on
## Sparrow box run parameters
To make command output less verbose ( suppress some details ) use `--mode quiet` option:
$ sparrow box run /path/to/my/box/ --mode quiet
# Sparrow plugins
Sparrow plugins are shareable multipurpose scenarios installed from remote sources.
There are two type of sparrow plugins:
* public plugins are provided by [SparrowHub](https://sparrowhub.org/) community repository and considered as public access.
* private plugins are provided by internal or external git repositories and _not necessary_ considered as public access.
Both public and private plugins are installed with help of sparrow client:
**sparrow plg install plugin_name**
## Public plugins
The public plugins features:
* they are kept in a central place called [SparrowHub](https://sparrowhub.org/) - community plugins repository.
* they are versioned so you may install various version of a one plugin.
## Private plugins
Private plugins are ones created by you and not supposed to be accessed publicly.
The private plugins features:
* they are kept in arbitrary remote git repositories ( public or private ones )
* they are not versioned, a simple \`git clone/pull' command is executed to install/update a plugin
* private plugins could be used by two methods:
1) by SPL file
2) by custom sparrow repository ( aka remote SPL file )
### SPL file
SPL file is located at `\~/sparrow.list' and contains lines in the following format:
*$plugin\_name $git\_repo\_url*
Where:
* git\_repo\_url
Is a remote git repository URL
* plugin\_name
A name of your sparrow plugin, could be arbitrary name but see restriction notice concerning public plugin names.
Example entries:
package-generic https://github.com/melezhik/package-generic.git
Once you add a proper entries into SPL file you may list and install a private plugins:
$ sparrow index update
$ sparrow plg show package-generic
### Custom sparrow repository
Custom sparrow repository is abstraction for _remote SPL file_.
To use existed custom repository add this to sparrow configuration file:
$ cat ~/sparrow.yaml
repo: 192.168.0.1:4441
This entry defines a custom repository accessible at remote host 192.168.0.1 port 4441
Once custom repository is set up you search and install custom repository plugins the same
way as with private plugins defined at SPL file.
To run your own sparrow custom reposository use [Sparrow::Nest](https://github.com/melezhik/sparrow-nest) module.
# Developing sparrow plugins
As sparrow support two types of plugins - swat and outthentic, follow a related documentation pages on
how to create _scenarios suites_ to gets packaged and distributes as a sparrow plugin:
* For developing outthentic scenarios suites follow [Outthentic documentation](https://github.com/melezhik/outthentic).
* For developing swat scenarios suites follow [Swat documentation](https://github.com/melezhik/swat).
# Publishing public sparrow plugin to SparrowHub
Once a plugin is create you should do 4 simple steps:
* get registered on SparrowHub and create a token
* setup sparrowhub.json file
* create a plugin meta file - sparrow.json
* upload a plugin with the help of `sparrow plg upload` command
## Get registered on SparrowHub
Go to [https://sparrowhub.org/sign_up](https://sparrowhub.org/sign_up) and create an account
## Generate a token
Login into SparrowHub, go to Profile page and hit "Regenerate Token" on [https://sparrowhub.org/token](https://sparrowhub.org/token) page.
## Setup sparrowhub.json
Once your get you token, setup a sparrowhub credentials on the machine where you are going upload plugin from:
$ cat ~/sparrowhub.json
{
"user" : "melezhik",
"token" : "ADB4F4DC-9F3B-11E5-B394-D4E152C9AB83"
}
***NOTE!*** Another way to provide SparrowHub credentials is to set `$sph_user` and `$sph_token` environment variables:
$ export sph_user=melezhik
$ export sph_token=ADB4F4DC-9F3B-11E5-B394-D4E152C9AB83
## Create a plugin meta file sparrow.json
Sparrow.json file holds plugin meta information required for plugin gets uploaded to SparrowHub.
Create sparrow.json file and place it in a plugin root directory:
{
"name": "df-check",
"version": "0.1.1",
"plugin_type" : "outthentic"
"description" : "elementary file system checks using df utility report ",
"url" : "https://github.com/melezhik/df-check",
}
This is description of sparrow.json parameters:
* name - plugin name.
Only symbols \`a-zA-Z1-9_-.' are allowable in plugin name. This parameter is obligatory, no default value.
* version - Perl version string.
This parameter is obligatory. A detailed information concerning version syntax could be find here - [https://metacpan.org/pod/distribution/version/lib/version.pm](https://metacpan.org/pod/distribution/version/lib/version.pm)
* plugin_type - one of two - `outthentic|swat` - sets plugin internal runner.
This parameter is obligatory. Default value is `outthentic`.
* url - a plugin web site http URL
This parameter is optional and could be useful when you want to refer users to plugin documentation site.
* description - a short description of a plugin.
This one is optional, but very appreciated.
* python_version - sets Python language version.
If you install pip modules targeted for Python3 you may set python_version in sparrow.json file:
python_version : 3
That makes `sparrow plg install` command use `pip3` ( not `pip` ) to install dependencies by requirements.txt file
* sparrow_version - sets minimal version of Sparrow required by plugin.
This is mostly useful for Sparrow developers. Some plugins may rely on the latest versions of Sparrow and
couldn't run correctly on the older versions, to avoid any confusion plugins developers may declare
a minimum version of Sparrow so that if the target machine does have it an exception will be raised
instead of plugin execution when `sparrow plg run` command is invoked.
## Upload plugin
* Install sparrow client on your machine
$ cpanm Sparrow
* Go to directory where your plugin source code at and say:
$ sparrow plg upload
That's it!
If you want to troubleshoot upload plugin errors use `--verbose` flag, when upload plugin.
# Publishing private sparrow plugins
The process is almost the same as for public plugins, except you don't have to provide SparrowHub credentials
and gets registered as you host your plugin at remote git repository.
You have to do 3 simple steps:
* create a plugin and commit it into local git repository, plugin root directory should be repository root directory
* create plugin meta file - sparrow.json and commit it into local git repository ( sparrow.json file is the same as for public plugins )
* push your changes into remote git repository
# Declaring dependencies
This is the way how one can declare dependencies for sparrow plugins:
+----------+-------------------+
| Language | File |
+----------+-------------------+
| Perl | cpanfile |
| Ruby | Gemfile |
| Python | requirements.txt |
+----------+-------------------+
You should place a dependency file into a plugin root directory.
# Disable color output
To every action you may optionally add `--nocolor` flag to disable color output:
$ sparrow plg run df-check --nocolor
# Sparrow client configuration file
This file should be placed at $SPARROW_ROOT/sparrow.yaml path ( see next section on SPARROW\_ROOT ).
Configuration options:
* repo
Custom sparrow repository
* format
Defines format for outthentic reports, possible values are: `default|concise|production`
# Environment variables
## SPARROW_ROOT
Sets sparrow root directory.
If set than sparrow will be looking sparrow index, SPL and configuration files at following locations:
$SPARROW_ROOT/sparrow.index
$SPARROW_ROOT/sparrow.list
$SPARROW_ROOT/sparrow.yaml
As well as projects, tasks and plugins data will be kept at $SPARROW_ROOT directory.
For example:
$ export SPARROW_ROOT=/opt/sparrow
## SPARROW\_NO\_COLOR
Disable color output.
$ export SPARROW_NO_COLOR=1
Also see "Disable color output" section.
## SPARROW_CONF_PATH
If set defines an alternative location for sparrow configuration file.
## sparrow_hub_api_url
Sets alternative location of SparrowHub API. If not set Sparrow client uses https://sparrowhub.org as API URL.
Primarily used for internal testing and development. But also see [offline mode support](#offline-mode-support) section.
## SPARROW_UNSECURE
Disable ssl verification during `sparrow plg upload, sparrow remote task run` commands. Use this option on your risk.
# Remote Tasks
***WARNING!*** This feature is quite experimental and should be tested.
Remote tasks are sparrow tasks SparrowHub users could _bind_ to theirs accounts:
$ sparrow project create utils
$ sparrow task add utils git-setup git-base
$ sparrow task ini utils git-setup
email [email protected]
name 'Alexey Melezhik'
$ sparrow task run utils git-setup
Ok, now we could "wrap" our task and upload to our account:
$ sparrow remote task upload utils/git-setup
***NOTE!*** to upload remote task you need a SparrowHub account.
Then I ssh-ing to another server to re-apply my git configuration:
$ ssh some-other-host
$ sparrow remote task install utils/git-setup
Now I can:
$ sparrow task run utils git-setup
Pretty cool, huh? :)))
A shortcut for `sparrow remote task install ... & sparrow task run` is:
$ sparrow remote task run utils/git-setup
## Share your task
_By default_ remote task uploaded to SparrowHub is only accessible by task author. This is so called
private remote task. What if you want to share some fun stuff with people? - _Share_ your task:
$ sparrow remote task share utils/nano-rc
Now users can use your remote task:
$ sparrow remote task install melezhik@utils/nano-rc
$ sparrow task run utils utils nano-rc
or using shortcut in single step:
$ sparrow remote task run melezhik@utils/nano-rc
***NOTE!*** you don't need a SparrowHub account to use public remote tasks, even unregisters users can use
public remote tasks.
## Hide your task
Want to hide your task again? Not a problem:
$ sparrow remote task hide app/passwords
Now only you can use app/passwords task.
## Add useful comments to task
When doing remote task upload you optionally can add a comment which will be show
when task gets listed with `sparrow remote task list` command:
$ sparrow remote task upload utils/nano-rc 'makes nano.rc setup'
## List remote tasks
To list your remote tasks ( both private and public ) say this:
$ sparrow remote task list
## List public tasks
To get a list of available public remote tasks say this:
$ sparrow remote task public list
## Remove remote task
And finally you can remove remote task:
$ sparrow remote task remove app/old-stuff
# Offline mode support
For servers with limited or no access to internet, there is offline mode support.
## Create local repository of Sparrow plugins
$ mkdir -p sparrow-local-repo/api/v1
$ mkidr -p sparrow-local-repo/plugins
## Copy index file and plugins
$ curl https://sparrowhub.org/api/v1/index -o sparrow-local-repo/api/v1/index
$ curl https://sparrowhub.org/plugins/python-echo-script-v0.001000.tar.gz -o sparrow-local-repo/plugins/python-echo-script-v0.001000.tar.gz
$ # so on
## Set sparrow\_hub\_api\_url
$ export sparrow_hub_api_url=$PWD/sparrow-local-repo
Now Sparrow client will be looking for local repository instead of making requests to internet.
# AUTHOR
[Aleksei Melezhik](mailto:[email protected])
# Home page
[https://github.com/melezhik/sparrow](https://github.com/melezhik/sparrow)
# Copyright
Copyright 2015 Alexey Melezhik.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
# See also
* [SWAT](https://github.com/melezhik/swat) - Simple Web Application Test framework.
* [Outthentic](https://github.com/melezhik/outthentic) - Multipurpose scenarios framework.
# Thanks
To God as the One Who inspires me to do my job!