https://github.com/pangeo-data/pangeo-binder

Pangeo + Binder (dev repo for a binder/pangeo fusion concept)
https://github.com/pangeo-data/pangeo-binder

binderhub dask jupyter-notebook jupyterhub pangeo

Last synced: 21 days ago
JSON representation

Pangeo + Binder (dev repo for a binder/pangeo fusion concept)

• Host: GitHub
• URL: https://github.com/pangeo-data/pangeo-binder
• Owner: pangeo-data
• License: bsd-3-clause
• Created: 2018-08-16T05:10:43.000Z (over 6 years ago)
• Default Branch: staging
• Last Pushed: 2021-07-23T21:51:25.000Z (almost 4 years ago)
• Last Synced: 2024-01-25T21:44:12.256Z (over 1 year ago)
• Topics: binderhub, dask, jupyter-notebook, jupyterhub, pangeo
• Language: Python
• Homepage: http://binder.pangeo.io
• Size: 770 KB
• Stars: 18
• Watchers: 12
• Forks: 13
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
Pangeo's BinderHub

==================

Deployment and configuration documentation files for the public binder.pangeo.io service.

# Deployment Status

Branch | Build | Docs | Deployment

-- |-- | -- | --

staging | [![CircleCI](https://circleci.com/gh/pangeo-data/pangeo-binder/tree/staging.svg?style=svg)](https://circleci.com/gh/pangeo-data/pangeo-binder/tree/staging) | [![Documentation Status](https://readthedocs.org/projects/pangeo-binder/badge/?version=staging)](https://pangeo-binder.readthedocs.io/en/staging/?badge=staging) | https://staging.binder.pangeo.io/

prod | [![CircleCI](https://circleci.com/gh/pangeo-data/pangeo-binder/tree/prod.svg?style=svg)](https://circleci.com/gh/pangeo-data/pangeo-binder/tree/prod) | [![Documentation Status](https://readthedocs.org/projects/pangeo-binder/badge/?version=prod)](https://pangeo-binder.readthedocs.io/en/prod/?badge=prod) | https://binder.pangeo.io/

# Binder Monitoring

Monitoring of the binderhubs is done with 

[Prometheus](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus)

and

[Grafana](https://github.com/grafana/helm-charts/tree/main/charts/grafana).

- [AWS Binder Grafana Site](https://staging.aws-uswest2-binder.pangeo.io/grafana/?orgId=1)

- [GCP Binder Grafana Site](https://staging.binder.pangeo.io/grafana/?orgId=1)

# About Pangeo's Binder

Much like [mybinder.org](https://mybinder.org), the [Pangeo's](https://pangeo.io/) BinderHub deployment ([binder.pangeo.io](https://binder.pangeo.io/)) allows users to create and share custom computing environments. The main distinction between the two BinderHubs is that Pangeo's BinderHub allows users to perform scalable computations using Dask.

For more information on the Pangeo project, check out the [online documentation](http://pangeo-binder.readthedocs.io/).

## How to Deploy:

This repo is continuously deployed using [CircleCI](https://circleci.com/gh/pangeo-data/pangeo-binder). It can also be deployed from a local computer using the following command:

```

deployment={staging,prod}  # choose one

helm upgrade --wait --install --namespace=${deployment} ${deployment} \

    pangeo-binder --version=v0.2.0 \

    -f ./deploy/${deployment}.yaml \

    -f ./secrets/${deployment}.yaml

```

## More Information

The setup and configuration of Pangeo's BinderHub largely follows the [Zero to Binderhub](https://binderhub.readthedocs.io/en/latest/) instructions. A few key distinctions are present:

1. We define our own chart, [pangeo-binder](https://github.com/pangeo-data/pangeo-binder/tree/staging/pangeo-binder), so that we can mix in some Pangeo specific bits (e.g. a RBAC for dask-kubernetes). The pangeo-binder chart is based on the binderhub chart but most settings are indented under the `binderhub` chart level. The mybinder.org project does the same thing in [mybinder.org-deploy](https://github.com/jupyterhub/mybinder.org-deploy).

2. The deployment steps in [section 3.4 of the Zero to Binderhub documentation](https://binderhub.readthedocs.io/en/latest/setup-binderhub.html#install-binderhub) are modified slightly to account for the pangeo-binder chart. The steps are briefly outlined below:

    ```

    # get current versions of the chart dependencies

    cd pangeo-binder

    helm dependency update

    # install the pangeo-binder chart

    helm install pangeo-binder --version=0.2.0-...  --name= --namespace= -f secret.yaml -f config.yaml

    ```

## Additional Links and Related Projects

- Pangeo Project: http://pangeo.io/

- Pangeo-Binder Issue Tracker: https://github.com/pangeo-data/pangeo-binder/issues

- Zero to BinderHub Documentation: https://binderhub.readthedocs.io/en/latest/

- MyBinder Documentation: https://mybinder.readthedocs.io/en/latest/

## Testing Binder Updates

We deploy `staging` and `prod` BinderHubs. Before re-deploying `prod` by merging

`staging` into `prod`, it's a good idea to test the deployment on some real-world

examples.

Create an empty pull request against the `staging` branch with the text

`test-staging` in the commit message.

.. code-block:: console

   $ git checkout -b test-staging

   $ git commit --allow-empty -m 'test staging'

   $ git push -u origin

Once that pull request is opened, the script in ``.github/workflows/scripts/run_staging.py``

is run. That will run the latest versions of the notebooks in http://gallery.pangeo.io/

against

1. The staging binder deployment (e.g. https://staging.binder.pangeo.io/)

2. The staging Docker image (e.g. https://github.com/pangeo-gallery/default-binder/tree/staging)