Run FireWorks workflows in Google Cloud
See the repo Borealis.
- Borealis is the git repo name.
- borealis-fireworks is the PyPI package name.
- borealis-fireworker.service is the name of the systemd service.
- fireworker is the recommended process username and home directory name.
You can launch as many Fireworker nodes as you want as Google Compute Engine (GCE) VM
instances, and/or run local workers, as long as they can all connect to the LaunchPad
server running MongoDB. Metadata parameters and the worker's
file (if that file doesn't exist, then
my_launchpad.yaml) configure the
MongoDB host, port, and DB name. Users can have their own DB names on a shared
MongoDB server, and each user can have multiple DB names -- each an independent
launchpad space for workflows and their Fireworker nodes.
Workers get Fireworks from the LaunchPad, run them in "rapidfire" mode, and eventually time out and shut themselves down.
Workers can run any Firetasks that are loaded on their disk images, but the best fit is to run the DockerTask Firetask. DockerTask pulls task input files from Google Cloud Storage (GCS), runs a payload task as a shell command within a Docker container, and pushes task output files to GCS.
DockerTask parameters include the Docker image to pull, the command shell tokens to run in the Docker container, and its input and output files and directories.
DockerTask pulls the inputs from and pushes the outputs to Google Cloud Storage (GCS). This avoids needing a shared NFS file service which costs 10x as much as GCS storage and doesn't scale as well.
Using a Docker image lets you bundle up the payload task with its entire runtime, e.g. Python version, pips, Linux apts, and config files. Your workflow can use one or more Docker images, and they're isolated from the Fireworker.
TODO: Install & configure dev tools, create a GCP project, auth stuff, install MongoDB on a GCE VM or set up Google-managed MongoDB, create a Fireworker disk image & image family, ...
Individual Developer Setup
TODO: Install & configure dev tools, make a storage bucket with a globally-unique name, build a Docker image to run, ...
v0.3.2 - 2020-02-17
- Add info to the logs.
v0.3.1 - 2020-02-17
- Python 2 compatibility fixes.
- Explain the
ConnectionErrorthat arises when
fireworkercan't contact the Docker server.
v0.3.0 - 2020-02-14
- Move the setup files from
- Add a
fireworker --setupoption to print the setup path to simplify the steps to copy those files when setting up a server Disk Image.
- Add a
fireworker -l <launchpad_filename>option for compatibility with
lpad. The default is back to
- Add a
gce -l <launchpad_filename>option, like
lpad, to read the db name, username, and password when creating VMs. The default is
v0.2.1 - 2020-02-13
- Bug fix in the
v0.2.0 - 2020-02-13
- Read launchpad config info from
gce_my_launchpad.yamlif possible, falling back to
my_launchpad.yamlfor compatibility with previous releases. This lets people use one launchpad config file for their GCE workflows and another one for their other workflows.
- Improve the server installation steps and augment the
fireworker --helptext to display its directory.
v0.1.1 - 2020-02-13
- Correct the pip name in
loggingin gce.py so the messages aren't filtered by the log level.
- Refine the installation instructions.
v0.1.0 - 2020-02-10
- Initial dev build.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size borealis_fireworks-0.3.2-py2.py3-none-any.whl (31.0 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View hashes|
|Filename, size borealis-fireworks-0.3.2.tar.gz (27.6 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for borealis_fireworks-0.3.2-py2.py3-none-any.whl