Skip to content

Commit

Permalink
Update shared responsibility and service docs (#148)
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf authored Jun 27, 2022
1 parent 17876be commit 95391ca
Show file tree
Hide file tree
Showing 21 changed files with 332 additions and 309 deletions.
2 changes: 1 addition & 1 deletion about/distributions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ By default all 2i2c JupyterHub get their own URL with the following form:
<hub-name>.<community-name>.2i2c.cloud
```

Each 2i2c JupyterHub has **hub name** (denoted by `<hub-name>`) and a **community name** (denoted by `<community-name>`). Communities are collections of hubs around a particular community or collaboration. Each community infrastructure may be run by different teams. For more information, see [](people-behind-hubs).
Each 2i2c JupyterHub has a **hub name** (denoted by `<hub-name>`) and a **community name** (denoted by `<community-name>`). Communities are collections of hubs around a particular community or collaboration. Each community infrastructure may be run by different teams. For more information, see [](../service/team.md).

It is also possible to provide your own URL that points to a 2i2c JupyterHub.

Expand Down
16 changes: 16 additions & 0 deletions about/infrastructure/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Infrastructure and features

These sections contain information about the technical and cloud infrastructure behind the {term}`Collaborative JupyterHub Service`.
They describe the major technologies that are used, what kinds of use-cases and workflows are possible, as well as some important considerations that may be relevant to your community.

```{toctree}
:maxdepth: 2
../distributions/index.md
security.md
```

```{figure} https://drive.google.com/uc?export=download&id=1vL8ekAtUQ4TEik4-oWIn36VAOITdlmpR
:width: 80%
A high-level technical overview of an Interactive Computing Service collaboratively run by 2i2c and a community of practice. Each hub is a JupyterHub Distribution with a collection of community-led open source projects that are customized for a particular use-case.
```
11 changes: 10 additions & 1 deletion about/security.md → about/infrastructure/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ This project follows the principle of "secure by default", and has a number of c

As members of the JupyterHub team, we are constantly looking for ways to improve [the security of Zero to JupyterHub](https://zero-to-jupyterhub.readthedocs.io/en/latest/administrator/security.html), and use our experience running these hubs to further improve JupyterHub's security.


## Data privacy

2i2c will not collect user data for any purpose beyond what is required in order to run a JupyterHub.
Depending on the choices of your community the hub might contain identifiable information (e.g., e-mail addresses used as usernames for authentication), but this will remain within your hub's configuration and is not shared publicly.

Our {term}`Cloud Engineering Team` will have access to all of the information that is inside a hub (which it requires in order to debug problems and and assist with upgrades), however we will not retain any of this data or move it *outside* of the hub, and will not retain it once the hub is shut down (except in order to transfer data to you at your request).


## Cryptocurrency mining

Cryptocurrency mining abuse occurs when users take advantage of cloud CPU in order to make money by mining cryptocurrency.
Expand All @@ -23,4 +32,4 @@ This tool monitors any process that runs on the 2i2c hubs, and automatically kil
## Usage monitoring

We deploy [Grafana Dashboards](https://grafana.com/grafana/dashboards/) along with a [Prometheus Server](https://prometheus.io/) to continuously monitor the usage across all of our hubs.
This provides visual dashboards that allow us to identify abnormal behavior on a hub (such as a single user using unusual amounts of RAM, using a lot of CPU, or making unusual networking requests).
This provides visual dashboards that allow us to identify abnormal behavior on a hub (such as a single user using unusual amounts of RAM, using a lot of CPU, or making unusual networking requests).
122 changes: 0 additions & 122 deletions about/overview.md

This file was deleted.

55 changes: 0 additions & 55 deletions about/roles.md

This file was deleted.

2 changes: 1 addition & 1 deletion about/2i2c.md → about/service/2i2c.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Our unique qualifications and services
# 2i2c's qualifications

```{epigraph}
2i2c is a mission-driven non-profit with expertise in cloud infrastructure, Jupyter, open science and scholarship, and open development practices.
Expand Down
65 changes: 65 additions & 0 deletions about/service/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
(about-the-project)=
# Overview of the service

This section describes a high-level overview of our {term}`Collaborative JupyterHub Service` and the major teams, processes, and expectations around this service for both 2i2c and the partner community we work with.
This page provides some high-level information to help you get started, and the sections below go into more detail on our service model and structure.

```{toctree}
:maxdepth: 1
team
shared-responsibility
2i2c
```

If you're interested in setting up a service for your community, click the button below to send us an email.

```{button-link} mailto:[email protected]
:color: primary
Send us an email.
```

## What is the hub service?

```{glossary}
Collaborative JupyterHub Service
An open, scalable, sustainable cloud service for interactive computing environments in research and education.
It follows a "DevOps as a Service" model where communities in research and education can pay for managed cloud infrastructure that runs on an entirely open source stack, and give you [the right to replicate your infrastructure](https://2i2c.org/right-to-replicate).
It is run by [2i2c](https://2i2c.org), a non-profit organization that develops and operates interactive computing infrastructure for research and education.
2i2c values transparency and community driven infrastructure.
The sections below describe the Managed JupyterHub Service, its strategy and goals, as well as information about its major features and pricing.
```

## Who is this service for?

2i2c's Collaborative JupyterHub Service is designed for communities in research and education who want the following things:

1. Access to the latest technology in Jupyter and interactive computing for collaborative and scalable data science running in the cloud.
2. To utilize open source, community-driven tools and standards.
3. To partner with a mission-aligned organization that transparently and collaboratively runs infrastructure as a team.
4. To use infrastructure that they could take control of themselves, and that gives the user the [Right to Replicate](overview/right-to-replicate).
5. To use infrastructure that is designed by and for individuals in research and education.
6. To support infrastructure from a non-profit organization that is committed to communities in research, education, and open source.

(overview/right-to-replicate)=
## Your Right to Replicate your infrastructure

A core principle of 2i2c is to build and manage technology that is controlled by the community that uses it.
One way in which we adhere to this principle is by respecting the [Community Right to Replicate](https://2i2c.org/right-to-replicate/). This states the following:

```{epigraph}
The Right to Replicate gives communities the right to replicate their infrastructure in its entirety elsewhere, with or without 2i2c.
```

We believe that following this principle will lead to a more equitable and more productive ecosystem for research and education in the cloud. It also helps avoid many of the potential downsides of relying on a cloud vendor for infrastructure. Read the [Right to Replicate](https://2i2c.org/right-to-replicate/) documentation for more information about what this means.

:::{seealso}
Check out [](../../admin/howto/replicate.md) for information about replicating a 2i2c JupyterHub.
:::

## Sustaining open source

Everything that 2i2c deploys is open source and community-driven projects.
We prioritize using multi-stakeholder projects that are well-supported by a diverse community of contributors.
The resources that we receive to run 2i2c JupyterHubs thus **also go towards making open-source improvements** in these communities so that others may benefit from them.
We see this as an opportunity to solve two problems with one stream of funding: support research and education, and [support open source communities](https://2i2c.org/about#values) in the Jupyter ecosystem and beyond.
Loading

0 comments on commit 95391ca

Please sign in to comment.