Skip to main content

Run FireWorks workflows in Google Cloud

Project description

Borealis

Runs FireWorks workflows on Google Compute Engine (GCE).

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.

Background

You can launch as many FWorker 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 my_launchpad.yaml file supply the MongoDB host, port, and DB name. Users can share a MongoDB server, and each user can have multiple DB names -- each an independent space for workflows and worker 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 FWorker.

Team Setup

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, ...

Run

TODO

Change Log

v0.1.1 - 2020-02-13

  • Correct the pip name in startup.sh.
  • Use print() instead of logging in 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

borealis-fireworks-0.1.1.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

borealis_fireworks-0.1.1-py2.py3-none-any.whl (29.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file borealis-fireworks-0.1.1.tar.gz.

File metadata

  • Download URL: borealis-fireworks-0.1.1.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.0

File hashes

Hashes for borealis-fireworks-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e2f7472123326386ca688eea9393428ced6402b287bdbe32a0d9139a4eb6d7e5
MD5 21568618803087185c8869a0e69548b9
BLAKE2b-256 a3b1248e91ed60be88d6313a874a1507715a34ffedafb0d0759e8d027edb28cb

See more details on using hashes here.

File details

Details for the file borealis_fireworks-0.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: borealis_fireworks-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.0

File hashes

Hashes for borealis_fireworks-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c1ab862a5b945d32c34a72b8d270c2bf7e508e7513956c1dac33237dbd4b8a03
MD5 e6dfad64125fbd26ef61b3bac2f1eb25
BLAKE2b-256 6592d4990005d3f1c4a33bf5054318d286d95a1fd44d5662f43b3e3c2afad892

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page