README
¶
Spin Cycle: Automating the Tedious
Spin Cycle automates and exposes complex infrastructure tasks to other teams and services. This allows a few engineers to quickly and reliably manage thousands of resources—platform automation at scale.
Spin Cycle can do anything you can program. The database team at Square uses it to provision and decommission databases, safely stop and start hosts, upgrade MySQL and Docker images, reconfigure services, and more.
To learn more, check out the Spin Cycle docs.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config provides structs describing Request Manager and Job Runner YAML config files.
|
Package config provides structs describing Request Manager and Job Runner YAML config files. |
|
dev
|
|
|
jobs
Example/development jobs repo.
|
Example/development jobs repo. |
|
Package errors provides errors reported to the user.
|
Package errors provides errors reported to the user. |
|
Package job provides job-related interfaces, data structures, and errors.
|
Package job provides job-related interfaces, data structures, and errors. |
|
Package client provides an HTTP client for interacting with the Job Runner (JR) API.
|
Package client provides an HTTP client for interacting with the Job Runner (JR) API. |
|
api
Package api provides controllers for each api endpoint.
|
Package api provides controllers for each api endpoint. |
|
chain
Package chain implements a job chain.
|
Package chain implements a job chain. |
|
runner
Package runner implements running a job.
|
Package runner implements running a job. |
|
server
Package server bootstraps and runs the Job Runner.
|
Package server bootstraps and runs the Job Runner. |
|
status
Package status provides system-wide status.
|
Package status provides system-wide status. |
|
Package jobs implements all SpinCycle jobs and a factory to create them.
|
Package jobs implements all SpinCycle jobs and a factory to create them. |
|
Package proto provide API message structures and constants.
|
Package proto provide API message structures and constants. |
|
Package rm provides an HTTP client for interacting with the Request Manager (RM) API.
|
Package rm provides an HTTP client for interacting with the Request Manager (RM) API. |
|
api
Package api provides controllers for each api endpoint.
|
Package api provides controllers for each api endpoint. |
|
auth
Package auth provides request authentication and authorization.
|
Package auth provides request authentication and authorization. |
|
id
Package id provides an interface for generating ids.
|
Package id provides an interface for generating ids. |
|
joblog
Package joblog provides an interface for reading and writing job logs.
|
Package joblog provides an interface for reading and writing job logs. |
|
request
Package request provides an interface for managing requests.
|
Package request provides an interface for managing requests. |
|
resources/migrations
This package holds migration files which, when all applied in order, result in a database schema identical to that described in request_manager_schema.sql.
|
This package holds migration files which, when all applied in order, result in a database schema identical to that described in request_manager_schema.sql. |
|
server
Package server bootstraps and runs the Request Manager.
|
Package server bootstraps and runs the Request Manager. |
|
status
Package status provides system-wide status.
|
Package status provides system-wide status. |
|
Package spinc provides a framework for integration with other programs.
|
Package spinc provides a framework for integration with other programs. |
|
app
Package app provides app-wide data structs and functions.
|
Package app provides app-wide data structs and functions. |
|
cmd
Package cmd provides all the commands that spinc can run: start, status, etc.
|
Package cmd provides all the commands that spinc can run: start, status, etc. |
|
config
Package config handles config files, -config, and env vars at startup.
|
Package config handles config files, -config, and env vars at startup. |
|
prompt
Prompt provides user input handling.
|
Prompt provides user input handling. |
|
Package test provides helper functions for tests.
|
Package test provides helper functions for tests. |
|
util
|
|
|
Package version provides the Spin Cycle version.
|
Package version provides the Spin Cycle version. |
Click to show internal directories.
Click to hide internal directories.