Service Guide

This is the community and user documentation for 2i2c’s Managed JupyterHub Service. It is divided into a number of roles and personas with relevant topics for each.

See also

Here are a few other locations with relevant information about 2i2c’s services.

• team-compass.2i2c.org/managed-hubs/index: Documentation about Service Team processes that are primarily relevant to 2i2c team members. We put this documentation here to prevent docs.2i2c.org from getting too cluttered.

• infrastructure.2i2c.org: Our Cloud Engineering Team and cloud infrastructure documentation.

This documentation is structured into sections that are meant for various roles and personas. We describe each below.

About the service

These sections describe the hub service at an organizational level. They are meant for individuals who wish to learn about the service for their own purposes or to advocate for its use to others.

About the service

• Usecases and prices
  • An overview of our infrastructure
  • Education use-cases
  • Research use-cases
• Our collaborative service model
  • Our shared responsibility model
  • Your Right to Replicate your infrastructure
  • Service Level Objectives
  • Cost model
  • Comparison to similar services

Use the hub

Covers end-user workflows that are common for cloud-native workflows with interactive computing.

Use the hub

• User policies
  • Code of Conduct
  • Acceptable Use Policy
  • Privacy Policy
• Data and Filesystem
  • Quick recommendations
  • References and attribution
• Starting and customizing the software environment of a user server
  • The Server Options
  • Specify your own image for the software environment

Administer the hub

Information for those with the hub administrator role on a JupyterHub. These cover many things that you can do to manage and configure your hub and its infrastructure.

Administer the hub

• Get support
  • Who can ask for support?
  • The support process
  • Send us encrypted content
• Configure the hub with the Configurator
  • Access the Configurator
  • Make and save changes
  • Available settings
• User environment and interface
  • Customize your user environment
  • Create multiple environments for users to select
  • The default user environment
  • Accessing user interfaces
• User authentication and access
  • Authentication vs. Authorization
  • Manage users from the administrator panel
  • Debug user authentication issues
• User server management
  • Take control of a user’s server
  • Stop user servers after inactivity
  • Stop user kernels after inactivity
  • Disable hub access for all users
• Network Policy

Community leadership

Covers topics relevant to those that are leading others in a community.

Community leadership

• Events and workshops
  • Notify the 2i2c team about the event
  • Infrastructure preparation for an event
  • Before the event
  • During the event
  • After the event
• Content creation and sharing
  • Distribute content with nbgitpuller
  • Serve static web content with your hub
  • Write public books that connect to a 2i2c JupyterHub
• Community strategy and organizing
  • Other experts in community organizing
  • Codes of Conduct

Community representatives

Documentation for those serving as Community Representatives. These tend to cover technical, administrative, invoicing, and collaborative processes for interacting with 2i2c’s team on behalf of your community.

Community representatives

• Begin a new hub service
  • Confirm with a 2i2c team member
  • Identify a Community Representative
  • Fill in the “New Hub” GitHub template
  • Get support
• Migrate off of a JupyterHub
  • Download your home directory
  • Replicate your own 2i2c JupyterHub
• Billing and cloud accounts
  • Provision a paid cloud provider account for 2i2c
• Estimate cloud costs
  • What components make up my cloud bill
  • User actions that impact cloud costs
  • Estimate my cloud costs
  • How we estimate cloud costs for communities

Reference material

Lists and programmatically-generated content to serve as a quick reference.

Reference

• Terminology reference