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
  • 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
• User policies
  • Code of Conduct
  • Acceptable Use Policy
  • Privacy Policy
• ☁️ Table of running hubs

Hub users

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

Hub users

• Getting Started
  • Access the hub
  • Start a new server
  • Environment and interface
  • Shutting down your server
• Data and Filesystem
  • Quick recommendations
  • References and attribution
• Software environment and resources
  • Choose an environment for your JupyterHub server
  • Build your own environment from the hub
  • Why environment choice is useful
• Share content and files
  • Community documentation with Jupyter Book
  • Share notebooks and content files
• Launch a dask-gateway cluster for scalable computing
  • What is Dask Gateway?
  • Usage
  • FAQs

Hub administrators

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.

Hub administrators

• 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
  • Allow users to build their own environment image
  • Accessing user interfaces
• User authentication and access
  • Authentication vs. Authorization
  • Debug user authentication issues
• User server management
  • Take control of a user’s server
  • Stop user servers after inactivity
  • Stop user servers after maximum age
  • Stop user kernels after inactivity
  • Disable hub access for all users
• Usage monitoring
  • Grafana dashboards
  • Programmatically accessing Prometheus data
  • Cost attribution
• Network Policy
• Secrets, passwords and access tokens
  • Access a secret locally in a .env file
• Outages
  • 1. Hub URL is unavailable
  • 2. Authorized users cannot login
  • 3. User servers not starting
  • 4. Home directory for a hub is full and users can not write files
  • 5. Reduced performance of the system
  • 6. Underlying Infrastructure outages
• The 2i2c status page
  • Subscribing

Community leaders

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

Community leaders

• Begin a new hub service
  • Confirm with a 2i2c team member
  • Identify a Community Representative
  • Hub Deployment
  • Get support
• Billing and cloud costs
  • Billing and cloud accounts
  • Estimate cloud costs
  • Budget Forecast Alerts
• Events and workshops
  • Notify the 2i2c team about the event
  • Infrastructure preparation for an event
  • Before the event
  • During the event
  • After the event
• Community strategy and organizing
  • Other experts in community organizing
  • Codes of Conduct
• Migrate off of a JupyterHub
  • Download your home directory
  • Replicate your own 2i2c JupyterHub

Reference material

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

Reference

• Terminology reference
• Contributing guide
  • Build the documentation locally
  • Pre-populate the FreshDesk Help widget
  • Review and merging guidelines