1.0k GitHub stars and counting — pinterest/pinball is a JavaScript project TopGit is tracking across repositories on the platform. Pinball is a scalable workflow manager
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
If you want to install Pinball through pypi package, please do ::
$ sudo pip install pinball
Pinball uses mysql as persistent storage. Please also make sure mysql is available, and properly configured.
Quick Start
Start Pinball
Once Pinball is installed either through pypi package installation or source code clone, we are ready to run it. There are four important components in Pinball.
* **Master**: A frontend to a persistent state repository with an interface supporting atomic job token updates. To start master, ::
$ python -m pinball.run_pinball -c path/to/pinball/yaml/configuration/file -m master
* **UI**: A service reading directly from the storage layer used by the Master. To start UI, ::
$ python -m pinball.run_pinball -c path/to/pinball/yaml/configuration/file -m ui
* **Scheduler**: Scheduler is responsible for running workflows on a schedule. To start scheduler, ::
$ python -m pinball.run_pinball -c path/to/pinball/yaml/configuration/file -m scheduler
* **Worker**: A client of the Master. To start worker, ::
$ python -m pinball.run_pinball -c path/to/pinball/yaml/configuration/file -m workers
Configure Pinball
In order to start Pinball, user needs to provide a pinball configuration file. A sample pinball configuraiton can be retrived at here_.
parser tells Pinball how to interpret your defined workflow and jobs. The above configuration links to a Python parser_ provided by Pinball.
You can also provide your own parser to intepretate your own definition of workflow and jobs. Please check the tutorial for details. ::
parser_params will be taken by parser. Name of the variable that stores workflows config is workflows_config;
root dir of the repo that stores all user defined jobs is stored at job_repo_dir; job_import_dirs_config keeps list of
dirs where job class should be imported from.
default_email configures default sender of email service of Pinball.
Use Pinball
After starting Pinball with the proper configuration, user can access Pinball at *pinball:8080*.
You may find there is no workflow or jobs listed in Pinball UI when you first start Pinball. To import your workflow into Pinball,
do the following command. ::
python -m pinball.tools.workflow_util -c path/to/pinball/yaml/configuration/file -f reschedule
After this, you should be able to see your workflows in Pinball UI. They will be scheduled and run according to the specified schedules.
.. image:: instance_view.png
:alt: Workflow Instance View
Detailed Design
-------------
Design details are available in `Pinball Architecture Overview <https://github.com/pinterest/pinball/blob/master/ARCHITECTURE.rst>`_
User Guide
-----------------
Detail user guide is available in `Pinball User Guide <https://github.com/pinterest/pinball/blob/master/USER_GUIDE.rst>`_
Admin Guide
------------------
Administrator guide is available in `Pinball Administrator Guide <https://github.com/pinterest/pinball/blob/master/ADMIN_GUIDE.rst>`_
License
-------
Pinball is distributed under `Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`_.
Maintainers
----------
* `Pawel Garbacki <https://github.com/pgarbacki>`_
* `Mao Ye <https://github.com/MaoYe>`_
* `Changshu Liu <https://github.com/csliu>`_
Contributing
-----------
* `Contributors <https://github.com/pinterest/pinball/blob/master/AUTHORS.rst>`_
* `How to contribute <https://github.com/pinterest/pinball/blob/master/CONTRIBUTING.rst>`_
Help
-----
If you have any questions or comments, you can reach us at `[email protected] <https://groups.google.com/forum/#!forum/pinball-users>`_.
No homepage URL was recorded for pinterest/pinball in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
Does pinterest/pinball have any tags?
TopGit's last sync did not record any GitHub topics for pinterest/pinball. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on pinterest/pinball?
The most recent commit recorded on pinterest/pinball was 6.9 years ago, based on the GitHub push timestamp. The repository has 125 forks — one of the better signals of community interest.
How many stars does pinterest/pinball have?
pinterest/pinball has 1.0k GitHub stars — refresh the page for the live number, or check github.com/pinterest/pinball. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is pinterest/pinball open source?
Yes — pinterest/pinball ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/pinterest/pinball.
Where do I read more about pinterest/pinball?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/pinterest/pinball is the definitive source.
Read full README in the tab above.
Is pinball worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of pinball.