{"id":13644573,"url":"https://github.com/twitter/scoot","last_synced_at":"2025-12-14T16:50:11.429Z","repository":{"id":37502430,"uuid":"48396966","full_name":"twitter/scoot","owner":"twitter","description":"Scoot is a distributed task runner, supporting both a proprietary API and Bazel's Remote Execution.","archived":false,"fork":false,"pushed_at":"2025-06-19T15:28:30.000Z","size":9883,"stargazers_count":357,"open_issues_count":7,"forks_count":46,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-07-04T16:15:04.687Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/twitter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-12-21T22:14:54.000Z","updated_at":"2025-06-19T15:13:29.000Z","dependencies_parsed_at":"2023-08-26T17:16:32.747Z","dependency_job_id":null,"html_url":"https://github.com/twitter/scoot","commit_stats":null,"previous_names":["scootdev/scoot"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/twitter/scoot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twitter%2Fscoot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twitter%2Fscoot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twitter%2Fscoot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twitter%2Fscoot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/twitter","download_url":"https://codeload.github.com/twitter/scoot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twitter%2Fscoot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263611430,"owners_count":23488391,"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":[],"created_at":"2024-08-02T01:02:08.249Z","updated_at":"2025-12-14T16:50:11.385Z","avatar_url":"https://github.com/twitter.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Scoot\n[![GoDoc](https://godoc.org/github.com/twitter/scoot?status.svg)](https://godoc.org/github.com/twitter/scoot)\n[![Build Status](https://github.com/twitter/scoot/workflows/ci/badge.svg)](https://github.com/twitter/scoot/actions)\n[![GoReportCard](https://goreportcard.com/badge/github.com/twitter/scoot)](https://goreportcard.com/report/github.com/twitter/scoot)\n[![codecov.io](https://codecov.io/github/twitter/scoot/coverage.svg?branch=master)](https://codecov.io/gh/twitter/scoot?branch=master)\n\nScoot is a distributed task runner.\nThe core concept of Scoot is the Snapshot, which represents an immutable filesystem state.\nScoot allows for execution of commands against input Snapshots to create new output Snapshots.\n\n### Scoot Components\n\n###### Scheduler\n\nThe Scheduler receives and distributes jobs to workers, and maintains state. It is also responsible for serving the Cloud Scoot API for clients.\n\n###### Worker\n\nThe Worker (workerserver) receives information about jobs and runs them, and is responsible for all Snapshot-related functionality.\n\n###### Client APIs\n\n* Cloud Scoot API\n* Worker API\n\n###### Jobs and Tasks\n\nScoot work is broken down into independent jobs, which can consist of one or more tasks, which are executed sequentially.\n\n#### Go Version\n\nScoot is intended to work with go modules. If this repository is on your GOPATH, please set **GO111MODULE=on** when\nworking with go tools in this repository, and preferably use the Go distribution pinned in the .github/workflows/ci.yml file.\n\n### Example\n\nSetup a scheduler and worker nodes locally:\n\n```sh\ngo run ./setup-cloud-scoot/main.go --strategy local.local\n```\n\nRun a series of randomly generated tests against the local scheduler and workers:\n\n```sh\ngo run ./scheduler/client/scootcl/main.go smoke_test\n```\n## Scoot Integration Tests\nScoot has a few  tests that exercise varying levels of common usages and workflows.\n\n### Smoketest\nInvokes a scoot client directly to run jobs against a local cluster and waits for the \nscheduled jobs to complete.\n\n(./scheduler/client/cli/smoketest.go)\n\n### Recoverytest\nInvokes a scoot client directly to run jobs against a local cluster, kills the cluster, \nattempts to spin up a new one, and waits for the originally scheduled jobs to complete.\n\n(./binaries/recoverytest/main.go)\n\n### Integration\nInvokes a scoot and scoot-snapshot-db client via CLI to run a job against a local cluster \nand waits for the job to complete\n\n(./binaries/scoot-integration/main.go)\n\n## Scoot Thrift Code\n__Thrift Prerequisites__\nInstall the Thrift tool and golang thrift repository locally using the following section.\n\n__Generating thrift files__\nSee documentation in thrift definition files for specific generation instructions, or `make thrift`.\n\n# Development Installation Instructions\n## Install 3rd party tools:\n### Thrift (version == 0.9.3)\nmacOS:\n```sh\nbrew install thrift@0.9\n```\n### Thrift for go:\ngo modules will take care of this\n\n## Install/Access Scoot Executables and libraries\nInstall binaries to $GOPATH/bin:\n\n```sh\nmake install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwitter%2Fscoot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwitter%2Fscoot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwitter%2Fscoot/lists"}