{"id":18361110,"url":"https://github.com/progrhyme/grifork","last_synced_at":"2025-08-26T20:18:33.230Z","repository":{"id":56875343,"uuid":"68937490","full_name":"progrhyme/grifork","owner":"progrhyme","description":"Fast Propagative Task Runner","archived":false,"fork":false,"pushed_at":"2016-10-10T05:29:11.000Z","size":757,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-27T20:57:18.780Z","etag":null,"topics":["deployment","task-runner"],"latest_commit_sha":null,"homepage":"http://www.rubydoc.info/gems/grifork","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/progrhyme.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-22T15:55:06.000Z","updated_at":"2017-07-16T16:21:21.000Z","dependencies_parsed_at":"2022-08-20T22:00:41.403Z","dependency_job_id":null,"html_url":"https://github.com/progrhyme/grifork","commit_stats":null,"previous_names":["key-amb/grifork"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/progrhyme/grifork","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrhyme%2Fgrifork","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrhyme%2Fgrifork/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrhyme%2Fgrifork/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrhyme%2Fgrifork/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/progrhyme","download_url":"https://codeload.github.com/progrhyme/grifork/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrhyme%2Fgrifork/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272253420,"owners_count":24900904,"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","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["deployment","task-runner"],"created_at":"2024-11-05T22:31:51.653Z","updated_at":"2025-08-26T20:18:32.938Z","avatar_url":"https://github.com/progrhyme.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Gem Version](https://badge.fury.io/rb/grifork.svg)](https://badge.fury.io/rb/grifork)\n[![Build Status](https://travis-ci.org/key-amb/grifork.svg?branch=master)](https://travis-ci.org/key-amb/grifork)\n\n# grifork\n\nFast propagative task runner for systems which consist of a lot of servers.\n\n# Concept\n\n**Grifork** runs defined tasks on the system in a way like tree's branching.  \nGive **grifork** a list of hosts, then it creates a tree graph internally, and runs\ntasks in a top-down way.\n\n**Grifork** has two modes to work:\n\n1. **Standalone** mode. This requires **grifork** program only on the root server\nin the tree graph: i.e. the server which invokes tasks.\n1. **Grifork** mode. On the other hand, this requires **grifork** program to work\non every node in the graph.\n\nTake a look at each mechanism.\n\n## Standalone Mode\n\nThe image below illustrates a 3-depth tree of 13 nodes including root node.\n\n![standalone mode](https://raw.githubusercontent.com/key-amb/grifork/resource/images/standalone_mode2.png)\n\nWe are running a task to copy a file tree to every host.  \n1st stage is completed: to copy them to nodes in 1st generation.\n\nNow at 2nd stage, root node logins each of its children by _ssh_ and kicks _rsync_\nprogram there, in order to copy the file tree from 1st to 2nd generation.\n\nNOTE:\n\n- Max concurrency of running task in **standalone** mode is the number of nodes\nat the generation which holds max.\nThis is the last genaration or the genartion before the last.\n\n## Grifork Mode\n\nThe image below is similar to previous situation except that this is in **grifork** mode.\n\n![grifork mode](https://raw.githubusercontent.com/key-amb/grifork/resource/images/grifork_mode2.png)\n\nIn this mode, parent nodes in the graph invokes _grifork_ command on every child\nnode via _ssh_, giving the graph tree which descends from each child node.\n\n# System Requirements\n\n- Ruby v2\n- ssh, rsync\n\n# Installation\n\n```sh\ngit clone https://github.com/key-amb/grifork.git\ncd grifork\nbundle\n```\n\n# Usage\n\n```sh\nedit Griforkfile\n./bin/grifork [--[f]ile path/to/Griforkfile] [-n|--dry-run]\n```\n\n## Griforkfile\n\n**Griforkfile** is DSL file for _grifork_ which configures and defines the tasks\nto be executed by _grifork_.\n\nHere is a small example:\n\n```ruby\nbranches 4\nlog file: 'grifork.log'\nhosts ['web1.internal', 'web2.internal', 'db1.internal', 'db2.internal', ...]\n\nlocal do\n  rsync '/path/to/myapp/'\nend\n\nremote do\n  rsync_remote '/path/to/myapp/'\nend\n```\n\nIf you run `grifork` with this _Griforkfile_, it just syncs `/path/to/myapp/` in\nlocalhost to target `hosts` by `rsync` command.\n\nSee [example](https://github.com/key-amb/grifork/tree/master/example) directory for more examples of _Griforkfile_.\n\nAnd refer to [Grifork::DSL](http://www.rubydoc.info/gems/grifork/Grifork/DSL) as API document of _Griforkfile_.\n\n# Authors\n\nIKEDA Kiyoshi \u003cyasutake.kiyoshi@gmail.com\u003e\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2016 IKEDA Kiyoshi\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrhyme%2Fgrifork","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprogrhyme%2Fgrifork","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrhyme%2Fgrifork/lists"}