Skip to content
This repository has been archived by the owner on Feb 4, 2018. It is now read-only.

Scripts for creating preconfigured Binder clusters with one command

License

Notifications You must be signed in to change notification settings

binder-project/binder-launch

Repository files navigation

💨 💨 The Binder Project is moving to a new repo. 💨 💨

📚 Same functionality. Better performance for you. 📚

Over the past few months, we've been improving Binder's architecture and infrastructure. We're retiring this repo as it will no longer be actively developed. Future development will occur under the JupyterHub organization.

Thanks for updating your bookmarked links.

💨 💨 The Binder Project is moving to a new repo. 💨 💨


binder-launch

Scripts for creating preconfigured Binder clusters with one command

install

npm install binder-launch

getting started using GCE

Launching a Binder cluster on GCE is the easiest way to get started (and it's also the way Binder is running in production). Any Binder deployment will require at least 3 small compute instances, which can get expensive if left running -- before launching the cluster, verify that the resources being created match your budget.

setup

binder-launch contains a script that will configure a complete Binder cluster on Google Compute Engine. To use this script:

  1. Create an account on GCE, make a new project and ensure billing is set up correctly for that project. We'll assume this project is called 'binder-project' in the rest of the instructions
  2. Initialize Google Compute Engine for the new project
  3. Download the gcloud utility by following the instructions here
  4. Log into the GCE service: gcloud init
  5. gcloud config set project binder-project

launch

npm run launch

The utility should prompt you for cluster configuration information during the launch process

WARNING: the script will output how many compute instances it is creating, so be sure to understand the estimated monthly cost of that cluster before leaving it running

destroy

npm run destroy

WARNING: check the resources that exist in your project after the destroy command has been run, just in case...

About

Scripts for creating preconfigured Binder clusters with one command

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published