Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Add a page with the features we support #53

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[WIP] Add a page with the features we support #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 60 additions & 0 deletions about/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Features

This page lists all the features our hubs can provide you.

## Authentication

These login methods are supported currently:

- Google Auth
- GitHub Auth

2i2c maintains a list of 'admins' for each hub, and they can manage
the active list of users who can log in at any time.

We also support *ephemeral* hubs, which are mybinder.org-like - they
let anyone log in without needing any authentication, and provide no
persistence.

## Admin access

Each hub has a list of 'admins', who can do the following actions:

1. Add / remove users who can log in
2. Write to `~/shared-readwrite` folder, which is then readable at `~/shared` for everyone else
3. Access any user's home directory & notebook server via the admin panel

## User Environment

We have a basic one fit for education, and you can bring your own -
any docker image would do. Currently, any updates to the docker image
used will need to be changed as a PR in the 2i2c repo.

## Home directories

Each user gets a persistent directory at `$HOME`.

## Shared directory

Each hub has a `~/shared` readonly directory where common datasets & code can be provided to all users. Admins also have a `~/shared-readwrite` directory that is writeable. Anything admins put in `~/shared-readwrite` will show up immediately in `~/shared`

## Hub home page

Currently, you can customize the following in your home page:

1. Logo
2. Link to your project
3. Information about who is funding the hub, running the hub & designing the hub

## dask-gateway

Available only on 'dask' hubs.

A [dask-gateway](https://gateway.dask.org/) cluster, backed by a pre-emptible node pool for your dask workers.

## Scratch Bucket

Available only on 'dask' hubs.

A GCS bucket is provisioned for each hub, and all users can use it as a
'scratch' space for intermediate results. It's wiped every 7 days automatically. Can be accessed via the env variable `$SCRATCH_BUCKET` or `$PANGEO_SCRATCH`
3 changes: 2 additions & 1 deletion index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ See the sections below (or to the left) for more information.
about/overview
about/infrastructure
about/projects
about/features
```

```{toctree}
Expand All @@ -34,4 +35,4 @@ admin/content
:maxdepth: 1
:caption: User's Guide
users/interface
```
```