{"id":16300999,"url":"https://github.com/melezhik/sparrowup","last_synced_at":"2026-05-04T05:32:59.519Z","repository":{"id":150532613,"uuid":"64132357","full_name":"melezhik/sparrowup","owner":"melezhik","description":"Launch sparrowdo scenarios on remote hosts","archived":false,"fork":false,"pushed_at":"2016-08-06T20:15:09.000Z","size":661,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-15T14:15:59.232Z","etag":null,"topics":["sparrowdo","ui","web"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/melezhik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-25T12:26:07.000Z","updated_at":"2017-05-29T06:15:39.000Z","dependencies_parsed_at":"2023-07-16T08:45:11.979Z","dependency_job_id":null,"html_url":"https://github.com/melezhik/sparrowup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melezhik%2Fsparrowup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melezhik%2Fsparrowup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melezhik%2Fsparrowup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melezhik%2Fsparrowup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/melezhik","download_url":"https://codeload.github.com/melezhik/sparrowup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120652,"owners_count":21050984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sparrowdo","ui","web"],"created_at":"2024-10-10T20:53:15.285Z","updated_at":"2026-05-04T05:32:54.499Z","avatar_url":"https://github.com/melezhik.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SYNOPSIS\n\nLaunch sparrowdo scenarios on remote hosts.\n\n# Prerequisites\n\nSparrowdo should be installed on the same hosts where sparrowup service gets run.\n\n# INSTALL\n\n    $ panda install Sparrowdo\n    $ git clone https://github.com/melezhik/sparrowup.git\n    $ cd sparrowup\n    $ carton\n\n\n# Configuration\n\n## Set up sparrowdo repository\n\nYou should checkout some sparrowdo scenarios:\n\n    $ git clone $some-remote-repository /path/to/repo\n\nA structure of  repository should be:\n\n    $ project-foo/sparrowfile\n    $ project-bar/sparrowfile\n    $ project-baz/sparrowfile\n\nSo on ...\n\n## Set up sparrowup service configuration file. \n\nThis is should be Mojolicious::Config file placed at /etc/sparrowup.conf path.\n\n    $ cat /etc/sparrowup.conf\n\n    {\n      'repo' =\u003e '/home/sparrowup/sparrowup_repo',\n      'reports_dir' =\u003e '/home/sparrowup/reports'\n    }\n    \nConfiguration parameters:\n\n### repo\n\nPath to the directory with sparrowdo scenarios\n\n## reports_dir\n\nA directory where reports data will be kept. Should be writable by sparrowup service.\n\n\n## Populate database\n\n    $ bash utils/populate_db.bash\n\n## Run sparrowup service\n\nThis is a mojo application, thus:\n\n    $ carton exec morbo app.pl\n\n## Run job queue \n\nA minion asynchronous job executor should be launched to handle incoming job requests.\n\nFor example:\n\n    $ carton exec ./app.pl minion worker \n\nFollow Minion [documentation](https://metacpan.org/pod/Minion) for details on minion job queue.\n\n# sparrowup API\n\nAll the API is exposed as http service API accessible by 0.0.0.0:3000. A bind address / port number could be changed\nwhen running service via [morbo](https://metacpan.org/pod/distribution/Mojolicious/script/morbo), follow morbo documentation.\n\n## Schedule a job\n\nPOST $server /job/$project\n\nwhere $server is ip address or hostname, $project is project name ( a proper directory should exist in repository )  \n\nExample:\n\n    # Checks if nginx is running on 192.168.0.1\n\n    $ cat /path/to/repo/nginx/sparrowfile\n\n    task_run  %(\n      task =\u003e 'check my nginx process',\n      plugin =\u003e 'proc-validate',\n      parameters =\u003e %(\n        pid_file =\u003e '/var/run/nginx.pid',\n        footprint =\u003e 'nginx.*master'\n      )\n    );\n    \n    $ curl -d 'server=192.168.0.0.1' 127.0.0.1:3000/job/nginx\n\n\n## Advanced usage. \n\nSetting sparrowdo client parameters.\n\nYou may pass additional parameters consuming by sparrowdo client:\n\n### verbose\n\nEnable verbose mode. Useful when debugging sparrowdo scenarios.\n\n\n### ssh_user\n\nA ssh_user ID\n\n### ssh_port\n\nA server ssh port to connect to\n\nFollow [sparrowdo documentation](https://github.com/melezhik/sparrowdo#sparrowdo-client-command-line-parameters)\nto know more about sparrowdo client parameters.\n\nFor example:\n\n    $ curl -d server=192.168.0.0.1 -d ssh_user=vagrant -d ssh_port=2222  127.0.0.1:3000/check/nginx\n\n## Get a server status\n\nGET /status/$server\n\nOnce job is scheduled it's queued and eventually will be executed.\n\nFor example:\n\n    $ curl -d 'server=192.168.0.0.2' 127.0.0.1:3000/job/perl-app\n    $ sleep 10\n    $ curl -G -d server=192.168.0.2 127.0.0.1:3000/status?server=192.168.0.2\n\n## Reports\n\nAll generated reports are accessible via service Web UI:\n\n    $ firefox 127.0.0.1:3000\n\n# See also\n\n* [Sparrowdo/Sparrow](https://sparrowhub.org)\n\n* [Mojolicious](http://mojolicio.us)\n\n* [morbo](https://metacpan.org/pod/distribution/Mojolicious/script/morbo)\n\n* [Minion](https://metacpan.org/pod/Minion)\n\n# AUTHOR\n\n[Alexey Melezhik](mailto:melezhik@gmail.com)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelezhik%2Fsparrowup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmelezhik%2Fsparrowup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelezhik%2Fsparrowup/lists"}